API reference
Every endpoint of the Apex Settlement Customer API, generated from its OpenAPI 3.1 document.
The reference is generated from the same OpenAPI document the API is built against, so it never drifts from what the server accepts. Each endpoint page shows its parameters, request body and responses, code samples in cURL, JavaScript, Python and Go, and a playground that sends real requests.
Base URL
Every path starts with /v1. Pick the server that matches your key:
http://localhost:3480Local developmentSee Environments for what each environment is for.
Authentication
Send your API key as a bearer token on every request:
Authorization: Bearer ak_test_…Sandbox keys start with ak_test_, live keys with ak_live_. See Authentication.
The playground is for sandbox keys only
The Try it playground sends requests straight from your browser, and keeps the key in this tab's session storage. Paste only ak_test_ keys there, never a live key. If a request fails before reaching the API, the sandbox may not allow requests from this site (CORS); use the cURL sample instead.
Downloads
- OpenAPI 3.1 document: import it into your own tools or generate a client.
- Postman collection: set the
baseUrlandapiKeyvariables after importing.
Errors
Every error answers the same envelope with a stable code your code can branch on. See Errors for the envelope and the full list of codes.
Endpoints
Customer
The Customer the API key belongs to: its name, its standing and the Providers that approved it.
Onboarding
Passing due diligence: the Compliance Profile, its documents and the terms, then submission for review. These are the only operations open while the Customer is being onboarded.
Balances
What the Customer holds, per asset and per Provider, available to spend and held for Payouts.
Deposits
Where the Customer sends funds to credit its balance. A credited Deposit is announced by the `deposit.received` webhook.
Beneficiaries
The parties the Customer pays: an outside party, its own account elsewhere, or another Customer added by its Receiving Code.
Quotes
What sending an amount to a Beneficiary would cost and deliver, one Quote per eligible Route, each valid for a short time.
Payouts
Accepting a Quote into a Payout, following it to completion, and cancelling it while nothing is reserved for it.
Receiving
Being paid by other Customers: the Receiving Code the Customer hands out and the account those Payouts are paid into.
Incoming payouts
Payouts other Customers sent this Customer, as the receiver sees them.
Webhooks
Endpoints that receive signed notifications of the Customer's Payouts, Deposits and Beneficiaries, and their deliveries.
End customers
The Platform API: a Platform opens and manages its End Customers, and acts for one on the other operations with the `Apex-End-Customer` header.