API reference

The reference is generated from the API’s own OpenAPI definition, captured from the same build as these pages. It lists every endpoint, parameter, field and response.

API	For	Start with
Payment Processor API	Banks, mobile-money operators, fintechs	Look up a bill or account · Pay a bill
Service Provider API	Councils, utilities, other billers	Publish a bill · Payments feed

The guides explain how the pieces fit together; the reference is the authority on exact field names and types.

Conventions

• JSON field names are camelCase (billNo, paymentDate). Unknown fields in requests are ignored.
• Build your integration to ignore response fields it doesn’t recognise — new fields can appear at any time within v1.
• Enumerations are numbers on the wire ("status": 1), except where a guide shows otherwise.
• Dates and times are ISO 8601. Send times with a UTC offset; UniPay returns them in UTC (…Z).
• Amounts are JSON numbers with up to four decimal places. Parse them as decimals, not floating point.

Interactive explorer

The test environment also has Swagger UI at /swagger/: choose Payment Processor API or Service Provider API from the definitions menu. It may be switched off on production; the reference above is the same for the same build.

To keep a copy of the definition, download it from Swagger UI, or from /swagger/payment-processor/swagger.json and /swagger/service-provider/swagger.json.