API Reference

List all balances

gethttps://api-sandbox.circle.com/v1/businessAccount/balances

Reference
Playground

Retrieves the balance of funds that are available for use.

Response

200ListBusinessBalancesResponse

Response Body

object

data

object

Available and unsettled balances of the merchant.

Show 2 properties

available

array of objects

Required

List of currency balances (one for each currency) that are currently available to spend.

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code for the amount.

Allowed valuesUSDEURBTCETH

unsettled

array of objects

Required

List of currency balances (one for each currency) that have been captured but are currently in the process of settling and will become available to spend at some point in the future.

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code for the amount.

Allowed valuesUSDEURBTCETH

401NotAuthorized

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "available": [
4      {
5        "amount": "3.14",
6        "currency": "USD"
7      }
8    ],
9    "unsettled": [
10      {
11        "amount": "3.14",
12        "currency": "USD"
13      }
14    ]
15  }
16}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy