The special_tender_request
contains the following data elements:
Field | Type | Required | Description |
---|---|---|---|
ped |
void | ![]() |
if not specified the PED object will be automatically populated. |
merchant_account |
char | ![]() |
The merchant account processing this transaction. Transactions can be performed with any of the merchant accounts that were returned when registering the POS. |
transaction_type |
ADYTransactionType |
![]() |
Type of gift card transaction (Redeem, which uses a card balance to pay for an item, Load, which loads a balance to a card, and Balance Inquiry which returns the current balance of the card).
|
reference |
char | ![]() |
A merchant-supplied reference for the transaction. |
terminal_id |
char | ![]() |
The |
amount_currency |
char | ![]() |
Currency of the transaction (ISO 4217). |
amount_value |
long | ![]() |
Amount of the transaction in minor currency units. |
payment_method_type |
char | ![]() |
Payment method used for the transaction, such as a gift card, Alipay etc. For Gift Cards:
For Alipay and WeChat Pay:
|
|
void | ![]() |
Special options are dictionary key value pairs. This information is passed directly to the PED, which interprets it. Activate, load, or refund a balance to a card by creating a special tender and passing the following values as the
The activate and load values can be piped to chain the tasks by passing "activate|load".
Perform a cash back or deactivate a card by creating a special tender and passing a
The cashback and deactivate values can be piped to chain the tasks by passing "cashback|deactivate".
|
handle_receipt |
boolean | ![]() |
Specifies that the POS handles and prints receipts. If omitted, it is required that the PED prints the receipt. If there is no printer unit, the transaction will fail. |
|
additional_data_struct |
![]() |
Contains key/value pairs that can be used by the merchant to return specific additional data, in particular in the final transaction result. |