{
"balances": [
{
"currency": "USDT",
"amount": 2500
},
{
"currency": "USDC",
"amount": -100
}
],
"as_of": 1789084800
}{
"error": {
"code": "internal_error",
"message": "Internal server error."
},
"request_id": "example-request-id",
"timestamp": 1789084800
}{
"error": {
"code": "service_unavailable",
"message": "The balance query service is temporarily unavailable. Retry later with a new timestamp, nonce, and signature."
},
"request_id": "example-request-id",
"timestamp": 1789084800
}Retrieve pending settlement balances
Query pending settlement book balances aggregated by currency for the merchant associated with the current API Key. No merchant_id is required; the response contains only balances and as_of, without merchant_id.
The currency amount field is amount. This is an independent merchant-level aggregate, unrelated to account_no; do not add it to each account’s total_amount. The current version aggregates the total balances of internal pending settlement accounts, including frozen amounts. It must not be interpreted as an available pending settlement amount after deducting frozen or reserved funds.
Authentication follows the common authentication specification. Do not pass merchant_id or X-Merchant-Id; the server only queries data for the merchant associated with the current API Key. No request body is required. Amount examples are fictional and use the smallest ledger unit.
{
"balances": [
{
"currency": "USDT",
"amount": 2500
},
{
"currency": "USDC",
"amount": -100
}
],
"as_of": 1789084800
}{
"error": {
"code": "internal_error",
"message": "Internal server error."
},
"request_id": "example-request-id",
"timestamp": 1789084800
}{
"error": {
"code": "service_unavailable",
"message": "The balance query service is temporarily unavailable. Retry later with a new timestamp, nonce, and signature."
},
"request_id": "example-request-id",
"timestamp": 1789084800
}Authorizations
Bearer API Key, for example Bearer sk_live_xxx.
Unix timestamp in seconds. Must be within 5 minutes of the server time.
Random string for replay protection, 16–64 characters.
HMAC-SHA256 signature computed using the merchant API Secret, encoded as lowercase hex.
Headers
Unix timestamp in seconds. Must be within 5 minutes of the server time.
Random string for replay protection, 16–64 characters. A new UUID is recommended for each request.
16 - 64Compute HMAC-SHA256 over {timestamp}.{nonce}.{requestBody} using the merchant API Secret and encode the result as lowercase hex. For GET requests, requestBody is an empty string.
Response
Query successful.
Pending settlement balances aggregated by currency. Currencies with a zero total are omitted. Returns an empty array if there are no records.
Show child attributes
Show child attributes
Database observation time for this query, in Unix seconds. This is not a data version and does not guarantee that multiple requests share the same snapshot.
Was this page helpful?