quoteId for each — ready to use with the Bulk Payout API.
When to use bulk quotes
Use bulk quotes when you need to disburse funds to multiple beneficiaries and want to lock in pricing for all transfers upfront. Common scenarios include:- Payroll: Quote salary amounts for all employees before disbursement.
- Vendor payments: Get pricing for multiple supplier payments at once.
- Mass disbursements: Quote commissions, rewards, or refunds in batch.
How it works
Gather all the amounts you need to send. Each item only requires a
sourceAmount — the amount in your source currency.Send all amounts in a single
POST /v1/bulk/quote request along with the payment channel, source, and target corridor.curl --request POST 'https://{{baseURL}}/v1/bulk/quote' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data '{
"paymentChannel": "BANK_TRANSFER",
"items": [
{ "sourceAmount": 100.00 },
{ "sourceAmount": 250.50 }
],
"source": { "currency": "NGN", "country": "NG" },
"target": { "currency": "NGN", "country": "NG" }
}'
The response returns an array of quotes, each with its own
quoteId, rate, fee, and expiry. Store these IDs for the next step.curl --request GET 'https://{{baseURL}}/v1/bulk/quote?quoteIds=fa01c1ad-6c0f-4074-8221-ffc8fdaa16db"eIds=6809b2ab-1d4d-4436-8218-46667419eee7' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY'
Pass each
quoteId into the corresponding order in your POST /v1/bulk/payout request.Request fields
| Field | Type | Description | Required |
|---|---|---|---|
paymentChannel | String | Channel for the transfers (BANK_TRANSFER, MOBILE_MONEY, etc.). | ✅ Yes |
items | Array | List of objects, each with a sourceAmount. | ✅ Yes |
items[].sourceAmount | Number | Amount to send in the source currency. | ✅ Yes |
source.currency | String | Source currency (ISO 4217). | ✅ Yes |
source.country | String | Source country (ISO 3166-1 alpha-2). | ✅ Yes |
target.currency | String | Target currency (ISO 4217). | ✅ Yes |
target.country | String | Target country (ISO 3166-1 alpha-2). | ✅ Yes |
Response fields
Each quote in the response array contains:| Field | Type | Description |
|---|---|---|
quoteId | String (UUID) | Unique identifier for this quote. Use when creating the bulk payout. |
sourceAmount | Number | Amount in the source currency. |
targetAmount | Number | Amount the recipient will receive. |
rate | Number | Exchange rate applied. |
fee | Number | Fee charged for this transfer. |
sourceCurrency | String | Source currency code. |
targetCurrency | String | Target currency code. |
expiresInSeconds | Integer | Seconds until this quote expires (typically 600). |
Next steps
Create Bulk Quote API
Full OpenAPI reference for
POST /v1/bulk/quote.Fetch Bulk Quotes API
Retrieve existing quotes via
GET /v1/bulk/quote.Bulk Payouts Guide
Learn how to submit bulk payouts using your quote IDs.
Single Quote Guide
Need to quote just one transfer? Use the standard quote flow.

