---
title: "Query a transaction by transaction ID"
method: GET
path: "/payments/{uniqueId}"
tags: ["Status"]
---

# Query a transaction by transaction ID

`GET /payments/{uniqueId}`

## Request

- Base URL: `https://testapi-v2.peachpayments.com`
- URL: `https://testapi-v2.peachpayments.com/payments/{uniqueId}`
- Auth: none declared

Query the status of a transaction using the Peach Payments unique ID.

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/ohxwlp8/payments-public?action=share&creator=20323380&ctx=documentation&active-environment=13324425-9345d747-fcdd-4a5c-83e4-6f637771b28b).

## Path parameters

- `uniqueId` string, required: The unique transaction ID provided by Peach Payments.

## Query parameters

- `authentication.entityId` string, required: Authentication entityId
- `authentication.userId` string, required: Authentication userId.
- `authentication.password` string, required: Authentication password.

## Response `200`

OK.

- TransactionIdStatusResponse: The response for the status request using transactionId as the query field.
  - `id` string, required: The unique transaction ID provided by Peach Payments.
  - `merchantTransactionId` string, required: Merchant-provided reference number, often used for reconciliation.
  - `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.
  - `paymentBrand` 'PAYFLEX' | 'ZEROPAY' | '1FORYOU' | 'MASTERPASS' | 'MPESA' | 'BLINKBYEMTEL' | 'MOBICRED' | 'CAPITECPAY' | 'PEACHEFT' | 'MCBJUICE' | 'RCS' | 'FLOAT' | 'HAPPYPAY' | 'MAUCAS' | 'MONEYBADGER' | 'PAYSHAP', required: The payment brand specifies the method of payment for the request.
  - `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.
  - `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: 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.
  - `merchantInvoiceId` string: The merchant's invoice ID.
  - `bank` Bank: Customer bank account details.
    - `holder` string: The bank account holder.
    - `bankName` string: The name of the bank which holds the account.
    - `number` string: The bank account number.
    - `iban` string: The IBAN (International Bank Account Number) associated with the bank account.
    - `bic` string: The BIC (Bank Identifier Code (SWIFT)) of the bank account.
    - `bankCode` string: The code associated with the bank account.
    - `country` string: The country code of the bank account (ISO 3166-1).
    - `mandate` Mandate: Customer mandate to bank.
      - `dateOfSignature` string: The date the direct debit mandate was signed.
      - `id` string: The ID of the direct debit mandate.
      - `reference` string: The mandate reference for direct debit as a contractual agreement between the creditor and the debtor.
    - `transactionDueDate` string: The due date of the transaction of the direct debit.
  - `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.
  - `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.
- `403`: Forbidden.
- `404`: Not found.
- `500`: Internal server error.

---

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