Get Payment Status by Reference

GET /api/payments/reference/{referenceNo}/status Returns the current status and full details of a payment transaction using the merchant-supplied referenceNo. Use this when you need to look up a transaction without the system-generated transactionId.

If you have the system transactionId, prefer Get Payment Status for a more direct lookup.

Path Parameters

referenceNo

string

required

The merchant-assigned reference number supplied during Initiate Payment.Example: MER-20240616-001

Response

200 — Success

data

object

Show PaymentStatusResponse

transactionId

string

System-generated unique transaction ID.

referenceNo

string

Merchant reference number.

status

string

Current payment status.Common values: PENDING, INITIATED, CONFIRMED, SUCCESSFUL, FAILED

amount

number (decimal)

Payment amount as a decimal value (e.g., 150.00).

productCode

string

Product code associated with the transaction.

createdAt

string (ISO 8601)

UTC timestamp of transaction creation.

lastModifiedAt

string (ISO 8601) | null

UTC timestamp of the most recent status update.

providerReference

string | null

Transaction reference from the downstream payment provider, if available.

message

string | null

Additional status detail or error description.

extraProperties

string | null

Additional status data, serialised as a JSON string.

400 — Bad Request

referenceNo is missing or empty in the request path.

404 — Not Found

No transaction exists for the given referenceNo.

500 — Internal Server Error

Examples

GET /api/payments/reference/MER-20240616-001/status

Get Payment Status

​Path Parameters

​Response

​200 — Success

​400 — Bad Request

​404 — Not Found

​500 — Internal Server Error

​Examples

Path Parameters

Response

200 — Success

400 — Bad Request

404 — Not Found

500 — Internal Server Error

Examples