Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Payouts

List payout requests

See all your payouts and payout requests.

For more information, see the documentation, and for sample calls, see the public Postman collection.

get/merchants/{merchantId}/payouts

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.

Query parameters

startDatestring required
Example:2024-01-14T22:00:00+02:00

Return results from the inclusive start date (window less than three months). Please use ISO 8601 date format.

endDatestring required
Example:2024-03-14T22:00:00+02:00

Return results from the inclusive end date (window less than three months). Please use ISO 8601 date format.

searchstring
Example:INV-123

Filter results by payout reference or account holder name (case-insensitive partial match).

statusPayoutState[]

Filter results by one or more payout statuses by repeating the query parameter, for example ?status=failed&status=successful.

[
  "failed",
  "successful"
]
bankNameBankName[]

Filter results by one or more bank names by repeating the query parameter, for example ?bankName=ABSA&bankName=NEDBANK.

[
  "ABSA",
  "NEDBANK"
]
typePayoutMethod[]

Filter results by one or more payout methods by repeating the query parameter, for example ?type=realtime-eft&type=realtime-eft.

[
  "realtime-eft"
]
order'date_asc' | 'date_desc'
Example:date_asc

Order the results by date providing date_asc or date_desc.

Response

A list of all payout requests in the date range provided.

Example response

{
  "requests": [
    {
      "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",
          "missingCreditQueryStatus": "queried"
        },
        {
          "bankName": "NEDBANK",
          "accountNumber": "1006393099",
          "branchCode": "210002",
          "amount": 56712,
          "currency": "ZAR",
          "accountHolder": "Duduzile Masha",
          "reference": "Payment 27656",
          "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.002.108",
          "missingCreditQueryStatus": "failed",
          "error": {
            "title": "Payout processing error",
            "message": "The recipient's account cannot receive funds right now. Please ask the recipient to check with their bank.",
            "code": "2001.002.108"
          }
        }
      ]
    }
  ]
}