Create a bulk transfer
Submit multiple transfer items in one request. Each item is stored independently, so a failure on one beneficiary does not hide the result of the other items.
Endpoint
Requires X-API-Key authentication.
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | Batch currency, for example XAF. |
items | array | Yes | At least one transfer item. |
items[].name | string | Yes | Beneficiary name. |
items[].phone | string | Yes | Beneficiary phone number. |
items[].amount_minor | integer | Yes | Amount in XAF. Each value must be between 500 and 1,000,000 and be a multiple of 50. |
items[].service_mobile_code | string | Yes | A mobile-service code_prefix. |
items[].beneficiary_id | string | No | Existing beneficiary identifier. |
items[].external_reference | string | No | Your own idempotency or reconciliation reference. |
Example request
Response
The batch is asynchronous. Use the returned batch reference and the transfer listing to reconcile individual results.
Errors
400— empty batch, invalid item, or insufficient balance;401— missing or invalid API key;500— unexpected server error.