PEpeachpayments
Transactions recon

List 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.

get/api/merchants/{merchantId}/transactions-recon

Request

  • Base URL
    https://sandbox-reconciliation.ppay.io
  • URL
    https://sandbox-reconciliation.ppay.io/api/merchants/{merchantId}/transactions-recon
  • Auth
    HTTP bearer

Path parameters

merchantIdstring required
Example:d0bf5a6a909111f0aabf02d14af18cff

The merchant's identifier.

Query parameters

startDatestring date-time required

ISO-8601 timestamp for the start of the date range in the request. If no timezone can be inferred from the timestamp, UTC+2 will be assumed. If no time (i.e. the T00:00:00.000Z part) is included, the beginning of that calendar day will be assumed. For example, startDate=2024-03-14 will be changed to startDate=2024-03-13T22:00:00.000Z

Example:2024-03-14T22:00:00.000Z

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.

endDatestring date-time required

ISO-8601 timestamp for the end of the date range in the request. If no timezone can be inferred from the timestamp, UTC+2 will be assumed. If no time (i.e. the T00:00:00.000Z part) is included, the end of that calendar day will be assumed. For example, endDate=2024-03-15 will be changed to endDate=2024-03-15T22:00:00.000Z

Example:2024-03-15T22:00:00.000Z

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.

isSuccessfulboolean

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

paymentMethodstring
Example:card

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

  • bnpl
  • card
  • eft
batchNumberstring
Example:305

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.

settlementReferencestring
Example:PEACH-123-01042025

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-Encodingstring
Example:gzip

Enables gzip compression for the response payload.

Response

A list of transactions.

merchantIdstring required
merchantNamestring required

The merchant's name.

channelNamestring required

The channel's name.

channelIdstring required
merchantUsnstring required

The merchant's unique serial number.

batchNumberstring required
uniqueIdstring required
transactionIdstring required
customerNamestring required

The customer's name.

accountHolderstring required

The account holder.

last4string required

Last 4 digits of the card number.

binstring required

Bank identification number. First 6 numbers on the card. Identifies the institution that issued the card.

expiryMonthstring required

Calendar month when the card is expiring.

expiryYearstring required

Calendar year when the card is expiring.

paymentType'DB' | 'RG' | 'PA' | 'RF' | 'CP' | 'RV' | 'CD' | 'RB' required
paymentMethodstring required

The payment method.

brandstring required

The payment brand.

cardTypestring required

The card type.

currencystring required

The transaction's currency.

createdAtstring date-time required

The time the transaction was created.

updatedAtstring date-time required

The time the transaction was updated.

issuerstring required

The issuer.

creditnumber required

This is the absolute value of the transaction amount if the amount is negative, otherwise 0.

debitnumber required

This is the transaction amount if the amount is positive, otherwise 0.

amountnumber

The total transaction amount.

If a tip is included, this value is inclusive of tipAmount.

For direct-settled accounts, utilise this field for reconciliation instead of settledAmount.

tipAmountnumber

The tip portion included within the total amount. Returns null if no tip was given.

settledAmountnumber required

The final settled amount after back-office processing is completed.

This field is applicable to Peach-settled accounts only.

settlementStatusstring required

The settlement status. Relevant for Peach-settled accounts only.

settlementReferencestring required

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.

peachResult'successful' | 'failed' | 'cancelled' | 'pending' required

The Peach Payments result.

bankResult'successful' | 'missing' required

The bank's result.

reconResultstring required

The reconciliation result.

rrnstring required

The retrieval reference number.

Example response

[
  {
    "merchantId": "d0bf5a6a909111f0aabf02d14af18cff",
    "merchantName": "Treadstone",
    "channelName": "JB01 Nedbank 3DS",
    "channelId": "d0bf5a6a909111f0aabf02d14af18cff",
    "merchantUsn": "2909330",
    "batchNumber": "305",
    "uniqueId": "d0bf5a6a909111f0aabf02d14af18cff",
    "transactionId": "d0bf5a6a909111f0aabf02d14af18cff",
    "customerName": "Jason Bourne",
    "accountHolder": "M.H. Kreutz",
    "last4": "4685",
    "bin": "484795",
    "expiryMonth": "06",
    "expiryYear": "2026",
    "paymentType": "DB",
    "paymentMethod": "card",
    "brand": "master",
    "cardType": "credit",
    "currency": "ZAR",
    "createdAt": "2024-03-14T01:41:59.265Z",
    "updatedAt": "2024-03-15T04:34:59.265Z",
    "issuer": "Standard Bank",
    "settlementStatus": "settled",
    "settlementReference": "PEACH-101-14102024",
    "peachResult": "successful",
    "bankResult": "successful",
    "reconResult": "successful",
    "rrn": "106540760250"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.