List transactions-recon

get

https://sandbox-reconciliation.ppay.io/api/merchants/{merchantId}/transactions-recon

List transactions for a merchant's reconciliation processes.

Rate limit: One request per second
Date limit: Cannot query transactions before 1 January 2023
Date range limit: Cannot query transactions on a date range longer than 24 hours per request
Settlement data delay: For Peach-settled (aggregation) accounts, settlement data can take up to three business days to appear. This delay does not affect direct-settled (ISO) accounts.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

merchantId

string

required

^[0-9a-f]{32}$

The merchant's identifier.

Query Params

startDate

date-time

required

Beginning of the query range (inclusive).
Since this is in the query string, URL-encode the date when specifying a timezone. For example, startDate=2024-01-01T00:00:00.000%2B02:00 for midnight in UTC+2.

endDate

date-time

required

End of the query range (exclusive).
Since this is in the query string, URL-encode the date when specifying a timezone. For example, endDate=2024-01-01T00:00:00.000%2B02:00 for midnight in UTC+2.

isSuccessful

boolean

Whether the transaction was successful or not. If not provided, all transactions are returned.

paymentMethod

string

The payment method used to facilitate the transaction, for example:

bnpl
card
eft

batchNumber

string

length between 1 and 5

^\d{1,5}$

The batch number as sourced from the acquirer markoff file. The recon batch to which a transaction is assigned. Relevant for direct-settled accounts only. Note these can be recycled by acquirers.

settlementReference

string

length ≥ 15

^PEACH-(\d+)-((0[1-9]|[12]\d|3[01])(0[1-9]|1[0-2])\d{4})$

The Peach-generated reference as seen on a merchant's bank statement. Relevant for Peach-settled accounts only. Payment methods are settled in a single batch settlement. Unique per settlement.

Headers

Accept-Encoding

string

Enables gzip compression for the response payload.

Responses

200A list of transactions.

400An object containing the error message string.

401An object containing the error message string.

403An object containing the error message string.

500An object containing the error message string.