---
title: "Query a transaction by merchantTransactionId"
method: GET
path: "/payments"
tags: ["Status"]
---

# Query a transaction by merchantTransactionId

`GET /payments`

Query the status of a transaction using the merchantTransactionId. Could return multiple results.

You can send two transaction status requests per minute per transaction.

For more information, see the [documentation](https://developer.peachpayments.com/docs/payments-api-flows#transaction-status-flow), and for sample calls, see our [public Postman collection](https://www.postman.com/peachpayments/peach-payments-public-workspace/request/22k36iv/payments-public?action=share&creator=20323380&ctx=documentation&active-environment=13324425-9345d747-fcdd-4a5c-83e4-6f637771b28b).

## Query parameters

- `authentication.userId` string, required — Authentication userId.
- `authentication.password` string, required — Authentication password.
- `authentication.entityId` string, required — Authentication entityId
- `merchantTransactionId` string, required — Merchant-provided reference number, often used for reconciliation.

## Response `200`

OK.

- MerchantTransactionIdStatusResponse — The response for the status request using merchantTransactionId as the query field.
  - `result` Result, required — The result object.
    - `code` string, required — The unique code that indicates the result status of the request.
    - `description` string, required
  - `timestamp` string, date-time, required — The timestamp of the transaction.
  - `payments` object[], required
    - `id` string, required — The unique transaction ID provided by Peach Payments.
    - `paymentType` 'DB' | 'RF', required — Payment type of the transaction. See the [payment methods documentation](https://developer.peachpayments.com/docs/pp-payment-methods#south-africa) for details on which payment methods support the RF payment type.
    - `paymentBrand` 'PAYFLEX' | 'ZEROPAY' | '1FORYOU' | 'MASTERPASS' | 'MPESA' | 'BLINKBYEMTEL' | 'MOBICRED' | 'CAPITECPAY' | 'PEACHEFT' | 'MCBJUICE' | 'RCS' | 'FLOAT' | 'HAPPYPAY' | 'MAUCAS' | 'MONEYBADGER' | 'PAYSHAP' | 'NEDBANKDIRECTEFT', required — The payment brand specifies the method of payment for the request.
    - `amount` string, required — The payment request amount.
    - `currency` string, iso-4217, required — The currency code of the payment request amount as defined by ISO-4217.
    - `merchantTransactionId` string, required — Merchant-provided reference number, often used for reconciliation.
    - `result` Result, required — The result object.
      - `code` string, required — The unique code that indicates the result status of the request.
      - `description` string, required
    - `resultDetails` ResultDetails, required — Additional details that can provide information about the status or result of the transaction.
      - `ExtendedDescription` string
      - `AcquirerResponse` string
      - `UserDisplayMessage` string
    - `connectorTxID1` string, required — The unique transaction identifier provided by the payment service provider.
    - `timestamp` string, date-time, required — The timestamp of the transaction.
    - `customParameters` CustomParameters, required — A JSON object depicting custom information sent by the merchant. Echoed back in the response.
    - `card` ResponseCard — The card data structure holds information regarding a credit or debit card account.
      - `bin` string — The first six digits of the card number.
      - `last4Digits` string — The last four digits of the card number.
      - `holder` string — The card account holder.
      - `expiryMonth` string — The expiry month of the card.
      - `expiryYear` string — The expiry year of the card.
    - `merchantInvoiceId` string — The merchant's invoice ID.
    - `recon` Recon — Transaction reconciliation data.
      - `ciMerchantNumber` string — The payment service provider merchant number.
      - `rrn` string — The reconciliation reference number from the payment service provider.
      - `authCode` string — The authorisation code from the payment service provider.
      - `resultCode` string — The result code from the payment service provider.
      - `stan` string — The STAN reference number from the payment service provider.

## Other responses

- `400` — Bad request.
- `401` — Unauthorised.
- `404` — Not found.
- `500` — Internal server error.

---

[API](https://skmtc.net/peachpayments/apis/checkout.md) · [All operations](https://skmtc.net/peachpayments/apis/checkout/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peachpayments/checkout/revisions/3a98165665f8/schema)