Skip to main content

Get Payment Status

If the response to a PAY request was unavailable (network disconnection, timeout, etc.) or if you want to check the status of a previous payment, send a new payment request with the Status action and the reference of the original payment.

warning

If the payment status is still BeingProcessed, continue checking until a final status is determined:

  • First inquiry: 120 seconds after timeout/pending response
  • Subsequent inquiries: 180 seconds after previous inquiry

Sample Status Request​

// POST /api/payment/process
{
  "Reference": "08be48c6-2624-4a06-95eb-be79ff5d6ef5",
  "Action": "STATUS"
}

Sample Status Response​

{
  "Action": "Status",
  "BillerCode": "COB",
  "Reference": "08be48c6-2624-4a06-95eb-be79ff5d6ef5",
  "MemberNumber": "ABC123",
  "Products": [
    {
      "Quantity": 1,
      "Code": "USD",
      "Name": "USD Bill Payment",
      "Price": 100,
      "RequiresForexPayment": true
    }
  ],
  "TotalAmount": 100,
  "Status": "Paid",
  "MemberName": "Bulawayo Guy",
  "BillerPaymentReference": "0740000022",
  "BillPayReference": "COB-211129114124239",
  "AuthData": {
    "MemberName": "Bulawayo Guy",
    "AccountDetails": {
      "Favourite Burger": "Macdonalds"
    }
  },
  "Currency": "USD"
}