API reference overview

The Endl Partner API is a JSON REST API. Every endpoint is authenticated with your partner API key, scoped to the partner that owns the credential, and returns the standard response envelope.

Base URL

Environment	Base URL
Sandbox	`https://api-sandbox.endl.io`
Production	Issued at onboarding

All partner endpoints live under /api/v0.

Resources

Wallets

Create wallets and provision them on additional networks.

Quotes

Price a transfer before you commit to it.

Recipients

Manage the parties a user pays out to.

Accounts

Open accounts and read balances and activity.

Transactions

Fund, submit, and track transfers.

Reference data

Static catalogues you should cache rather than re-fetch.

POBO

Pay out on behalf of a named originator. Partner-scoped, Paywho rails only.

A typical payout

Prepare the recipient. Call Get recipient fields for the corridor, collect exactly those fields, then add the recipient.
Price the transfer. Generate a quote. The quote fixes the rate and fees for a short window.
Check it. Create a pre-transaction to check the quote, recipient, wallet and KYC together. It moves no money; Endl debits the source when you submit. See the Transactions guide.
Submit and track. Submit the transaction, then track it with Get transaction — or subscribe to payout.completed and payout.failed and let Endl tell you.

Conventions

Convention	Detail
Identity	Comes from the API key, so you only ever see and manage your own resources. A resource belonging to another partner returns `404`, never `403`.
Identifiers	Resources are prefixed reference ids — `cus_`, `wlt_`, `rec_`, `qut_`, `txn_`, `snd_` plus 20 Base62 characters. Catalogue ids (`currencyId`, `countryId`) are plain integers from the reference endpoints.
Empty values	Most objects leave out keys with no value. Don’t rely on a key being present unless its description says it is always present.
Timestamps	ISO 8601 strings in UTC, e.g. `2026-10-22T09:15:32.481Z`.
Money	Decimal strings, not floats — `"1500.00"`. Parse with a decimal type, never a binary float.
Versioning	Every request sends `Api-Version: 2026-09.1`. The version that served the call is echoed back in the `Api-Version` response header. See Versioning.
Correlation	Every response carries `X-Request-ID` — except a `401` authentication failure, which carries none.
Permissions	Endpoints are gated by permissions such as `quotes`, `recipients` and `accounts`. A key without the required permission fails with `403`, raised at the edge.

Response coverage

Every success response on these pages is documented from the server code behind /api/v0 (Api-Version: 2026-09.1): Accounts, Quotes, Wallets, Recipients, Reference data, Transactions and POBO. Requests, parameters, status codes and error responses are documented on every page. The Onboarding and Webhooks APIs carry real response examples too. Per-endpoint permission names are documented only where they are known.

​Base URL

​Resources