List balances
customer:readThe 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.
ApiKeyAuthorizationBearer <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.
Apex-End-Customer?stringA 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.
uuidOK
application/json- response
[index: integer]?curl -X GET 'http://localhost:3480/v1/balances'[ { "asset": "USDC", "available": "1000", "held": "0", "held_at": [ { "available": "1000", "held": "0", "provider": "bvnk" } ] }]Accept the terms POST
Accepts, for the Customer, every document of the terms set `GET /v1/terms` answered, named by its `version`.
List deposit instructions GET
Where to send an asset to credit the Customer's balance: one entry per Provider that approved the Customer and takes Deposits of the asset, with a wallet `address` and `network` (and a `memo` where the network needs one) for a stablecoin, or `bank_details` for a bank transfer.