Payout
Bulk Payout
Initiate Bulk Transfer
Status of transfer object returned will be pending until it's proccessed successfully.
Endpoint: /bulk_bank_transfer
Method: POST
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
| content-type | string | Yes | Set value to application/json |
| Encryption | string | Yes | Set value to your {Signature_HMAC-SHA-512} output |
Body Param
| Param | Type | Required? | Decription |
|---|---|---|---|
| currency | string | Yes | Specify the currency of the transfer. Defaults to NGN |
| amount | string | Yes | Amount to transfer in currency SET value |
| bank_code | string | Yes | receiver's account bank code (check bank list) |
| bank_name | string | Yes | receiver's account bank name (check bank list) |
| account_number | string | Yes | receiver's account number |
| narration | string | Yes | Transfer naration |
| reference | string | No | If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters allowed. |
Sample Post
curl https://api.budpay.com/api/v2/bulk_bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{
"currency": "NGN",
"transfers": [
{
"amount": "200",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"narration": "January Salary"
},
{
"amount": "100",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"narration": "February Salary"
},
{
"amount": "100",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"narration": "March Salary"
}
]
}'
-X POST
Sample Response
{
"success": true,
"message": "3 Transfers queued",
"data": [
{
"reference": "trf_j51m4695fk57nf",
"currency": "NGN",
"amount": "200",
"fee": "10",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"account_name": "OYENIYI TOLULOPE OYEBIYI",
"narration": "January Salary",
"domain": "test",
"status": "pending",
"updated_at": "2022-03-30T00:03:12.000000Z",
"created_at": "2022-03-30T00:03:12.000000Z"
},
{
"reference": "trf_1h1x3v5400n612",
"currency": "NGN",
"amount": "100",
"fee": "10",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"account_name": "OYENIYI TOLULOPE OYEBIYI",
"narration": "February Salary",
"domain": "test",
"status": "pending",
"updated_at": "2022-03-30T00:03:13.000000Z",
"created_at": "2022-03-30T00:03:13.000000Z"
},
{
"reference": "trf_f9098ac5272653",
"currency": "NGN",
"amount": "100",
"fee": "10",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"account_name": "OYENIYI TOLULOPE OYEBIYI",
"narration": "March Salary",
"domain": "test",
"status": "pending",
"updated_at": "2022-03-30T00:03:13.000000Z",
"created_at": "2022-03-30T00:03:13.000000Z"
}
]
}