balance_inquiry_request

Name Type Required Definition
ped void (error)

if not specified the PED object will be automatically populated

merchant_account

char (tick)

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 (error)

The  terminal_id  of the PED.

card_type 

char (error)

The type of gift card. 

reference char (tick)

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

card_number char (error)

The gift card number.

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

expiry_month int (error)

Month of expiration.

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

expiry_year int (error)

Year of expiration.

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

card_mask String (error)

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 (error)

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 (error)

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 (error)

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.