Appearance
Check status
Permission: payments:read.
| Request | Result |
|---|---|
GET /api/v1/payments/{id} | Current recorded payment |
GET /api/v1/payments/by-reference/{reference} | Recover using your order reference |
POST /api/v1/payments/{id}/verify | Queue an EcoCash status lookup, returning HTTP 202 |
Payment statuses
| Status | Meaning |
|---|---|
queued | Saved and awaiting dispatch |
pending | Submitted and awaiting a verified result |
succeeded | Payment confirmed, with a receipt |
failed | EcoCash reported a failure |
needs_review | Operator review is required |
Fulfil or credit only after a verified success. Handle late success events even if the local order expired. Use a unique financial operation ID so repeated results credit once.
A timeout is an unknown outcome. Keep the order pending and recover the existing reference. Read last_verified_at to see when the last provider lookup completed.
A refund has its own status. The original payment remains succeeded after its funds are returned. Check the refund object to determine whether the payment has been returned.