Skip to Content
Apex Settlement

Introduction

Pay people and companies abroad from your own systems with the Apex Settlement API.

What the API does

The Apex Settlement API lets your systems send cross-border payouts from your balance with us. You register who you pay as a Beneficiary, ask for Quotes, and accept one. Each Quote is an all-in price over one route through our licensed Providers: the Providers' rates are passed through unchanged and every fee is its own line. An accepted Quote becomes a Payout. We run it step by step, which we call Legs, and tell your server about every change through signed webhooks. A Platform does all of this for its own End Customers with the same calls.

The API is JSON over HTTPS. Every path starts with /v1, and your systems authenticate with an API key that a Customer admin creates in the Customer panel.

Core objects

ObjectWhat it isMain endpoints
QuoteA short-lived, all-in price for sending an amount to one Beneficiary over one route. You get one Quote per eligible route and accept one.POST /v1/quotes
PayoutA Quote you accepted: money leaving your balance and arriving at the Beneficiary. It moves through states such as processing and completed.POST /v1/payouts, GET /v1/payouts/{id}
BeneficiaryA person or company you pay, with the account details the destination needs. We verify each one before it can be paid.POST /v1/beneficiaries, GET /v1/beneficiaries
BalanceWhat you hold in one asset, split by the Provider that holds it. A Payout draws on one Provider's part.GET /v1/balances
Webhook endpointYour HTTPS address that receives signed notifications about your Payouts, Deposits and Beneficiaries.POST /v1/webhooks
End CustomerA customer of a Platform. It has its own balance and passes its own checks; the Platform acts for it.POST /v1/end-customers

How a payout flows

  1. Your server asks for Quotes for an amount and a verified Beneficiary.
  2. You accept one Quote before its expires_at by creating a Payout. The Idempotency-Key header makes the call safe to retry.
  3. The amount is taken from your balance and we run the route's Legs at the Providers.
  4. Every state change is sent to your webhook endpoint. You can also read the Payout at any time.

Next steps

On this page