Order Payment Status

Request

Verifies the payment status of a specific order by checking its associated MPGS payment sessions.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

orderIdstringrequired

The order ID to verify payment status for.

Example:"ORD-20240401-001"

curl -i -X POST \
  https://docs.amabills.co.za/_mock/openapi/v2/whooshCheckOrderPaymentStatus \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "orderId": "ORD-20240401-001"
  }'

Responses

Payment status successfully retrieved.

Bodyapplication/json

successboolean

true when the request was processed successfully.

Example:true

merchantIdstring

Merchant identifier derived from the API key.

Example:"MERCH-001"

orderIdstring

The order ID that was checked.

Example:"ORD-20240401-001"

checkedOnstring, (date-time)

Timestamp when the status verification was performed.

Example:"2024-04-02T06:10:00+02:00"

paymentStatusstring

Overall payment status for the order.

Enum:"PAID""PENDING""FAILED""NO_ATTEMPT""VERIFICATION_ERROR"

Example:"PAID"

paymentReferencestring

Primary transaction reference (same as orderId).

Example:"ORD-20240401-001"

transactionStatusstring

Raw MPGS transaction status.

Example:"SUCCESS"

transactionAmountnumber

Transaction amount.

Example:150

transactionCurrencystring

ISO 4217 currency code.

Example:"ZAR"

transactionTimestring, (date-time)

Timestamp of the transaction.

Example:"2024-04-01T14:32:00+02:00"

verificationErrorsArray of objects(VerificationErrorDto)

Verification errors, if any.

Response

{
  "success": true,
  "merchantId": "MERCH-001",
  "orderId": "ORD-20240401-001",
  "checkedOn": "2024-04-02T06:10:00+02:00",
  "paymentStatus": "PAID",
  "paymentReference": "ORD-20240401-001",
  "transactionStatus": "SUCCESS",
  "transactionAmount": 150,
  "transactionCurrency": "ZAR",
  "transactionTime": "2024-04-01T14:32:00+02:00",
  "verificationErrors": []
}