Changelog
Changes to the Apex Settlement API, newest first.
2026-11-12: Public API reference published
The reference for the Customer API (/v1) is public. It covers:
- Your account and money:
GET /v1/customer,GET /v1/balanceswith each balance split by the Provider holding it, andGET /v1/deposit-instructions. - Beneficiaries: register, list and read them; add another Customer with its Receiving Code (
POST /v1/beneficiaries/link); manage your own Receiving Code and account (/v1/receiving). - Quotes and Payouts:
POST /v1/quotes,POST /v1/payoutswith a requiredIdempotency-Key, list, read and cancel Payouts, andGET /v1/incoming-payoutsfor Payouts sent to you. - Webhooks:
payout.updated,payout.incoming.updated,deposit.receivedandbeneficiary.updated, signed withApex-Signature, with a delivery log, redelivery and secret rotation. - Platforms: End Customers (
/v1/end-customers) and theApex-End-Customerheader to act for one. - Verification: your KYC or KYB profile, documents and terms (
/v1/profile,/v1/documents,/v1/terms).
API keys are created in the Customer panel: ak_test_ keys for sandbox, ak_live_ keys for production.