Balance
Query Account Balance
Retrieve the payment account balance for the merchant.
POST
Check account balance
Overview
This page documents thePOST /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 endpoint path is
/payment/open/institution/v1/balance. - For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Institution Notes
- The request must include the
X-GatePay-On-Behalf-Ofheader to identify the institutional sub-account whose balance is queried.
Headers
Merchant client ID
Example:
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
Signature
Example:
"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8"
Millisecond timestamp; the difference from server time must not exceed 30 seconds.
Example:
"1672905655498"
Nonce
Example:
"9578"
Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.
Body
application/json
List of currencies to query.
Example:

