API Reference
Verify payment
Check transaction status and sync local state.
GET /api/payments/verify/{transactionReference}Access : Public
Operator use case
After payment start, poll every 5 seconds until final status.
Parameters
- transactionReference (path, required)
The parameter may be the merchant reference returned by guest purchase or a transaction reference understood by the payment provider.
Response body
{
"message": "Payment status successfully verified",
"status": "complete",
"transactionId": "GR-TX-XXXXXXXXXX",
"targetType": "payment"
}| Attribute | Type | Description |
|---|---|---|
message | string | Verification result. |
status | string | Transaction state: pending, processing, complete, failed, canceled, expired, abandoned, or refunded. |
transactionId | string | Returned transaction reference. |
targetType | string | Synchronized target type, usually payment. |
The portal may poll every 5 seconds until a final state is returned. A finalized transaction is not reopened by this endpoint.
Status codes
- 200 OK
- 404 Not Found