API integration overview
How integration with A1 Top Up Services usually works: access, sandbox, requests, statuses, callbacks and going live.
This page gives an overview of how integration usually works. The full technical documentation, endpoints and credentials are shared with you when your API access request is approved.
The integration path
- Request access. Tell us about your business on the API access page.
- Receive sandbox details. Test recharge and status requests without moving real money.
- Build the calls. Recharge or bill payment request, balance check, status check and callback handler.
- Handle every status. Success, failed and pending are all normal outcomes.
- Go live small. Start with limited volume and grow as your results are stable.
Requests and responses
Requests are JSON over HTTPS. Every request carries your credentials and your own unique order ID. Every response returns a status and a reference you can store.
Callbacks
Provide a secure callback URL and we notify it when a transaction reaches a final status. Your system should also be able to check the status of an old transaction by reference, in case a callback is missed.
Before you go live
- Confirm which services and operators are enabled on your account.
- Test success, failed and pending outcomes.
- Make sure duplicate callbacks do not create duplicate results.
- Agree the support contacts for your launch.
Frequently asked questions
How do I get API access?
Is there a sandbox for testing?
A sandbox is provided during onboarding so your developers can test requests, responses and callbacks before going live. Ask for sandbox access when you request API access.
Ready to add recharge to your business?
Tell us what you want to offer. We reply with the next steps and details about sandbox access.