v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Status

Query a transaction by merchantTransactionId

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

get/payments

Query parameters

authentication.userIdstring required

Authentication userId.

Example:5fb5e392d6fa11ef9b3002f694e28f55
authentication.passwordstring required

Authentication password.

Example:OMydSc7ewVmEKPZCAj2WxHoik
authentication.entityIdstring required

Authentication entityId

Example:8ac7a4c894809722019482d1df62029d
merchantTransactionIdstring required

Merchant-provided reference number, often used for reconciliation.

Example:test12345

Response

OK.

timestampstring date-time required

The timestamp of the transaction.

Example response

{
  "result": {
    "code": "800.100.152",
    "description": "Request successfully processed."
  },
  "timestamp": "2021-04-23T07:41:25.519947Z",
  "payments": [
    {
      "id": "41a57893d4a44191be8cd410398464e6",
      "paymentType": "DB",
      "paymentBrand": "PEACHEFT",
      "amount": "22.50",
      "currency": "ZAR",
      "merchantTransactionId": "test12345",
      "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",
      "card": {
        "bin": "455112",
        "last4Digits": "2315",
        "holder": "Jane Doe",
        "expiryMonth": "01",
        "expiryYear": "2030"
      },
      "merchantInvoiceId": "20170630407200",
      "recon": {
        "ciMerchantNumber": "123456789012345",
        "rrn": "123456789012",
        "authCode": "123456",
        "stan": "123456"
      }
    }
  ]
}