API Reference
Admin — Transactions
Head-office transaction search. /api/v1/payments is scoped to the calling SBU by its own key, so these routes exist to answer questions across the group — 'which payment failed for this customer', 'what is stuck right now'. Every route needs X-Admin-Key; an SBU key is rejected here.
- GETSearch transactionsEvery payment attempt across all SBUs, newest first. All filters optional.
- GETGet one transactionA single transaction in full, by its order reference.
Search transactions
Every payment attempt across all SBUs, newest first. All filters optional.
GET
Auth: /api/v1/admin/paymentsX-Admin-KeyFilters combine. Omitting from/to defaults to the last 30 days — the same window the reports use.
Query parameters
| Field | Type | Description |
|---|---|---|
| sbuCode | string | Restrict to one SBU, e.g. TAPANDGO. |
| status | string | PENDING, AWAITING_CONFIRMATION, PAID, FAILED, CANCELED or UNKNOWN. |
| method | string | ECOCASH, CARD, ZIMSWITCH, INNBUCKS, OMARI, SMILECASH, WALLETPLUS, ONEMONEY or HOSTED. |
| from | date | Inclusive start, YYYY-MM-DD. Defaults to 30 days ago. |
| to | date | Inclusive end day, YYYY-MM-DD. Defaults to today. |
| q | string | Free text matched against order reference, SBU reference, gateway reference, and customer name, phone and email. |
| page | integer | Zero-based page index. Default 0. |
| size | integer | Page size, capped at 200. Default 25. |
Request
curl 'https://13-247-53-102.sslip.io/api/v1/admin/payments?sbuCode=TAPANDGO&status=FAILED&from=2026-08-01' \
-H 'X-Admin-Key: your_admin_key'Response
| Field | Type | Description |
|---|---|---|
| content | Transaction[] | The page of transactions, each naming its sbuCode and sbuName. |
| totalElements | integer | Total transactions matching the filters. |
| totalPages | integer | Total number of pages. |
| number | integer | Current zero-based page index. |
- Unlike /api/v1/payments, the rows here name the owning SBU and carry the customer's contact details.
Get one transaction
A single transaction in full, by its order reference.
GET
Auth: /api/v1/admin/payments/{orderReference}X-Admin-KeyPath parameters
| Field | Type | Description |
|---|---|---|
| orderReference | string | e.g. TAPANDGO-3FD0A655EB7A4AE7. |
Request
curl https://13-247-53-102.sslip.io/api/v1/admin/payments/TAPANDGO-3FD0A655EB7A4AE7 \
-H 'X-Admin-Key: your_admin_key'