Get Account Balance
Retrieve all currencies of account balance¶
GET https://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¶
Response Data¶
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¶
GET https://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 |