Skip to main content
GET
/
v1
/
pay
/
balance
/
query
Check merchant payment account balance
curl --request GET \
  --url https://openplatform.gateapi.io/v1/pay/balance/query \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "balance_list": [
      {
        "currency": "DOGE",
        "available": "1843.32095"
      },
      {
        "currency": "FORG",
        "available": "3.02"
      }
    ]
  }
}

Headers

X-GatePay-Certificate-ClientId
string
required

Merchant client ID

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature
string
required

Signature

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8"

X-GatePay-Timestamp
string
required

Timestamp (milliseconds)

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Nonce

Example:

"9578"

Response

200 - application/json

Success

status
enum<string>

SUCCESS or FAIL

Available options:
SUCCESS,
FAIL
code
string

Error code

errorMessage
string

Error message

data
object