Do not call this API directly after create a payout request, please put 10 minutes buffer so we can ensure we give the final status.
Get details of a single payout.
{
"amount": "200000.00",
"beneficiary_name": "Ryan Renolds",
"beneficiary_account": "33287352",
"bank": "Bank Central Asia ( BCA )",
"reference_no": "83hgf882",
"notes": "Payout June 17",
"beneficiary_email": "[email protected]",
"status": "queued",
"created_by": "John Doe",
"created_at": "2017-01-11T00:00:00Z",
"updated_at": "2017-01-11T00:00:00Z"
}
HTTP Request
GET BASE_URL/api/v1/payouts/reference_no
Response Params
| Parameter | Description |
|---|---|
| amount | Amount of the processed payout |
| beneficiary_name | Name of the Beneficiary |
| beneficiary_account | Account number of the Beneficiary |
| bank | Bank name used by the Beneficiary |
| reference_no | Unique reference_no of a payout |
| notes | Note added to a payout |
| status | queued : payout is waiting to be executed |
processed : payout request is sent to the bank and completed | |
completed : payout request is sent to the bank and received by beneficiary account | |
failed : payout didn't go through | |
| beneficiary_email | Email of beneficiary (only present if email is added during payout create) |
| created_by | Payout created by the maker |
| created_at | Payout creation date in ISO8601 format |
| updated_at | Payout updation date in ISO8601 format |