POST /transfer/bulk
Servers
- https://api.paystack.co
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
source |
String | No |
Where should we transfer from? Only balance is allowed for now |
transfers[] |
Array | No |
A list of transfer object. Each object should contain amount, recipient, and reference |
transfers[].source |
String | Yes |
Where should we transfer from? Only balance is allowed for now |
transfers[].amount |
Integer | Yes |
Amount to transfer in kobo if currency is NGN. pesewas if currency is GHS and cents for ZAR. |
transfers[].reference |
String | No |
If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters are allowed. |
transfers[].reason |
String | No |
The reason or narration for the transfer. |
transfers[].currency |
String | No |
Specify the currency of the transfer. Defaults to NGN. |
transfers[].recipient |
String | Yes |
The transfer recipient's code |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.