Skip to Content
Apex Settlement
Balances

List balances

Required permissioncustomer:read
GET
/v1/balances

The Customer's balance in each asset it holds: available to spend and held for Payouts that are funded and not finished. held_at splits each total by the Provider holding it (provider is the key GET /v1/deposit-instructions answers). A Payout draws on one Provider's part only, the one its Route starts at, so a Quote can say funds_at_other_provider while the total would cover it.

Requires the customer:read permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Header Parameters

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Formatuuid

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'http://localhost:3480/v1/balances'
Example Response
[  {    "asset": "USDC",    "available": "1000",    "held": "0",    "held_at": [      {        "available": "1000",        "held": "0",        "provider": "bvnk"      }    ]  }]