POST /transferrecipient/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 |
|---|---|---|---|
batch[] |
Array | Yes |
A list of transfer recipient object. Each object should contain type, name, and bank_code. Any Create Transfer Recipient param can also be passed. |
batch[].name |
String | Yes |
Recipient's name |
batch[].bank_code |
String | Yes |
Recipient's bank code. You can get the list of Bank Codes by calling the List Banks endpoint |
batch[].description |
String | No |
A description for this recipient |
batch[].type |
String | Yes |
Recipient Type - nuban for NGN, mobile_money for MOMO in GHS, basa for ZAR and authorization for all. Possible values:
|
batch[].metadata |
String | No |
Stringified JSON object of custom data |
batch[].account_number |
String | Yes |
Recipient's bank account number |
batch[].currency |
String | No |
Currency for the account receiving the transfer Possible values:
|
batch[].authorization_code |
String | No |
An authorization code from a previous transaction |
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.