Skip to main content
GET
/
payment
/
open
/
institution
/
v1
/
pay
/
balance
Query Available Currency Balance
curl --request GET \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/balance \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "ADA": "313.99963295",
    "ALGO": "0",
    "APT": "0",
    "ARB": "0",
    "ATOM": "0",
    "AVAX": "0",
    "BCH": "0"
  }
}

​
Overview

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

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID

Example:

"mZ96D37oKk-HrWJc"

​
X-GatePay-Signature
string
required

Signature

Example:

"b8c4705ff4c1357f2a27925dd180c1e1f4a244148f312a2dee5afbcc6f4b150e9ffceee455c5a298f895d43a64ee829eebdfd262539d45c41f7aee4336fd8c8c"

​
X-GatePay-Timestamp
string
required

Timestamp (milliseconds)

Example:

"1738934053475"

​
X-GatePay-Nonce
string
required

Nonce

Example:

"5417061546"

​
X-GatePay-On-Behalf-Of
string
required

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.

Response

200 - application/json

Query successful

​
status
string

Response status

Example:

"SUCCESS"

​
code
string

Response code

Example:

"000000"

​
errorMessage
string

Error message

Example:

""

​
data
object

Currency balance key-value pairs, key is the currency name, value is the balance string

Example:
{
  "ADA": "313.99963295",
  "ALGO": "0",
  "APT": "0",
  "USDT": "1000.50"
}