Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

load_request

Parameters

NameTypeRequiredDefinition
pedvoid-x-

If not specified the PED object will be automatically populated

merchant_accountchar-white_check_mark-

 

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 .

 

terminal_id

char-x-

The terminal_id of the PED.

card_type 

char-x-The type of gift card.

load_type 

char-white_check_mark-

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. load_type can take the following values:

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.

referencechar-white_check_mark-

A reference for this request. Allows the merchant to identify the transaction.

card_numberString-x-

The gift card number.

Use of this parameter depends on selection of the Manual Keyed Entry option.
expiry_monthLong-x-

Month of expiration.

Use of this parameter depends on selection of the Manual Keyed Entry option.
expiry_yearLong-x-

Year of expiration.

Use of this parameter depends on selection of the Manual Keyed Entry option.
card_maskchar-x-

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_minint-x-

Minimum number of characters in the card mask.

Use of this parameter depends on selection of the Manual Keyed Entry option.
card_mask_maxint-x-

Maximum number of characters in the card mask.

Use of this parameter depends on selection of the Manual Keyed Entry option.
amount_currencychar-white_check_mark-

The currency of the balance. 

amount_valuelong-white_check_mark-

The value of the balance.

tender_options_obj

ttender_options_struct-x-

An enum of type TENDER_OPTIONS. For a list of tender options, see Tender Options.

additional_data_obj

additional_data_struct-x-

Register additional data with the transaction if necessary. 

number_of_additional_data_entries: defines the number of entries in the additional_data array.