Bulk Transfer

post
‚Äč

https://api.payant.ng/wallets/withdraw/bulk/:reference_code
Request
Response
Path Parameters
reference_code
required
string
Wallet reference code
Headers
Authorization
required
string
Payant secret key prefixed by "Bearer "
Body Parameters
recipients
required
array
Recipients see table below for structure
200: OK
{
"status": "success",
"message": "Withdrawal queued for processing.",
"data": {
"company_id": "1",
"wallet_id": "1",
"wallet_reference_code": "PMojL342gd",
"currency": "NGN",
"amount": "1500.00",
"reference_code": "v0rX5GbWsH4FZB63tnjh",
"type": "BulkWithdrawal",
"channel": "Wallet",
"status": "1",
"disburse_recipients": "[{\"settlement_bank\":\"044\",\"account_number\":\"0000000000\",\"amount\":\"1500.00\"},{\"settlement_bank\":\"048\",\"account_number\":\"1111111111\",\"amount\":\"1000.00\"}]",
"created_at": "2016-12-21 18:50:30",
"updated_at": "2016-12-21 18:50:30",
"id": 2
"transaction_date": "2017-07-26T19:50:31.000Z",
"payment_id": "",
"referrer": "",
"gateway_response": "Successful",
"disburse_status": "1",
"disburse_ref": "BATCH gaZbf8ULE1BwXnWzhcJq",
"disburse_response": "Successful",
"disburse_recipients_response": "{\"status\":\"success\",\"data\":{\"batchId\":1447,\"message\":\"Disbursement queued for processing.\"}}"
}

Recipients Data

Parameter

Description

settlement_bank required

String Recipient's settlement bank

account_number required

String Recipient's account number

amount required

String Amount to send

Request

curl https://api.payant.ng/wallets/withdraw/bulk/PMojL342gd \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SECRET_KEY" \
-d '{ "recipients": [{
"settlement_bank": "044",
"account_number": "0000000000",
"amount": "1500.00",
},
{
"settlement_bank": "058",
"account_number": "1111111111",
"amount": "1000.00",
}] }' \
-X POST

Response

{
"status": "success",
"message": "Withdrawal queued for processing.",
"data": {
"company_id": "1",
"wallet_id": "1",
"wallet_reference_code": "PMojL342gd",
"currency": "NGN",
"amount": "1500.00",
"reference_code": "v0rX5GbWsH4FZB63tnjh",
"type": "BulkWithdrawal",
"channel": "Wallet",
"status": "1",
"disburse_recipients": "[{\"settlement_bank\":\"044\",\"account_number\":\"0000000000\",\"amount\":\"1500.00\"},{\"settlement_bank\":\"048\",\"account_number\":\"1111111111\",\"amount\":\"1000.00\"}]",
"created_at": "2016-12-21 18:50:30",
"updated_at": "2016-12-21 18:50:30",
"id": 2
"transaction_date": "2017-07-26T19:50:31.000Z",
"payment_id": "",
"referrer": "",
"gateway_response": "Successful",
"disburse_status": "1",
"disburse_ref": "BATCH gaZbf8ULE1BwXnWzhcJq",
"disburse_response": "Successful",
"disburse_recipients_response": "{\"status\":\"success\",\"data\":{\"batchId\":1447,\"message\":\"Disbursement queued for processing.\"}}"
}