Authentication
Send your key and secret on every request.
Errors
The response envelope and what each status means.
Webhooks
Receive events instead of polling for state.
Reference data
Currencies, countries, rates, rails, and codes.
Base URL
All partner endpoints live under
/api/v0.
Resources
A typical payout
1
Prepare the recipient
Call Get recipient required fields for the destination currency, collect exactly those fields, then Add recipient.
2
Price the transfer
Generate a quote. The quote fixes the rate and fees for a short window.
3
Fund it
Create a pre-transaction to confirm the quote and receive deposit instructions.
4
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
from your credential
Your partner 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.ISO-8601 UTC
Three fraction digits —
2026-09-02T12:34:56.789Z.decimal strings
Amounts are strings, not floats —
"1500.00". Parse them with a decimal type, never a binary float.per key
Endpoints are gated by permissions such as
quotes, recipients, and accounts. A key without the required permission fails with 400, not 403.What’s missing
This reference was generated from the Endl Partner API Postman collection, which carries no saved response examples. Two things still need filling in:- Response schemas for all 36 endpoints. The envelope is right; the contents of
dataare not yet described. - Per-endpoint permission names, which are documented only where the collection recorded them.