Before you start
Before implementing the Electrum Direct Top-Up Airtime Service, ensure that you have completed the following:
- Discussed your design with Electrum
- Signed off the Electrum Solution Proposal Document detailing your requirements
- Familiarised yourself with the details on this page
- Familiarised yourself with the Electrum Airtime Service Interface
- Received and familiarised yourself with the Message Field Specification obtained from Electrum
- Ensured that all connection endpoints have been whitelisted (if applicable)
Implementing the API
The Electrum Airtime Service Interface specifies a complete set of operations, resources, and message payload definitions related to prepaid airtime purchases. The Electrum Direct Top-Up Airtime Service requires you to implement a subset of this API in a specific sequence.
The transactions that make up the Electrum Direct Top-Up Airtime Service are listed below. More detailed information about the transactions, and the API calls you will need to implement, can be found on the respective pages.
Purchase trial – determine whether a proposed product purchase will be successful
Purchase – purchase a direct top-up airtime product
Examples of request and response payloads for the different transactions are shown here. For the full API specification refer to the API documentation. For guidance on how to populate the message fields, refer to the Message Field Specification that can be obtained from Electrum.