# Apex Settlement Docs > Developer documentation for the Apex Settlement API: quotes, payouts, beneficiaries, balances, webhooks and Platforms acting for End Customers. Every page is also available as Markdown: add `.mdx` to its URL. The full text is at https://test-settlement-docs.rudiqpay.com/llms-full.txt. The OpenAPI document is at https://test-settlement-docs.rudiqpay.com/openapi/customer-api.json. - Documentation: Concepts and guides - [Introduction](https://test-settlement-docs.rudiqpay.com/docs.mdx): Pay people and companies abroad from your own systems with the Apex Settlement API. - [Quickstart](https://test-settlement-docs.rudiqpay.com/docs/quickstart.mdx): Send your first sandbox payout, from an API key to a completed Payout. - **Concepts** - [Environments](https://test-settlement-docs.rudiqpay.com/docs/concepts/environments.mdx): Sandbox and production, their API keys, what sandbox simulates, and the rate limits. - [Authentication](https://test-settlement-docs.rudiqpay.com/docs/concepts/authentication.mdx): API keys, the permissions they hold, how to keep them safe, and the 401 and 403 answers. - [Conventions](https://test-settlement-docs.rudiqpay.com/docs/concepts/conventions.mdx): Amounts, assets, countries, ids, timestamps, pagination and the headers every integration uses. - [Errors](https://test-settlement-docs.rudiqpay.com/docs/concepts/errors.mdx): The error envelope, how to branch on it, when to retry, and the codes you will meet most. - [Idempotency](https://test-settlement-docs.rudiqpay.com/docs/concepts/idempotency.mdx): Retry payout and End Customer creation safely with the Idempotency-Key header. - **Guides** - [Send a payout](https://test-settlement-docs.rudiqpay.com/docs/guides/send-a-payout.mdx): Quote a payment to a Beneficiary, accept one quote as a Payout, and follow it until the money arrives. - [Beneficiaries](https://test-settlement-docs.rudiqpay.com/docs/guides/beneficiaries.mdx): Register the people and companies you pay, give each destination the details it needs, and link other Customers by their Receiving Code. - [Balances and deposits](https://test-settlement-docs.rudiqpay.com/docs/guides/balances-and-deposits.mdx): Read what you hold and where, fund your balance at the right Provider, and see a deposit arrive. - [Receiving payouts](https://test-settlement-docs.rudiqpay.com/docs/guides/receiving-payouts.mdx): Let other Customers pay you with your Receiving Code, choose where the money lands, and follow each incoming payment. - [Webhooks](https://test-settlement-docs.rudiqpay.com/docs/guides/webhooks.mdx): Receive signed events about your Payouts, Deposits and Beneficiaries, verify them, and handle retries. - [Platforms](https://test-settlement-docs.rudiqpay.com/docs/guides/platforms.mdx): Serve your own customers as End Customers, open and onboard them over the API, and act for each of them with one header. - [Onboarding](https://test-settlement-docs.rudiqpay.com/docs/guides/onboarding.mdx): Complete KYC or KYB over the API, from the profile and documents to terms, submission and review, and know what each state lets you call. - **Resources** - [Changelog](https://test-settlement-docs.rudiqpay.com/docs/changelog.mdx): Changes to the Apex Settlement API, newest first. - API Reference: Every endpoint of the Customer API - [API reference](https://test-settlement-docs.rudiqpay.com/docs/api-reference.mdx): Every endpoint of the Apex Settlement Customer API, generated from its OpenAPI 3.1 document. - Customer: The Customer the API key belongs to: its name, its standing and the Providers that approved it. - [Get the Customer](https://test-settlement-docs.rudiqpay.com/docs/api-reference/customer/get-customer.mdx): The Customer the API key belongs to (or, with `Apex-End-Customer`, that End Customer): its legal name, type and country, its `standing` (`onboarding`, `active`, `suspended` or `closed`), its `kind` (`direct`, `platform`, or `end_customer` of a Platform) 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. - [List Compliance Documents](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/list-documents.mdx): Every version of every Compliance Document the Customer uploaded, newest first; `current` marks the version in force for its kind and subject. - [Upload a Compliance Document](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/upload-document.mdx): Uploads one file of evidence for the Compliance Profile as `multipart/form-data`: `file`, `kind`, `subject_kind` and, for a beneficial owner or a control person, `subject_ref`, the person's name exactly as the profile spells it. - [Download a Compliance Document](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/download-document.mdx): The file itself, as an attachment of its type (`application/pdf`, `image/jpeg` or `image/png`). - [Get the onboarding status](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/get-onboarding.mdx): Where the Customer stands on its way in and what it still owes. - [Get the Compliance Profile](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/get-profile.mdx): The Customer's Compliance Profile: the draft while it is `profile_pending`, else its last submission, with the fields Compliance asked to change. - [Save the Compliance Profile draft](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/save-profile.mdx): Replaces the draft with `data`: `business` for a business Customer, `individual` for an individual one. - [Submit the Compliance Profile](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/submit-profile.mdx): Sends the profile to Compliance for review. - [Get the terms](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/get-terms.mdx): The terms the Customer must accept, the platform's and each Provider's, each with its version and link, and whether they are all accepted. - [Accept the terms](https://test-settlement-docs.rudiqpay.com/docs/api-reference/onboarding/accept-terms.mdx): Accepts, for the Customer, every document of the terms set `GET /v1/terms` answered, named by its `version`. - Balances: What the Customer holds, per asset and per Provider, available to spend and held for Payouts. - [List balances](https://test-settlement-docs.rudiqpay.com/docs/api-reference/balances/list-balances.mdx): The Customer's balance in each asset it holds: `available` to spend and `held` for Payouts that are funded and not finished. - Deposits: Where the Customer sends funds to credit its balance. A credited Deposit is announced by the `deposit.received` webhook. - [List deposit instructions](https://test-settlement-docs.rudiqpay.com/docs/api-reference/deposits/list-deposit-instructions.mdx): 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. - Beneficiaries: The parties the Customer pays: an outside party, its own account elsewhere, or another Customer added by its Receiving Code. - [List Beneficiaries](https://test-settlement-docs.rudiqpay.com/docs/api-reference/beneficiaries/list-beneficiaries.mdx): Every Beneficiary of the Customer, in each state: `pending_verification` (waiting for the operations team), `verified` (it can be quoted and paid) or `blocked` (final). - [Register a Beneficiary](https://test-settlement-docs.rudiqpay.com/docs/api-reference/beneficiaries/create-beneficiary.mdx): Registers a party the Customer will pay: `external` (an outside person or business) or `own_account` (the Customer's own account elsewhere, which needs `proof_reference`, a reference to the evidence that the account is the Customer's). - [Add another Customer by its Receiving Code](https://test-settlement-docs.rudiqpay.com/docs/api-reference/beneficiaries/link-beneficiary.mdx): Adds the Customer that gave this Receiving Code as a Beneficiary. - [Get a Beneficiary](https://test-settlement-docs.rudiqpay.com/docs/api-reference/beneficiaries/get-beneficiary.mdx): One of the Customer's Beneficiaries, as `GET /v1/beneficiaries` lists it. - Quotes: What sending an amount to a Beneficiary would cost and deliver, one Quote per eligible Route, each valid for a short time. - [Quote a payment to a Beneficiary](https://test-settlement-docs.rudiqpay.com/docs/api-reference/quotes/create-quote.mdx): Prices sending `amount` of `source_asset` from the Customer's balance to one of its Beneficiaries, in the Beneficiary's country and asset. - Payouts: Accepting a Quote into a Payout, following it to completion, and cancelling it while nothing is reserved for it. - [List Payouts](https://test-settlement-docs.rudiqpay.com/docs/api-reference/payouts/list-payouts.mdx): The Customer's Payouts, newest first, one page at a time. - [Accept a Quote into a Payout](https://test-settlement-docs.rudiqpay.com/docs/api-reference/payouts/create-payout.mdx): Accepts one Quote of a quote set, named by its `quote_id`, before its `expires_at`. - [Get a Payout](https://test-settlement-docs.rudiqpay.com/docs/api-reference/payouts/get-payout.mdx): One of the Customer's Payouts with its Legs (one per Provider step of its Route), fees, rates and timeline: every state it passed through, when, and who moved it (`customer` for the Customer's own people and API keys, `operations` for the operations team, `system` for the platform itself). - [Cancel a Payout](https://test-settlement-docs.rudiqpay.com/docs/api-reference/payouts/cancel-payout.mdx): Cancels a Payout nothing has been reserved for yet: one `awaiting_approval`, or `accepted` and still waiting for funds. - Receiving: Being paid by other Customers: the Receiving Code the Customer hands out and the account those Payouts are paid into. - [Get the Receiving Code and account](https://test-settlement-docs.rudiqpay.com/docs/api-reference/receiving/get-receiving.mdx): The Receiving Code the Customer hands to other Customers of the platform so they can pay it, and its Receiving Account, the verified own account those Payouts are paid into. - [Choose the Receiving Account](https://test-settlement-docs.rudiqpay.com/docs/api-reference/receiving/set-receiving-account.mdx): Names which of the Customer's verified `own_account` Beneficiaries the Payouts other Customers send it are paid into. - [Issue a new Receiving Code](https://test-settlement-docs.rudiqpay.com/docs/api-reference/receiving/issue-receiving-code.mdx): Puts a new Receiving Code in force: the first one, or one replacing the code in force. - Incoming payouts: Payouts other Customers sent this Customer, as the receiver sees them. - [List incoming payouts](https://test-settlement-docs.rudiqpay.com/docs/api-reference/incoming-payouts/list-incoming-payouts.mdx): Payouts other Customers sent this Customer by its Receiving Code, newest first, one page at a time. - [Get an incoming payout](https://test-settlement-docs.rudiqpay.com/docs/api-reference/incoming-payouts/get-incoming-payout.mdx): One Payout another Customer sent this Customer, as `GET /v1/incoming-payouts` lists it: who sent it, what arrives, the purpose the sender declared, where it stands and, once delivered, whether it was credited to the Customer's balance or paid to its bank account. - Webhooks: Endpoints that receive signed notifications of the Customer's Payouts, Deposits and Beneficiaries, and their deliveries. - [List webhook endpoints](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/list-webhook-endpoints.mdx): The Customer's webhook endpoints, newest first, with the event types each receives, whether it is `active` or `disabled` (and why), its last successful delivery and since when it has been failing. - [Register a webhook endpoint](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/create-webhook-endpoint.mdx): Registers an HTTPS URL to receive the Customer's events of the types named in `events` (see the webhooks of this reference for each payload). - [Redeliver a webhook event](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/redeliver-webhook.mdx): Sends a `delivered` or `failed` delivery again, from a first attempt, with the same event `id`, so a receiver that deduplicates on it acts once. - [List an endpoint's deliveries](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/list-webhook-deliveries.mdx): The endpoint's deliveries, newest first: each event sent to it, its `state` (`pending` while attempts remain, `delivered` once one got a 2xx, `failed` after the last), how many attempts were made, the status, start of the body and duration of the last answer, and the exact payload sent. - [Disable a webhook endpoint](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/disable-webhook-endpoint.mdx): Stops sending to the endpoint: new events are no longer queued for it, and a delivery still pending fails at its next attempt (redeliver it once the endpoint is enabled again). - [Enable a webhook endpoint](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/enable-webhook-endpoint.mdx): Sends to a disabled endpoint again, whether you disabled it or it was disabled after failing for 24 hours; the failure clock starts afresh. - [Rotate a webhook endpoint's signing secret](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/rotate-webhook-secret.mdx): Replaces the endpoint's signing secret at once: every attempt from now on, retries of older deliveries included, is signed with the new one. - [beneficiary.updated](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/beneficiary-updated-event.mdx): One of the Customer's Beneficiaries changed - [deposit.received](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/deposit-received-event.mdx): A Deposit was credited to the Customer's balance - [payout.incoming.updated](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/incoming-payout-updated-event.mdx): A Payout another Customer sent this Customer changed - [payout.updated](https://test-settlement-docs.rudiqpay.com/docs/api-reference/webhooks/payout-updated-event.mdx): One of the Customer's Payouts changed - 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. - [List End Customers](https://test-settlement-docs.rudiqpay.com/docs/api-reference/end-customers/list-end-customers.mdx): The Platform's End Customers, newest first, with each one's onboarding `state` and `standing`. - [Open an End Customer](https://test-settlement-docs.rudiqpay.com/docs/api-reference/end-customers/create-end-customer.mdx): Opens an End Customer of the Platform in `profile_pending`. - [Get an End Customer](https://test-settlement-docs.rudiqpay.com/docs/api-reference/end-customers/get-end-customer.mdx): One of the Platform's End Customers, with each Provider's decision on it and `has_people`, whether anyone can sign in for it yet. - [Reactivate an End Customer](https://test-settlement-docs.rudiqpay.com/docs/api-reference/end-customers/reactivate-end-customer.mdx): Lifts a suspension the Platform made. - [Suspend an End Customer](https://test-settlement-docs.rudiqpay.com/docs/api-reference/end-customers/suspend-end-customer.mdx): Suspends an active End Customer of the Platform: it can still read, but changes nothing and sends no new Payouts until reactivated; Payouts already handed to a Provider run their course.