Prepaid Card Balance

You can monitor a prepaid card balance by using the card balance API. There are two use cases of the prepaid card balance API:

• confirming sufficient balance for prepaid cards before the transaction occurs on the card,
• and getting a card balance.

Confirming Sufficient Balance For Prepaid Cards

This API lets you confirm if a prepaid card has sufficient Balance for the transaction it wants to take. It returns a 'YES' if the prepaid card balance is greater than or equal to the transaction amount passed in the request, or returns a 'NO' otherwise.

POST /card-management/api/v1/card/prepaid/confirm_balance

These are the parameters of the request:

Body Parameters

This is what a typical request would look like:

{
  "pan": "5060990000000151002",
  "transactionAmount": 25000
}

Response Message  field description

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "5a5d0875a56645498f29643ac2d53e06",
  "isSufficient": "YES"
}

 {
  "code": "10404",
  "description": "Card not found",
  "correlationId": "2aa197eda43540a4ad85b8d0bf570871"
}

Get Account Balance For Prepaid Card Accounts

This API handles requests to get Card Balance for Prepaid Cards. This endpoint is protected and only accessible to clients with the authority to view balance.

/card-management/api/v1/card/debit/balance

These are the parameters of the request:

Body Parameters

This is what a typical request would look like:

{
  "pan": "5060990000000151002"
}

Response Message  field description

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "aae8ac58e55a4baa80cb58ee2b12d024",
  "ledgerBalance": 0,
  "availableBalance": 0,
  "goodsLimit": 1000000000,
  "goodsNrTransLimit": 1000000,
  "cashLimit": 1000000000,
  "cashNrTransLimit": 1000000,
  "paymentLimit": 1000000000,
  "paymentNrTransLimit": 1000000,
  "cardNotPresentLimit": 1000000000,
  "depositCreditLimit": 1000000000
}

{
  "code": "403",
  "description": "Access Denied"
}