Payout
Single Payout
Initiate Transfer
Status of transfer object returned will be pending until it's proccessed successfully.
Endpoint: /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 |
| paymentMode | string | Yes | payment mode is required only curreny is KES |
| meta_data | string | No | An array containing of custom input you would like to pass to us |
| reference | string | No | If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters allowed. |
Sample Post (NGN)
curl https://api.budpay.com/api/v2/bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{
"currency": "NGN",
"amount": "100",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"narration": "Test transfer",
"meta_data":[
{
"sender_name":"Nium Consult",
"sender_address":"New Orleans, USA"
}
]
}'
-X POST
Sample Post (KES)
curl https://api.budpay.com/api/v2/bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{
"account_number": "0719593074",
"amount": "10",
"bank_code": "0016",
"bank_name": "Citi Bank",
"currency": "KES",
"narration": "Bank Prod test payment",
"paymentMode": "momo",
"meta_data":[
{
"sender_name":"Nium Consult",
"sender_address":"New Orleans, USA"
}
]
}'
-X POST
Sample Post (GHS)
curl https://api.budpay.com/api/v2/bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Encryption: Signature_HMAC-SHA-512"
-H "Content-Type: application/json"
-d '{
"account_number": "0270073750",
"amount": "10",
"bank_code": "ABS",
"bank_name": "ABSA BANK",
"currency": "GHS",
"narration": "Bank Transfer To Ghana",
"meta_data":[
{
"sender_name":"Nium Consult",
"sender_address":"New Orleans, USA"
}
]
}'
-X POST
Sample Response (NGN)
{
"success": true,
"message": "Transfer successfully logged and Processing",
"data": {
"reference": "trf_11044f068j1604",
"currency": "NGN",
"amount": "100",
"fee": "10",
"bank_code": "000013",
"bank_name": "GUARANTY TRUST BANK",
"account_number": "0050883605",
"account_name": "OYENIYI TOLULOPE OYEBIYI",
"narration": "Test transfer",
"domain": "test",
"status": "pending",
"updated_at": "2022-03-29T02:51:01.000000Z",
"created_at": "2022-03-29T02:51:01.000000Z"
}
}
Sample Response (GHS)
{
"success": true,
"message": "Transfer successfully logged and Processing",
"data": {
"reference": "BUD_trf_2j2079bzx1786f",
"currency": "GHS",
"amount": "30",
"fee": "10",
"bank_code": "AIR",
"bank_name": "AIR",
"account_number": "0270073750",
"account_name": "AKINRINADE SAMUEL",
"narration": "Bank Transfer To Ghana",
"domain": "live",
"status": "success",
"updated_at": "2022-03-29T02:51:01.000000Z",
"created_at": "2022-03-29T02:51:01.000000Z"
}
}
Sample Response (KES)
{
"success": true,
"message": "Transfer successfully logged and Processing",
"data": {
"reference": "BUD_trf_2j2079bzx1786f",
"currency": "KES",
"amount": "30",
"fee": "10",
"bank_code": "0016",
"bank_name": "Citi Bank",
"account_number": "0034345456",
"account_name": "AKINRINADE SAMUEL",
"narration": "Bank Transfer To Kenya",
"domain": "live",
"status": "success",
"updated_at": "2022-03-29T02:51:01.000000Z",
"created_at": "2022-03-29T02:51:01.000000Z"
}
}