Introduction
This is the gateway of the Valuetopup system that allows other hosts to connect to it and perform transactions. This API is based on REST principles and uses JSON as the format for data interchange.
Authentication
Each call to the API is authenticated via UserId and Password. Authentication to the API is performed by HTTP Basic Authentication. Prepay Nation will provide a user id and password.
Response Model Structure
If the Valuetopup API returns a response with HTTP status code 200, the response will be provided in the following format:
Environment
To facilitate integration and testing, two environments are provided:
Timeout Mitigation
An exceptional scenario might occur where a transaction does not return a response within your system timeout duration.
Test Simulation for Sandbox
Use these scenarios to test your integration's behavior in the sandbox environment.
Versioning & Localization
Versioning
Transaction Flow
The sequence below shows the standard integration flow — from fetching the catalog through to confirming a transaction outcome, including the timeout recovery path.
Go Live Checklist
Complete every item before switching to the production environment. Production transactions will charge your account.
Best Practices
Follow these recommendations for a reliable, safe integration.