search

Get Crypto Assets Balance

This API allows you to retrieve the balances of cryptocurrency assets in a user's account.

hashtag
Endpoint Information

  • Request Header: X-BH-TOKEN: ******

  • Request Method: GET

  • Request Path: /v2/assets/account/assets

  • Authorization Required: Yes

hashtag
Query Parameters

  • merchantId: (int) The ID of the merchant. If 0, the API will return the aggregated balances across all merchants linked to this user.

hashtag
Response Structure

The response will include the following fields:

{
  "code": 200,                      // (number: response code)
  "msg": "SUCCESS",                 // (string: message)
  "data": {                         // (object: account asset details)
    "canDeposit": false,            // (boolean: whether the account can deposit)
    "balances": [                   // (array: list of asset balances)
      {
        "asset": "",                // (string: name of the asset)
        "assetId": "",              // (string: ID of the asset)
        "assetName": "",            // (string: display name of the asset)
        "total": "",                // (string: total amount of the asset)
        "free": "",                 // (string: free amount of the asset)
        "locked": ""                // (string: locked amount of the asset)
      }
    ]
  }
}

hashtag
Example Response (Specific Merchant)

Request:

Response:

hashtag
Example Response (Aggregated Across All Merchants)

Request:

Response:

hashtag
Notes

canDeposit field: Indicates whether the account supports deposits at this time.

merchantId=0 special case: When merchantId is 0, the API aggregates balances across all merchants bound to the same account and returns the combined amounts for each asset.

PreviousRetrieve Funding RecordsNextGet Crypto Deposit Address

Last updated