Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
V1

Query checkout status

Get the status of a checkout. To determine the status of the checkout, use the result.code and result.description fields in the response. For the full list of possible codes, see Result codes. For more information, see the documentation, and for sample calls, see the public Postman collection.

get/status

Query parameters

authentication.entityIdstring required
Example:8ac7a4ca68c22c4d0168c2caab2e0025

Merchant's entity ID.

checkoutIdstring
Example:948cc8dec52a11eb85290242ac130003

Unique identifier for the checkout session to query status for.

merchantTransactionIdstring
Example:OrderNo453432

Merchant's unique identifier for the transaction to query status for.

signaturestring required
Example:a668342244a9c77b08a2f9090d033d6e2610b431a5c0ca975f32035ed06164f4

Signature of data signed with secret key of merchant.

Response

Successfully retrieved the checkout status information.

amountstring ^[0-9]{1,8}(\\.[0-9]{2})?$

The checkout amount.

card.binstring

The first 6 digits of the card number (Bank Identification Number).

card.expiryMonthstring

The expiry month of the card.

card.expiryYearstring

The expiry year of the card.

card.holderstring

The name of the card holder.

card.last4Digitsstring

The last 4 digits of the card number.

checkoutIdstring

The unique identifier for the checkout instance.

currency'ZAR' | 'USD' | 'KES' | 'MUR' | 'GBP' | 'EUR'

The currency code of the payment request amount.

customer.givenNamestring

The customer's first name or given name (optional, may not be present in all responses).

customer.surnamestring

The customer's last name or surname (optional, may not be present in all responses).

idstring

The unique transaction identifier.

merchant.namestring

The name of the merchant.

merchantTransactionIdstring

Merchant-provided reference number unique for your transactions.

paymentBrand'VISA' | 'MASTERCARD' | 'DINERS CLUB' | 'AMERICAN EXPRESS' | 'MASTERPASS' | 'MOBICRED' | 'MPESA' | '1FORYOU' | 'APLUS' | 'PAYPAL' | 'ZEROPAY' | 'PAYFLEX' | 'BLINKBYEMTEL' | 'CAPITECPAY' | 'PAYBYBANK' | 'MCBJUICE' | 'RCS' | 'FLOAT' | 'HAPPYPAY' | 'APPLE PAY' | 'GOOGLEPAY' | 'SAMSUNGPAY' | 'MAUCAS' | 'MONEYBADGER' | 'PAYSHAP' | 'NEDBANKDIRECTEFT' | 'ABSAEFT'

The payment method brand used for the transaction.

paymentType'DB' | 'PA'

The payment type for the request.

result.codestring

A code representing the transaction result.

result.descriptionstring

A human-readable description of the transaction result.

resultDetails.AcquirerResponsestring

The response code from the acquiring bank.

resultDetails.MerchantAdviceCodestring

Merchant Advice Code (MAC) indicating retry strategy for failed transactions. Common values are 01 (new account information available), 02 (cannot approve at this time), 03 (re-initiate transaction), 04 (do not try again).

schemeTransactionIdstring

Scheme-level transaction identifier for tracking and reconciliation.

cardholderInitiatedTransactionIdstring

Cardholder-initiated transaction identifier for tracking and reconciliation.

signaturestring

Token to verify the integrity of the response.

timestampstring date-time

Date and time when the transaction was processed.

Example response

{
  "amount": "10.00",
  "card.bin": "411111",
  "card.expiryMonth": "10",
  "card.expiryYear": "2025",
  "card.holder": "test",
  "card.last4Digits": "1111",
  "checkoutId": "d5f6efe0841a413796c2d5d116735f06",
  "currency": "ZAR",
  "customer.givenName": "test",
  "customer.surname": "test",
  "id": "8ac7a4a092735249019275f3a111762c",
  "merchant.name": "SB Peach",
  "merchantTransactionId": "20241010122105",
  "paymentBrand": "VISA",
  "paymentType": "DB",
  "result.code": "000.100.110",
  "result.description": "Request successfully processed in 'Merchant in Integrator Test Mode'",
  "resultDetails.AcquirerResponse": "0",
  "resultDetails.MerchantAdviceCode": "02",
  "schemeTransactionId": "ABCDEF1234567",
  "cardholderInitiatedTransactionId": "123456789012345",
  "signature": "a18e39ea1a74ee1ea117defa5a75a54fe8562af941d1a76d8b9f5a91f379483b",
  "timestamp": "2024-10-10T10:22:38Z"
}