API Reference
Reports
With X-Admin-Key the whole group is visible (optionally narrowed with ?sbuCode=); with an X-SBU-Key results are always scoped to that SBU. All three accept the same date filters and default to the last 30 days.
- GETReceived by SBUAmounts received per SBU per currency — paid transactions only.
- GETUsage by methodAttempts, successes and totals per payment method — most used first.
- GETSummaryTotals, most-used method and both breakdowns in one call — built for dashboards.
Received by SBU
Amounts received per SBU per currency — paid transactions only.
GET
Auth: /api/v1/reports/by-sbuX-SBU-Key or X-Admin-KeyQuery parameters
| Field | Type | Description |
|---|---|---|
| from | date | Inclusive start (YYYY-MM-DD, UTC). Default: 30 days ago. |
| to | date | Inclusive end (YYYY-MM-DD, UTC). Default: today. |
| sbuCode | string | Admin only — narrow to one SBU. |
Request
curl 'https://13-247-53-102.sslip.io/api/v1/reports/by-sbu?from=2026-07-01&to=2026-07-31' \
-H 'X-Admin-Key: your_admin_key'Response
| Field | Type | Description |
|---|---|---|
| sbuCode / sbuName | string | The SBU the row belongs to. |
| currencyCode | string | "840" = USD, "924" = ZWG. |
| paidCount | integer | Number of paid transactions. |
| totalReceived | number | Sum received in that currency. |
Usage by method
Attempts, successes and totals per payment method — most used first.
GET
Auth: /api/v1/reports/by-methodX-SBU-Key or X-Admin-KeyQuery parameters
| Field | Type | Description |
|---|---|---|
| from | date | Inclusive start (YYYY-MM-DD, UTC). Default: 30 days ago. |
| to | date | Inclusive end (YYYY-MM-DD, UTC). Default: today. |
| sbuCode | string | Admin only — narrow to one SBU. |
Request
curl 'https://13-247-53-102.sslip.io/api/v1/reports/by-method' \
-H 'X-SBU-Key: sbu_your_key_here'Response
| Field | Type | Description |
|---|---|---|
| method | enum | The payment method. |
| currencyCode | string | Currency of the row. |
| attempts | integer | Transactions initiated with this method. |
| paidCount | integer | How many of those were paid. |
| totalReceived | number | Amount received through this method. |
Summary
Totals, most-used method and both breakdowns in one call — built for dashboards.
GET
Auth: /api/v1/reports/summaryX-SBU-Key or X-Admin-KeyQuery parameters
| Field | Type | Description |
|---|---|---|
| from | date | Inclusive start (YYYY-MM-DD, UTC). Default: 30 days ago. |
| to | date | Inclusive end (YYYY-MM-DD, UTC). Default: today. |
| sbuCode | string | Admin only — narrow to one SBU. |
Request
curl 'https://13-247-53-102.sslip.io/api/v1/reports/summary?from=2026-07-01' \
-H 'X-Admin-Key: your_admin_key'Response
| Field | Type | Description |
|---|---|---|
| from / to | string | The resolved reporting window. |
| totalReceivedByCurrency | object | Totals keyed by currency, e.g. { "840": 40.50 }. |
| mostUsedMethod | enum | Method with the most attempts, or null. |
| bySbu | array | Same rows as /reports/by-sbu. |
| byMethod | array | Same rows as /reports/by-method. |
- Also returns byStatus (counts and value per status), daily (a gap-filled per-day series), attempts, paidCount, failedCount, pendingCount, pendingValueByCurrency, failureRate (share of *settled* attempts that failed, null when nothing has settled) and stuckCount (non-terminal for over 30 minutes).