Parameters
Name | Type | Required | Definition |
---|---|---|---|
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. Use a merchant account that you provided during app registration . |
|
char | ![]() |
The
terminal_id
of the PED.
|
|
char | ![]() |
The type of gift card. |
|
char | ![]() |
Gift Card Providers allow for many types of loads to cards. For example, merchandising return loads are used to credit returns to a card. Pass the default value: load. For Givex cards pass either load for balance load, or merchandise_return for refunds. activate - Activates a gift card. load - Loads a balance to a gift card. merchandise_return - Load a refund balance back on to a gift card. This uses the same functionally as a load but is separated for accounting purposes. |
reference |
char | ![]() |
A reference for this request. Allows the merchant to identify the transaction. |
card_number |
String | ![]() |
|
expiry_month |
Long | ![]() |
|
expiry_year |
Long | ![]() |
|
card_mask |
char | ![]() |
A mask to validate the correct number of digits to enter.
Use of this parameter depends on selection of the Manual Keyed Entry option.
|
card_mask_min |
int | ![]() |
Minimum number of characters in the card mask.
Use of this parameter depends on selection of the Manual Keyed Entry option.
|
card_mask_max |
int | ![]() |
Maximum number of characters in the card mask.
Use of this parameter depends on selection of the Manual Keyed Entry option.
|
amount_currency |
char | ![]() |
The currency of the balance. |
amount_value |
long | ![]() |
The value of the balance. |
|
tender_options_struct | ![]() |
|
|
additional_data_struct | ![]() |
Register additional data with the transaction if necessary. number_of_additional_data_entries: defines the number of entries in the |