Features
FX Rate Retrieval
Access real-time foreign exchange rates and lock quotes before sending payments.
Beneficiary Management
Create and manage reusable payment destinations to streamline repeat payouts.
Payment Processing
Initiate payouts to bank accounts and mobile wallets with built-in compliance checks.
Payment Tracking
Monitor the status of every payment in real-time via API polling or webhooks.
Global Coverage
Send payments in multiple currencies through local rails and SWIFT across a broad network of countries.
How It Works
Every payout follows four steps:Discover requirements
Call
GET /v1/payment-requirements to get the required fields for a country and payment method. Call GET /v1/providers to list supported banks and mobile money providers.Create a beneficiary
Store the recipient’s payment details with
POST /v1/beneficiaries. Beneficiaries are reusable — create once, pay many times.KYC documents (e.g., a government-issued ID) are required for beneficiaries. Upload documents via
POST /v1/files/upload-url before creating the beneficiary. See Making a Payment for the full flow.Send a payout
Check your balance, lock an FX rate with
POST /v1/fx/quotes, then execute the payout with POST /v1/payouts using the returned quote id.Track the payment
Poll
GET /v1/payouts/:id or subscribe to webhooks for real-time status updates.API Endpoints
Beneficiaries
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/beneficiaries | Create a beneficiary |
| GET | /v1/beneficiaries | List beneficiaries |
| GET | /v1/beneficiaries/{id} | Get a beneficiary |
| DELETE | /v1/beneficiaries/{id} | Delete a beneficiary |
Payouts
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/payouts | Create a payout |
| GET | /v1/payouts | List payouts |
| GET | /v1/payouts/{id} | Get payout status |
FX
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/fx-quotes | Get an FX quote |
Balances
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/balances | Get wallet balances |
| GET | /v1/funding-details | Get funding instructions for your wallet |
Discovery
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/payment-requirements | Get required fields for a corridor |
| GET | /v1/providers | List supported banks and providers |
| GET | /v1/payment-methods | List available payment methods |
Webhook Events
Subscribe to these events to track payment lifecycle changes:| Event | Description |
|---|---|
transaction.initiated | Payout created and compliance checks in progress |
transaction.succeeded | Delivered to recipient |
transaction.failed | Payment failed. If isReturned is true, the payment was previously successful but returned by the recipient’s bank. |