WebsiteStatusSupportPostman workspacePricingDocumentation hub survey
API reference
RSS feedSign up

List payout requests

get
https://sandbox-payouts.peachpayments.com/api/merchants//payouts

See all your payouts and payout requests.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 32 and 32

A unique merchant ID provided by Peach Payments.

Query Params
string
required

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

string
required

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

string

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

status
array of objects

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

status
bankName
array of objects

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

bankName
type
array of objects

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

type
string
enum

Order the results by date providing date_asc or date_desc.

Allowed:
Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago