| Developer API Documentation

TopupNaija API Reference

Executable reference for the authenticated USER API.

API Authentication

The USER API uses JWT bearer authentication:

1

JWT Bearer Token

Acquired dynamically by submitting credential parameters to the /api/v1/auth/login endpoint. Pass this token inside the standard header wrapper for all authorized operations:

Authorization: Bearer <your_jwt_token>

Surfaces & Availability

Use the current API origin for the executable USER routes. Local tests use mocks and disposable infrastructure; that does not establish a public sandbox product.

Surface Contract Current availability
USER API /docs/swagger.json JWT-authenticated executable routes at the current API origin

Expected Error Response Codes

Verify that your error parsers accommodate the following standard API response codes:

  • 401 Unauthorized: The provided JWT token has expired or is invalid.
  • 403 Forbidden: The authenticated principal or account is not eligible for the operation.
  • 409 Conflict: An operation with a duplicate Idempotency-Key was submitted while the original execution is still processing.
  • 429 Too Many Requests: The configured request limit has been exceeded.

Interactive API Reference

Loading interactive API documentation...