Search

Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

balance_inquiry_request

Name Type Required Definition
ped void -x-

if not specified the PED object will be automatically populated

merchant_account

char -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. 

reference char -white_check_mark-

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

card_number char -x-

The gift card number.

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

Month of expiration.

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

Year of expiration.

Use of this parameter depends on selection of the Manual Keyed Entry option.
card_mask String -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_min String -x-

Minimum number of characters in the card mask.

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

Maximum number of characters in the card mask.

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

 

Tender options define the behavior of the PED.

An object that can have the following values:

  1. ReceiptHandler
  2. GetAdditionalData
  3. Recurring
  4. OneClick
  5. BypassPin
  6. AskGratuity
  7. NoProcess
  8. KeyedEntry
  9. DontPrintReceipt
  10. Error
  11. ForcedOnline
  12. ForcedDecline
  13. EnableMagstripeFallback
  14. NoCTLS
  15. AllowPartialAuthorisation

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