---
title: "List transactions-recon"
method: GET
path: "/api/merchants/{merchantId}/transactions-recon"
tags: ["Transactions recon"]
---

# List transactions-recon

`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

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](https://developer.peachpayments.com/docs/bus-ops-recon-api#/list-transactions-reconciliation-flow), and for sample calls, see the [public Postman collection](https://www.postman.com/peachpayments/peach-payments-public-workspace/request/knra3bn/recon-public?action=share&creator=20323380&ctx=documentation&active-environment=13324425-4d2ac6d5-12c6-4386-b5a9-605d38682519).

## Path parameters

- `merchantId` string, required

## Query parameters

- `startDate` string, 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`
- `endDate` string, 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`
- `isSuccessful` boolean
- `paymentMethod` string
- `batchNumber` string
- `settlementReference` string

## Headers

- `Accept-Encoding` string

## Response `200`

A list of transactions.

- object[]
  - `merchantId` string, required
  - `merchantName` string, required: The merchant's name.
  - `channelName` string, required: The channel's name.
  - `channelId` string, required
  - `merchantUsn` string, required: The merchant's unique serial number.
  - `batchNumber` string, required
  - `uniqueId` string, required
  - `transactionId` string, required
  - `customerName` string, required: The customer's name.
  - `accountHolder` string, required: The account holder.
  - `last4` string, required: Last 4 digits of the card number.
  - `bin` string, required: Bank identification number. First 6 numbers on the card. Identifies the institution that issued the card.
  - `expiryMonth` string, required: Calendar month when the card is expiring.
  - `expiryYear` string, required: Calendar year when the card is expiring.
  - `paymentType` 'DB' | 'RG' | 'PA' | 'RF' | 'CP' | 'RV' | 'CD' | 'RB', required
  - `paymentMethod` string, required: The payment method.
  - `brand` string, required: The payment brand.
  - `cardType` string, required: The card type.
  - `currency` string, required: The transaction's currency.
  - `createdAt` string, date-time, required: The time the transaction was created.
  - `updatedAt` string, date-time, required: The time the transaction was updated.
  - `issuer` string, required: The issuer.
  - `credit` number, required: This is the absolute value of the transaction amount if the amount is negative, otherwise 0.
  - `debit` number, required: This is the transaction amount if the amount is positive, otherwise 0.
  - `amount` number: 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`.
  - `tipAmount` number: The tip portion included within the total `amount`. Returns `null` if no tip was given.
  - `settledAmount` number, required: The final settled amount after back-office processing is completed. This field is applicable to Peach-settled accounts only.
  - `settlementStatus` string, required: The settlement status. Relevant for Peach-settled accounts only.
  - `settlementReference` string, 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.
  - `reconResult` string, required: The reconciliation result.
  - `rrn` string, required: The retrieval reference number.

## Other responses

- `400`: An object containing the error message string.
- `401`: An object containing the error message string.
- `403`: An object containing the error message string.
- `500`: An object containing the error message string.

---

[API](https://skmtc.dev/peachpayments/apis/reconciliation.md) - [All operations](https://skmtc.dev/peachpayments/apis/reconciliation/llms.txt) - [OpenAPI document](https://skmtc.dev/peachpayments/apis/reconciliation/revisions/588046311417?raw)
