SchemaPaymentsCards

View EBT balance

Use this method to view the balance of an Electronic Benefit Transfer (EBT) card.

If the request is successful, our gateway returns the current balance of an EBT card.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
currencyenumRequired

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

cardobjectRequired
Object that contains information about the card.
operatorstringOptional>=0 characters<=50 characters
Operator who requested the balance inquiry.
customerobjectOptional
Object that contains the customer's contact details and address information.

Response

Successful request. Returns the current balance of the EBT card.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
cardobject
Object that contains the details of the payment card.
operatorstring or null>=0 characters<=50 characters
Operator who requested the balance inquiry.
responseCodeenum or null

Response from the processor.

  • A - The processor approved the transaction.
  • D - The processor declined the transaction.
  • E - The processor received the transaction but will process the transaction later.
  • P - The processor authorized a portion of the original amount of the transaction.
  • R - The issuer declined the transaction and indicated that the customer should contact their bank.
  • C - The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.
responseMessagestring or null>=1 character<=48 characters
Response description from the payment processor, for example, Refer to Card Issuer.

Errors