Payments

Get a payment by its reference

GET/payments/{reference}needspayments:read

Needs the payments:read permission.

Path parameters

referencestringrequired

The payment's reference

Response

data: Payment

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/{reference}
1curl "https://ogawifi.online/api/v1/payments/$PAYMENT_REFERENCE" \2  -H "Authorization: Bearer $OGAWIFI_API_KEY"
200Successful response
1{2  "data": {3    "reference": "hs_1761818400000_0123456789abcdef",4    "status": "success",5    "amountKobo": 50750,6    "tenantShareKobo": 45000,7    "customerUid": "u_9fK2mP7qR1",8    "customerEmail": "ada@example.com",9    "planId": "pln_8Hq2LmZ0aB3c",10    "planName": "Daily 5GB",11    "locationId": "loc_3cD4eF5gH6",12    "voucherId": "vch_Zx81kQ0pLm",13    "createdAt": "2026-10-30T10:00:00.000Z"14  }15}