Debit Card Balance

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

confirming sufficient balance for Debit Cards before the transaction occurs on the card,
and getting a card balance.

Confirming Sufficient Balance For Debit Cards

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

/card-management/api/v1/card/debit/confirm_balance

These are the parameters of the request:

Body Parameters

Field #	Field name	Data type	Max length	Required	Description
1	issuerNr	int	3	true	Issuer Number
2	accountId	string	10 to 28	true	Account ID or Number
3	accountType	string	2 to 2	true	Account Type
4	transactionAmount	number		true	Transaction Amount to compare card balance against.

This is what a typical request would look like:

{
  "issuerNr": 2,
  "accountId": "0123456789",
  "accountType": "20",
  "transactionAmount": 100
}

Response Message field description

Field #	Field name	Description
1	code	Internal Response Code
2	description	Successful or Error Message
3	correlationId	Request identifier
4	errors	Errors array if any errors exists.
5	isSufficient	Returns 'YES' if balance is Sufficient else returns 'NO'

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

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


  "code": "10500",
  "description": "Error Processing Request",
  "correlationId": "2aa197eda43540a4ad85b8d0bf570871"
}

Get Account Balance For Debit Card Accounts

This API handles requests to get Account Balance for Debit 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

Field #	Field name	Data type	Max length	Required	Description
1	issuerNr	int	3	true	Issuer Number
2	accountId	string	10 to 28	true	Account ID or Number
3	accountType	string	2 to 2	true	Account Type

This is what a typical request would look like:

{
  "issuerNr": 2,
  "accountId": "0123456789",
  "accountType": "20"
}

Response Message field description

Field #	Field name	Description
1	code	Internal Response Code
2	description	Successful or Error Message
3	correlationId	Request identifier
4	errors	Errors array if any errors exist.

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

{
  "code": "00",
  "description": "Successful",
  "correlationId": "3f7debdd5b7c4107959c216fa228281e",
  "ledgerBalance": 0,
  "availableBalance": 0
}

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