PIpismo
UPI

Get balance for account

Balance inquiry

post/v1/cards/balance

Request

  • Base URL
    https://sandbox.pismolabs.io/upi-gateway
  • URL
    https://sandbox.pismolabs.io/upi-gateway/v1/cards/balance
  • Auth
    HTTP bearer

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Authorization token. Tokens can expire quickly, which can result in a 401 Unauthorized message.

user-agentstring required

Client consuming API.

Request body

account_reference_numberstring required

Account reference number. Pismo creates this automatically when creating a card linked to RuPay on UPI.

This number combines 10 BIN digits and the credit account number. If BIN is 6 digits, the remaining 4 digits are set to zero (0). If BIN is 8 digits, then the remaining 2 digits are set to zero. This is a NPCI standard. For example, if the account reference number = 1234560000987654321, the first six digits are the BIN, appended with 4 zeros and then the credit account number (`987654321``).

You can call List cards to get a card's account reference number.

external_transaction_datetimestring required

Request datetime. ISO 8601 format.

external_transaction_idstring required

Request ID code

Example request

{
  "account_reference_number": "12345600000000001140340134",
  "external_transaction_datetime": "2020-09-15T19:39:54.013Z",
  "external_transaction_id": "MGS584A1244F6BC4D50A3FABE6D93DF913C"
}

Response

Response Body

account_reference_numberstring

Account reference number. Pismo creates this automatically when creating a card linked to RuPay on UPI.

This number combines 10 BIN digits and the credit account number. If BIN is 6 digits, the remaining 4 digits are set to zero (0). If BIN is 8 digits, then the remaining 2 digits are set to zero. This is a NPCI standard. For example, if the account reference number = 1234560000987654321, the first six digits are the BIN, appended with 4 zeros and then the credit account number (`987654321``).

You can call List cards to get a card's account reference number.

external_transaction_datetimestring

Request datetime. ISO 8601 format.

external_transaction_idstring

Request ID code

Example response

{
  "card": {
    "available_balance": 150000,
    "ledger_balance": 1000
  },
  "account_reference_number": "12345600000000001140340134",
  "external_transaction_datetime": "2020-09-15T19:39:54.013Z",
  "external_transaction_id": "MGS584A1244F6BC4D50A3FABE6D93DF913C"
}

Changes

No recorded changes to this operation across all 1 revision of this API.