Disbursement/Payout
Step 1 - Initiate
This API method is used to initiate an a disbursement/payout request for which you will receive a JSON response.
POST
{base url}/api/v1/payouts/
Headers
Name
Type
Description
Authorization*
Bearer {{secret key}}
Content-Type*
String
application/json
{
"client": {
"email": "[email protected]",
"phone": "751123456"
},
"payment": {
"currency": "UGX",
"amount": "500",
"description": "Test Payout Airtel"
},
"reference": "Your unique transaction reference",
"brand_id": "{{BrandId}}"
}
Step 2 - Execute
Using the transaction ID received in Step 1, this method is then queried by sending a json request to execute payout.
POST
{base url}/po/{id}/{network}/
Headers
Name
Type
Description
Content-Type*
String
application/json
{
"phone":"751123456"
}
Check Disbursement/Payout Status
This API method is used to query the payouts/disbursement transaction status using the transaction ID.
GET
{base url}/api/v1/payouts/{id}/
Headers
Name
Type
Description
Content-Type*
String
application/js
Authorization*
String
Bearer {{secret key}}
Last updated