Skip to main content
GET
/
payment
/
open
/
institution
/
v1
/
pay
/
balance
/
query
Check account balance
curl --request GET \
  --url https://openplatform.gateapi.io/payment/open/institution/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"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gate.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This page documents the POST /payment/open/institution/v1/balance endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

  • Authentication uses the standard GatePay signed headers.
  • This is the institution sub-account balance query API.
  • The request body is a JSON array of currencies to query, for example ["USDT", "BTC"].
  • The correct path is the legacy production path confirmed by backend, not /payment/open/institution/v1/pay/balance/query.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

​
Institution Notes

  • Institutional requests must include X-GatePay-On-Behalf-Of to specify the institutional sub-account to operate on.

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