Payments

List payments

GET/paymentsneedspayments:read

Newest first, paged by cursor.

Needs the payments:read permission.

Query parameters

limitinteger, 1 to 50, default 25

Results per page, 1 to 50

Example:25

cursorstring

The nextCursor from the previous page

Example:"1761818400000_vch_Zx81kQ0pLm"

statusone of pending, success, failed

Only payments in this state

Example:"success"

fromstring

Paid on or after: an ISO 8601 date or time, inclusive

Example:"2026-10-01"

tostring

Paid on or before: an ISO 8601 date or time, inclusive

Example:"2026-10-01"

Response

data: List of Payment, with nextCursor

referencestring

The payment reference

Example:"hs_1761818400000_0123456789abcdef"

statusone of pending, success, failed

Example:"success"

amountKobointeger

What the customer paid, in kobo

Example:50750

tenantShareKobointegernullable

The business's share, in kobo; null when the payment provider reported no split

Example:45000

customerUidstring

Example:"u_9fK2mP7qR1"

customerEmailstring

Example:"ada@example.com"

planIdstring

Example:"pln_8Hq2LmZ0aB3c"

planNamestring

Example:"Daily 5GB"

locationIdstring

Example:"loc_3cD4eF5gH6"

voucherIdstringnullable

Example:"vch_Zx81kQ0pLm"

createdAtstringnullable

ISO 8601 time, UTC

Example:"2026-10-30T10:00:00.000Z"

GET/payments
1curl "https://ogawifi.online/api/v1/payments?limit=25" \2  -H "Authorization: Bearer $OGAWIFI_API_KEY"
200Successful response
1{2  "data": [3    {4      "reference": "hs_1761818400000_0123456789abcdef",5      "status": "success",6      "amountKobo": 50750,7      "tenantShareKobo": 45000,8      "customerUid": "u_9fK2mP7qR1",9      "customerEmail": "ada@example.com",10      "planId": "pln_8Hq2LmZ0aB3c",11      "planName": "Daily 5GB",12      "locationId": "loc_3cD4eF5gH6",13      "voucherId": "vch_Zx81kQ0pLm",14      "createdAt": "2026-10-30T10:00:00.000Z"15    }16  ],17  "nextCursor": "1761818400000_vch_Zx81kQ0pLm"18}