For developers

Build essential digital services into your own product.

Use the TopupNaija API to connect supported services to your application while keeping request, response and transaction handling explicit.

Read the documentation Explore API use cases

Infrastructure without hiding the transaction lifecycle

A vending API is not just an endpoint that accepts a request.

Your application needs to know:

  • What it sent
  • Which reference belongs to the transaction
  • What state the transaction is in
  • What response was returned
  • What to do when the outcome is not yet final

TopupNaija's developer experience should make those parts of the transaction lifecycle visible rather than encouraging blind retries.

Start with the documentation

Before going live, review the documentation for:

  • Authentication
  • Supported products
  • Required request fields
  • Response formats
  • Transaction references
  • Status handling
  • Error handling
  • Any callback or asynchronous behaviour documented for the service

Your integration should follow the current documentation rather than relying on assumptions from another provider.

Read API documentation

Treat references as important data

Store the reference returned for each transaction.

A good integration should be able to connect your internal order to the corresponding TopupNaija transaction so you can investigate an issue without guessing which request caused it.

Do not treat every non-success response the same way

A failed transaction, a pending transaction and an unknown result require different handling.

Your application should read documented states carefully before deciding whether to wait, query status, report an error or allow another attempt.

Build for support from the beginning

Useful logs make integration problems much easier to solve.

Keep the non-sensitive information needed to investigate a transaction, including your internal identifier, TopupNaija transaction reference, timestamps and relevant response information.

Never log secrets or expose authentication credentials in customer-facing messages.

Ready to build?

Review the supported services and understand the transaction lifecycle before sending your first production request.

Read API documentation