Balance Inquiry

Request URL

https://{{gateway_domain}}/pg/v2/balance/query

Request Parameters

HTTP Method

POST

HTTP Header

Field	Data Type	Length Limit	Required	Description
Content-Type	String	N/A	YES	This field value only supports application/json.
Accept	String	N/A	YES	This field value only supports application/json.
Authorization	String		YES	Authorization: {type} {credentials}, refer to the Signature specifications section for details.

HTTP Body

Field	Data Type	Length Limit	Required	Description
currencies	String[]	50	YES	Merchant account balance currency

Response Data

HTTP Header

Field	Data Type	Required	Description
Content-Type	String	YES	Only application/json is supported.
Authorization	String	YES	Authorization: {type} {credentials}, refer to the Signature specifications section for details.

HTTP Body

Field	Data Type	Required	Description
code	String	YES	Refer to the Response Meter Table
errorMessage	String	NO	error message
data	JSON Object	NO

• Description of the data Field

Field	Data Type	Required	Description
balanceList	JSON Array	YES	A list of merchant balance accounts

• Description of the balanceList Field

Field	Data Type	Required	Description
currency	String	YES	The currency of the account
availableAmount	String	YES	The available balance of the account
frozenAmount	String	YES	The frozen amount of the account

Examples

Request

curl https://{{gateway_domain}}/pg/v2/balance/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "currencies": ["INR"]
}'

Response

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
        "balanceList": [
            {
                "currency": "INR",
                "availableAmount": "0.00",
                "frozenAmount": "0.00"
            }
        ]
    }
}