Skip to main content
POST
Check account balance

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 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-MerchantId header to identify the institutional sub-account whose balance is queried.

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

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

Example:

"1672905655498"

X-GatePay-Nonce
string
required

Nonce

Example:

"9578"

X-GatePay-MerchantId
string
required

Institutional sub-account ID.

Example:

"2124538349"

Body

application/json

List of currencies to query.

Example:

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