Skip to main content
The Get Card Balance endpoint returns the current stock level for a specific card denomination. You should call this endpoint immediately before submitting a card order to confirm that sufficient units are available. Stock levels can change between your initial call to Get Card Details and the moment you attempt to fulfil an order, so treating balance as a live value is important for a smooth checkout experience.

Endpoint

Request Headers

Request Body

integer
required
The unique identifier of the card denomination whose balance you want to check. Obtain this value from the card_id field in the Get Card Details response.

Example Request

Request

Response

Response Fields

boolean
Indicates whether the request succeeded. Returns true on success.
string
A status code for the response. "11111" indicates success.
array
An array containing the balance object for the requested card denomination.

Example Response

Response
Always check the balance before initiating a card purchase request. If you request more cards than are currently in stock, the API returns error code 10006 (Insufficient Balance) and your order will not be processed. A real-time balance check immediately before ordering helps you prevent this error and display accurate availability to your customers.
If balance returns 0, consider marking the denomination as temporarily out of stock in your UI and polling this endpoint periodically to detect when inventory is replenished.