Payouts
Query payout request
Query the status of the payouts within the request.
For more information, see the documentation, and for sample calls, see the public Postman collection.
get/merchants/{merchantId}/payouts/{payoutRequestId}/status
Path parameters
merchantIdstring required
A unique merchant ID provided by Peach Payments in hexadecimal format.
Example:d0bf5a6a909111f0aabf02d14af18cff
A unique merchant ID provided by Peach Payments.
payoutRequestIdstring required
A valid v4 UUID expressed in lowercase with dashes.
Example:6e029f3f-21bf-425d-8f65-4eef2b5d8bb2
A valid Payout Request ID expressed as a v4 UUIDin lowercase with dashes.
Query parameters
order'date_asc' | 'date_desc'
Example:date_asc
Order the results by date providing date_asc or date_desc.
Response
Created or requested.
Example response
{
"payoutRequestId": "6e029f3f-21bf-425d-8f65-4eef2b5d8bb2",
"created": "2024-03-14T22:00:00.000Z",
"payouts": [
{
"bankName": "ABSA",
"accountNumber": "4047594620",
"branchCode": "632005",
"amount": 56712,
"currency": "ZAR",
"accountHolder": "Sibusiso Kumalo",
"reference": "Refund order 74152",
"payoutMethod": "realtime-eft",
"status": "successful",
"payoutId": "84920878-fc32-494f-8e30-6a2465c9a456",
"lastUpdated": "2024-03-14T22:00:00.000Z",
"created": "2024-03-14T22:00:00.000Z",
"resultCode": "2000.000.000",
"payoutPartnerRespondedAt": "2024-03-14T22:10:00.000Z"
},
{
"bankName": "NEDBANK",
"accountNumber": "1006393099",
"branchCode": "210002",
"amount": 78652,
"currency": "ZAR",
"accountHolder": "Thembisile Msibi",
"reference": "Refund order 98767",
"payoutMethod": "realtime-eft",
"status": "failed",
"payoutId": "355f5577-e174-4397-b8f6-ced4a7165217",
"lastUpdated": "2024-03-14T22:00:00.000Z",
"created": "2024-03-14T22:00:00.000Z",
"resultCode": "2001.003.109",
"payoutPartnerRespondedAt": "2024-03-14T22:10:00.000Z",
"error": {
"title": "Invalid input error",
"message": "There is no account associated with the account number you entered. Double-check your input and try again.",
"code": "2001.003.109"
}
}
]
}