Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Get Balance

This API lets the platform fetch the current balance of a virtual account.

get/v3/banking/balance

Query parameters

consumer_urnstring

A unique identifier assigned to client's by Decentro during On boarding.

account_numberstring required

The virtual account number for which the balance needs to be fetched.

custom_va_numberstring

The suffix part of the VA that uniquely identifies each VA. It can be from 6 -10 digit. Eg: va_suffix will be 000001 for virtual account number 46525000001

customer_va_identifierstring

Unique customer identifier that is mapped against the virtual account.

fetch_child_balanceboolean

Pass this flag as true/false depending on whether you want to fetch the balance of a child consumer.

provider_codestring

Provider code of the bank with which account is created. For example, provider_code: YESB

fetch_compliance_balancestring

Pass the flag as true/false depending on whether you want to fetch the compliance balance of the consumer

Headers

client_idstring required

Decentro assigned client_id during onboarding.

client_secretstring required

Decentro assigned client_secret during onboarding.

Request body

{"stackTrail":"paths:/v3/banking/balance:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

OR
OR
OR

Example response

{
  "decentro_txn_id": "A49B664CC3F44CB2A1A0A6FC513BFAC1",
  "api_status": "SUCCESS",
  "message": "Successfully fetched the balance.",
  "data": {
    "account_balance": {
      "account_number": "4625250067981922",
      "account_type": "VIRTUAL"
    }
  }
}