Balance

Use this endpoint to check the balance on a card, either a plastic card or a virtual card.

The API provides 2 different ways to request the balance:

1)      Balance without a PIN (via the ‘BalanceNoPin’ endpoint)

2)      Balance with a PIN (via the ‘Balance’ endpoint)

Balance without a PIN tends to be used where the cardholder is present, for example in store. In this case the Epos system should implement ‘BalanceNoPin’. Balance with a PIN tends to be used where the cardholder is not present, for example on the company website. In this case the webstore/website should implement ‘Balance’.

The (obvious) difference between the 2 endpoints is that the card’s PIN must be provided in the ‘Balance’ endpoint. If the PIN is not provided or is not the correct PIN for the card, the request will fail. 

More information including details of the request/response elements as well as examples are provided in the ‘API’ section of this site.