Skip to content

Get Account Balance

Retrieve all currencies of account balance

GEThttps://connect.cabital.com/api/v1/accounts/{account_id}/balances

User Account Status

  • Linked
  • KYC Pass

Request Path Parameters

Parameter Required Description
account_id Yes Customer account ID provided by Cabital.

Response Parameters

Parameter Type Description
code string Currency code
balances string Balance amount
includes array The currencies included under this currency code

Example

Request Data

curl "/api/v1/accounts/da781348-1474-4f5f-baf5-676825522835/balances"

Response Data

{
    "balances": [
        {
            "code": "EUR",
            "balances": "100.00"
        },
        {
            "code": "USDT",
            "balances": "200.172986"
        },
        {
            "code": "USDs",
            "balances": "500.935246",
            "includes": [
                "USD",
                "USDC"
            ]
        },
        {...}
    ]
}

Currency code

USD stablecoin (USDs) includes various USD stablecoin such as USD, USDC, and so on. We use USDs to represent customer's balance in the query or on Cabital Widget. However, if you try to use transaction API such as convert or transfer, please use the general currency code, e.g. USD or USDC.

Retrieve single currency of account balance

GEThttps://connect.cabital.com/api/v1/accounts/{account_id}/balances/{symbol}

User Account Status

  • Linked
  • KYC Pass

Request Path Parameters

Parameter Required Description
account_id Yes Customer account ID provided by Cabital.
symbol Yes Currency code

Response Parameters

Parameter Type Description
code string Currency code
balances string Balance amount
includes array The currencies included under this currency code

Example

Request Data

curl "/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/balances/BTC"

Response Data

1
2
3
4
{
  "code": "BTC",
  "balances": "35.57960648"
}