Base URL
Authentication
All requests require an API key in theAuthorization header:
ak_test_* keys for sandbox and ak_live_* keys for production. See Authentication for details.
Request format
- Request bodies use
Content-Type: application/json - All monetary amounts are strings (e.g.,
"500.00") to avoid floating-point precision issues - Dates use ISO 8601 format (
2026-02-14T10:30:00Z) - IDs are prefixed strings (e.g.,
pay_,pye_,ins_,batch_)
Response format
All successful responses are wrapped in adata envelope:
Single resource
List response
Idempotency
Financial mutation endpoints (create payout, confirm batch, execute FX exchange) require anIdempotency-Key header. See Idempotency for details.
Rate limiting
Requests are rate-limited per merchant (1,000 requests/minute). Exceeding the limit returns429 Too Many Requests with a Retry-After header.
Resources
| Resource | Endpoint | Description |
|---|---|---|
| Reference Data | /v1/currencies, /v1/countries, /v1/payment-methods | Supported currencies, countries, and payment methods |
| Payouts | /v1/payouts | Create and track cross-border payouts |
| Payees | /v1/payees | Manage payout recipients |
| Instruments | /v1/instruments | Payment methods attached to payees |
| Balances | /v1/balances | Merchant funding balances by currency |
| Accounts | /v1/accounts | Funding accounts and transaction history |
| Batches | /v1/batches | Bulk payout uploads via CSV/XLSX |
| Webhooks | /v1/webhooks | Real-time event notifications |
| Documents | /v1/documents | Upload compliance documents |
| RFIs | /v1/rfis | Respond to compliance requests |
| Pricing | /v1/pricing | View pricing plans and fee quotes |
| FX | /v1/fx | Foreign exchange quoting and conversion |
| Corridors | /v1/corridors | Available payment corridors |