{
"account_no": "00000001",
"account_name": "Default Account",
"currency": "USDT",
"status": "active",
"is_system_default": true,
"editable": false,
"available_amount": 10000,
"frozen_amount": 2000,
"total_amount": 12000,
"created": 1788998400,
"as_of": 1789084800
}{
"error": {
"code": "invalid_parameter",
"message": "Invalid account number format. Paths that do not match the gateway routing rules may return 404 directly."
},
"request_id": "example-request-id",
"timestamp": 1789084800
}{
"error": {
"code": "resource_not_found",
"message": "The account does not exist or belongs to another merchant. Paths not matched by the gateway may also return plain text Not Found."
},
"request_id": "example-request-id",
"timestamp": 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 a global account
Retrieve a single Balance Account and its balances by account number for the merchant associated with the current API Key. Returns 404 resource_not_found if the account does not exist or belongs to another merchant.
Account fields and as_of are at the top level of the response, without a global_account wrapper. The account number is an 8-digit string; preserve leading zeros.
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.
{
"account_no": "00000001",
"account_name": "Default Account",
"currency": "USDT",
"status": "active",
"is_system_default": true,
"editable": false,
"available_amount": 10000,
"frozen_amount": 2000,
"total_amount": 12000,
"created": 1788998400,
"as_of": 1789084800
}{
"error": {
"code": "invalid_parameter",
"message": "Invalid account number format. Paths that do not match the gateway routing rules may return 404 directly."
},
"request_id": "example-request-id",
"timestamp": 1789084800
}{
"error": {
"code": "resource_not_found",
"message": "The account does not exist or belongs to another merchant. Paths not matched by the gateway may also return plain text Not Found."
},
"request_id": "example-request-id",
"timestamp": 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.
Path Parameters
An 8-digit account number.
^[0-9]{8}$Response
Query successful.
Account number as an 8-digit string. Preserve leading zeros.
^[0-9]{8}$"00000001"
Account display name.
"Default Account"
Uppercase ledger currency or asset code, such as USD, USDT, or USDC.
"USDT"
Account availability status. Restricted accounts can still be queried; the relevant business endpoint determines whether fund operations are allowed.
active, restricted Whether this is a system default account.
Whether the merchant may edit the account display name. This endpoint does not support editing.
Available balance, expressed as an integer in the smallest unit of the ledger currency.
Frozen or reserved balance, expressed as an integer in the smallest unit of the ledger currency.
Total account balance. In the current version, this equals available_amount + frozen_amount.
Account creation time in Unix seconds.
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?