Payout
Verify Payout
Fetch or Verify Payout
Fetch a payout record using payout reference.
Endpoint: /payout/:reference
Method: GET
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
Sample Post
curl https://api.budpay.com/api/v2/payout/:reference
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET
Sample Response
{
"status": true,
"message": "Payout retrieved",
"data": {
"id": 15,
"reference": "trf_11044f068j1604",
"sessionid": null,
"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",
"subaccount": null,
"created_at": "2022-03-29T01:51:01.000000Z",
"updated_at": "2022-03-29T01:51:01.000000Z"
}
}
List All Transfers/Payout
List the transfers made on your integration/business.
Endpoint: /list_transfers
Method: GET
Header
| Param | Type | Required? | Decription |
|---|---|---|---|
| authorization | string | Yes | Set value to Bearer SECRET_KEY |
Query Param
| Param | Type | Required? | Decription |
|---|---|---|---|
| currency | string | No | Specify the currency of the transfer. |
Sample Post
curl https://api.budpay.com/api/v2/list_transfers
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET
Sample Response
{
"status": true,
"message": "Transfers retrieved",
"data": [
{
"id": 15,
"reference": "trf_11044f068j1604",
"sessionid": null,
"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",
"subaccount": null,
"created_at": "2022-03-29T02:51:01.000000Z",
"updated_at": "2022-03-29T02:51:01.000000Z"
}
]
}