Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Status

Query a transaction by transaction ID

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, and for sample calls, see our public Postman collection.

get/payments/{uniqueId}

Path parameters

uniqueIdstring required

The unique transaction ID provided by Peach Payments.

Example:41a57893d4a44191be8cd410398464e6

The Peach Payments unique ID for the transaction.

Query parameters

authentication.entityIdstring required

Authentication entityId

Example:8ac7a4c894809722019482d1df62029d

Authentication entityId.

authentication.userIdstring required

Authentication userId.

Example:5fb5e392d6fa11ef9b3002f694e28f55

Authentication userId.

authentication.passwordstring required

Authentication password.

Example:OMydSc7ewVmEKPZCAj2WxHoik

Authentication password.

Response

OK.

idstring required

The unique transaction ID provided by Peach Payments.

merchantTransactionIdstring required

Merchant-provided reference number, often used for reconciliation.

amountstring required

The payment request amount.

currencystring 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' | 'NEDBANKDIRECTEFT' 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 for details on which payment methods support the RF payment type.

connectorTxID1string required

The unique transaction identifier provided by the payment service provider.

timestampstring date-time required

The timestamp of the transaction.

customParametersCustomParameters required

A JSON object depicting custom information sent by the merchant. Echoed back in the response.

merchantInvoiceIdstring

The merchant's invoice ID.

Example response

{
  "id": "41a57893d4a44191be8cd410398464e6",
  "merchantTransactionId": "test12345",
  "amount": "22.50",
  "currency": "ZAR",
  "paymentBrand": "PEACHEFT",
  "paymentType": "DB",
  "result": {
    "code": "800.100.152",
    "description": "Request successfully processed."
  },
  "resultDetails": {
    "ExtendedDescription": "Purchase Approved OK",
    "AcquirerResponse": "Approved",
    "UserDisplayMessage": "Message 16 - Your session was created."
  },
  "connectorTxID1": "8ac7a49f7921f2fd0179230196ec4bbe",
  "timestamp": "2021-04-23T07:41:25.519947Z",
  "merchantInvoiceId": "20170630407200",
  "bank": {
    "holder": "Jane Doe",
    "bankName": "Bank A",
    "iban": "MU43BOMM0101123456789101000MUR",
    "bic": "WFBIUS6SELP",
    "country": "ZA",
    "mandate": {
      "dateOfSignature": "2016-08-07",
      "id": "idreference123456789012345678901234",
      "reference": "idreference123456789012345678901"
    },
    "transactionDueDate": "2022-11-11"
  },
  "card": {
    "bin": "455112",
    "last4Digits": "2315",
    "holder": "Jane Doe",
    "expiryMonth": "01",
    "expiryYear": "2030"
  },
  "recon": {
    "ciMerchantNumber": "123456789012345",
    "rrn": "123456789012",
    "authCode": "123456",
    "stan": "123456"
  }
}