Secuconnect\Client\LoyaltyMerchantcardsApi

All URIs are relative to https://connect-testing.secupay-ag.de/api/v2

Method HTTP request Description
addMerchantCard POST /Loyalty/MerchantCards POST Loyalty/MerchantCards
checkCsc POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/checkCsc POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/checkCsc
checkPassCode POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/checkPasscode POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/checkPasscode
createMerchantcards POST /Loyalty/MerchantCards/{generalMerchantId}/createMerchantcards/{loyaltyCardgroupId} POST Loyalty/MerchantCards/{generalMerchantId}/createMerchantcards/{loyaltyCardgroupId}
executeTransaction POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/transaction POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/transaction
getAll GET /Loyalty/MerchantCards GET Loyalty/MerchantCards
getLock GET /Loyalty/MerchantCards/{loyaltyMerchantCardId}/lock GET Loyalty/MerchantCards/{loyaltyMerchantCardId}/lock
getOne GET /Loyalty/MerchantCards/{loyaltyMerchantCardId} GET Loyalty/MerchantCards/{loyaltyMerchantCardId}
getRawMerchantCardId GET /Loyalty/MerchantCards/{generalMerchantId}/merchantcard/{loyaltyCardId} GET Loyalty/MerchantCards/{generalMerchantId}/merchantcard/{loyaltyCardId}
getVirtualTerminalData GET /Loyalty/MerchantCards/{loyaltyMerchantCardId}/virtualTerminalData/{loyaltyMerchantId} GET Loyalty/MerchantCards/{loyaltyMerchantCardId}/virtualTerminalData/{loyaltyMerchantId}
lock POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/lock POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/lock
newPassCode POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/newPasscode POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/newPasscode
registerCustomer POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/registerCustomer POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/registerCustomer
removeMerchantCard DELETE /Loyalty/MerchantCards/{loyaltyMerchantCardId} DELETE Loyalty/MerchantCards/{loyaltyMerchantCardId}
resetPassCode POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/resetPasscode POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/resetPasscode
setCustomer POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/setCustomer/{loyaltyCustomerId} POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/setCustomer/{loyaltyCustomerId}
unlock POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/unlock POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/unlock
updateCardGroupOfMerchantCard PUT /Loyalty/MerchantCards/{loyaltyMerchantCardId}/cardgroup/{loyaltyCardGroupId} PUT Loyalty/MerchantCards/{loyaltyMerchantCardId}/cardgroup/{loyaltyCardGroupId}
updateMerchantCard PUT /Loyalty/MerchantCards/{loyaltyMerchantCardId} PUT Loyalty/MerchantCards/{loyaltyMerchantCardId}
validateMerchantCard POST /Loyalty/MerchantCards/{loyaltyMerchantCardId}/validateMerchantcard POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/validateMerchantcard

addMerchantCard

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel addMerchantCard($body)

POST Loyalty/MerchantCards

Add new loyalty merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTO(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTO | Loyalty merchant card properties

try {
    $result = $api_instance->addMerchantCard($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->addMerchantCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTO Loyalty merchant card properties

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkCsc

object checkCsc($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/checkCsc

Check CSC

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCsc(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCsc | Information about card

try {
    $result = $api_instance->checkCsc($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->checkCsc: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCsc Information about card

Return type

object

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkPassCode

object checkPassCode($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/checkPasscode

Function to check the Passcode card with cardnumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCheckPasscode(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCheckPasscode | Information about card

try {
    $result = $api_instance->checkPassCode($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->checkPassCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCheckPasscode Information about card

Return type

object

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createMerchantcards

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel[] createMerchantcards($general_merchant_id, $loyalty_cardgroup_id, $body)

POST Loyalty/MerchantCards/{generalMerchantId}/createMerchantcards/{loyaltyCardgroupId}

Function to create multiple merchantcards for given merchant with given cardgroup

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$general_merchant_id = "general_merchant_id_example"; // string | General merchant id
$loyalty_cardgroup_id = "loyalty_cardgroup_id_example"; // string | Loyalty card group id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCardsAmount(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCardsAmount | Cards amount

try {
    $result = $api_instance->createMerchantcards($general_merchant_id, $loyalty_cardgroup_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->createMerchantcards: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
general_merchant_id string General merchant id
loyalty_cardgroup_id string Loyalty card group id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOCardsAmount Cards amount

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel[]

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

executeTransaction

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductWithReceiptModel executeTransaction($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/transaction

Execute transaction from SDK

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOTransaction(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOTransaction | Transaction properties

try {
    $result = $api_instance->executeTransaction($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->executeTransaction: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOTransaction Transaction properties

Return type

LoyaltyMerchantcardsProductWithReceiptModel

Properties

Name Type Description Notes
object string Object of loyalty merchant card [optional]
id string Id of loyalty merchant card [optional]
card \Secuconnect\Client\Model\LoyaltyCardsProductModel Id of loyalty store group [optional]
merchant \Secuconnect\Client\Model\ProductInstanceUID Current merchant id [optional]
created_for_merchant \Secuconnect\Client\Model\ProductInstanceUID Merchant id, that loyalty merchant card object was created for [optional]
created_for_store \Secuconnect\Client\Model\ProductInstanceUID Store id, that loyalty merchant card object was created for [optional]
customer \Secuconnect\Client\Model\LoyaltyCustomersProductModel Loyalty merchant card customer [optional]
cardgroup \Secuconnect\Client\Model\LoyaltyCardgroupsProductModel Loyalty merchant card card group [optional]
payment_container \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOPaymentContainer Loyalty merchant card payment container [optional]
balance int Loyalty merchant card balance [optional]
points int Loyalty merchant card points [optional]
bonus_balance int Loyalty merchant card bonus balance [optional]
cash_balance int Loyalty merchant card cash balance [optional]
stock_status string Loyalty merchant card stock status [optional]
lock_status string Loyalty merchant card lock status [optional]
last_usage \DateTime Loyalty merchant card last usage [optional]
last_charge \DateTime Loyalty merchant card last charge [optional]
is_base_card bool Information whether loyalty merchant card is base card [optional]
passcode int Loyalty merchant card passcode [optional]
receipt_header \Secuconnect\Client\Model\ReceiptType[] Receipt header [optional]
receipt \Secuconnect\Client\Model\ReceiptTypeValue[] Receipt [optional]

[Back to Model list] [Back to API list] [Back to README]

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAll

\Secuconnect\Client\Model\LoyaltyMerchantcardsList getAll($count, $offset, $fields, $q, $sort)

GET Loyalty/MerchantCards

Get a list of loyalty merchant cards

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$count = 56; // int | The number of items to return.
$offset = 56; // int | The position within the whole result set to start returning items (First element is at 0).
$fields = "fields_example"; // string | List of fields to include in the result. Nested properties can be accessed with this notation: prop1.prop2  Example: prop3,prop1.prop2
$q = "q_example"; // string | A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form property:condition.  *                  A condition may contain:  *                      - wildcard \"*\" for any number of characters  *                      - wildcard \"?\" for one character  *                      - ranges in the form [value TO value]  *  *                  Single expressions may combined by 'AND', 'OR', 'NOT' operators and parenthesis '(', ')' for grouping.  *                  Property names can be nested like \"prop1.prop2\".  *                  Example: (NOT customer.name:meier*) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60])  *
$sort = "sort_example"; // string | String with comma separated pairs of field:order (e.g. contact.surname:asc,contact.comapnyname:desc). Result set will be sorted by included fields, in ascending 'asc', or descending 'dsc' order.

try {
    $result = $api_instance->getAll($count, $offset, $fields, $q, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->getAll: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
count int The number of items to return. [optional]
offset int The position within the whole result set to start returning items (First element is at 0). [optional]
fields string List of fields to include in the result. Nested properties can be accessed with this notation: prop1.prop2 Example: prop3,prop1.prop2 [optional]
q string A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form property:condition. A condition may contain: - wildcard \"\" for any number of characters - wildcard \"?\" for one character - ranges in the form [value TO value] Single expressions may combined by 'AND', 'OR', 'NOT' operators and parenthesis '(', ')' for grouping. Property names can be nested like \"prop1.prop2\". Example: (NOT customer.name:meier) AND (customer.age:[30 TO 40] OR customer.age:[50 TO 60]) * [optional]
sort string String with comma separated pairs of field:order (e.g. contact.surname:asc,contact.comapnyname:desc). Result set will be sorted by included fields, in ascending 'asc', or descending 'dsc' order. [optional]

Return type

LoyaltyMerchantcardsList

Properties

Name Type Description Notes
count int Number of existing loyalty merchant cards [optional]
data \Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel[] GET Loyalty/MerchantCards [optional]

[Back to Model list] [Back to API list] [Back to README]

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLock

\Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock getLock($loyalty_merchant_card_id)

GET Loyalty/MerchantCards/{loyaltyMerchantCardId}/lock

Get loyalty merchant card lock information for a specific id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id

try {
    $result = $api_instance->getLock($loyalty_merchant_card_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->getLock: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getOne

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel getOne($loyalty_merchant_card_id)

GET Loyalty/MerchantCards/{loyaltyMerchantCardId}

Get loyalty merchant card for a specific id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Search one by provided id

try {
    $result = $api_instance->getOne($loyalty_merchant_card_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->getOne: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Search one by provided id

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRawMerchantCardId

object getRawMerchantCardId($general_merchant_id, $loyalty_card_id)

GET Loyalty/MerchantCards/{generalMerchantId}/merchantcard/{loyaltyCardId}

Get raw merchant card id for merchant id and card id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$general_merchant_id = "general_merchant_id_example"; // string | Merchant id
$loyalty_card_id = "loyalty_card_id_example"; // string | Card id

try {
    $result = $api_instance->getRawMerchantCardId($general_merchant_id, $loyalty_card_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->getRawMerchantCardId: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
general_merchant_id string Merchant id
loyalty_card_id string Card id

Return type

object

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVirtualTerminalData

\Secuconnect\Client\Model\VirtualTerminalData getVirtualTerminalData($loyalty_merchant_card_id, $loyalty_merchant_id)

GET Loyalty/MerchantCards/{loyaltyMerchantCardId}/virtualTerminalData/{loyaltyMerchantId}

Get virtual terminal data for merchant

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Merchant card id
$loyalty_merchant_id = "loyalty_merchant_id_example"; // string | Merchant id

try {
    $result = $api_instance->getVirtualTerminalData($loyalty_merchant_card_id, $loyalty_merchant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->getVirtualTerminalData: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Merchant card id
loyalty_merchant_id string Merchant id

Return type

\Secuconnect\Client\Model\VirtualTerminalData

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

lock

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel lock($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/lock

Lock merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock | Information about lock

try {
    $result = $api_instance->lock($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->lock: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock Information about lock

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

newPassCode

object newPassCode($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/newPasscode

Function to save new given passcode for given merchantcard identified by cardnumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTONewPasscode(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTONewPasscode | Information about card

try {
    $result = $api_instance->newPassCode($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->newPassCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTONewPasscode Information about card

Return type

object

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

registerCustomer

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel registerCustomer($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/registerCustomer

Register new customer for a card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyCustomersDTO(); // \Secuconnect\Client\Model\LoyaltyCustomersDTO | Loyalty customer properties

try {
    $result = $api_instance->registerCustomer($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->registerCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyCustomersDTO Loyalty customer properties

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeMerchantCard

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel removeMerchantCard($loyalty_merchant_card_id)

DELETE Loyalty/MerchantCards/{loyaltyMerchantCardId}

Delete loyalty merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id

try {
    $result = $api_instance->removeMerchantCard($loyalty_merchant_card_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->removeMerchantCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetPassCode

object resetPassCode($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/resetPasscode

Function to reset a passcode for given merchantcard

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOResetPasscode(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOResetPasscode | Information about card

try {
    $result = $api_instance->resetPassCode($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->resetPassCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOResetPasscode Information about card

Return type

object

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setCustomer

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel setCustomer($loyalty_merchant_card_id, $loyalty_customer_id)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/setCustomer/{loyaltyCustomerId}

Set loyalty customer for a loyalty merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$loyalty_customer_id = "loyalty_customer_id_example"; // string | Loyalty customer id

try {
    $result = $api_instance->setCustomer($loyalty_merchant_card_id, $loyalty_customer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->setCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
loyalty_customer_id string Loyalty customer id

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unlock

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel unlock($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/unlock

Unlock merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock | Information about unlock

try {
    $result = $api_instance->unlock($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->unlock: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOLock Information about unlock

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateCardGroupOfMerchantCard

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel updateCardGroupOfMerchantCard($loyalty_merchant_card_id, $loyalty_card_group_id)

PUT Loyalty/MerchantCards/{loyaltyMerchantCardId}/cardgroup/{loyaltyCardGroupId}

Update loyalty card group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$loyalty_card_group_id = "loyalty_card_group_id_example"; // string | Loyalty card group id

try {
    $result = $api_instance->updateCardGroupOfMerchantCard($loyalty_merchant_card_id, $loyalty_card_group_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->updateCardGroupOfMerchantCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
loyalty_card_group_id string Loyalty card group id

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateMerchantCard

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel updateMerchantCard($loyalty_merchant_card_id, $body)

PUT Loyalty/MerchantCards/{loyaltyMerchantCardId}

Update loyalty merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTO(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTO | Loyalty merchant card properties

try {
    $result = $api_instance->updateMerchantCard($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->updateMerchantCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTO Loyalty merchant card properties

Return type

\Secuconnect\Client\Model\LoyaltyMerchantcardsProductModel

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validateMerchantCard

\Secuconnect\Client\Model\LoyaltyMerchantcardsValidateMerchantCard validateMerchantCard($loyalty_merchant_card_id, $body)

POST Loyalty/MerchantCards/{loyaltyMerchantCardId}/validateMerchantcard

Function to check the merchant card

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth_token
Secuconnect\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Secuconnect\Client\Api\LoyaltyMerchantcardsApi();
$loyalty_merchant_card_id = "loyalty_merchant_card_id_example"; // string | Loyalty merchant card id
$body = new \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOValidateMerchantCard(); // \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOValidateMerchantCard | Information about card

try {
    $result = $api_instance->validateMerchantCard($loyalty_merchant_card_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyMerchantcardsApi->validateMerchantCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
loyalty_merchant_card_id string Loyalty merchant card id
body \Secuconnect\Client\Model\LoyaltyMerchantcardsDTOValidateMerchantCard Information about card

Return type

LoyaltyMerchantcardsValidateMerchantCard

Properties

Name Type Description Notes
is_valid bool Result has true or false value [optional]
has_passcode bool Result has true or false value [optional]
is_locked bool Result has true or false value [optional]

[Back to Model list] [Back to API list] [Back to README]

Authorization

oauth_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]