{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-vas/vas.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Before you start","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"before-you-start"},"children":["Before you start"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before implementing the Electrum Direct Top-Up Airtime Service, ensure that you have completed the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Discussed your design with Electrum"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Signed off the Electrum Solution Proposal Document detailing your requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Familiarised yourself with the details on this page"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Familiarised yourself with the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/schema"},"children":["Electrum Airtime Service Interface"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Received and familiarised yourself with the Message Field Specification obtained from Electrum"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensured that all connection endpoints have been whitelisted (if applicable)"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"implementing-the-api"},"children":["Implementing the API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/schema"},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/vas/public/airtime-direct-top-up/purchase-trial"},"children":["Purchase trial"]}," – determine whether a proposed product purchase will be successful"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/vas/public/airtime-direct-top-up/purchase"},"children":["Purchase"]}," – purchase a direct top-up airtime product"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Examples of request and response payloads for the different transactions are shown ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/vas/public/airtime-direct-top-up/message-payload-samples"},"children":["here"]},". For the full API specification refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.electrumsoftware.com/openapi/airtime/swagger/schema"},"children":["API documentation"]},". For guidance on how to populate the message fields, refer to the Message Field Specification that can be obtained from Electrum."]}]},"headings":[{"value":"Before you start","id":"before-you-start","depth":1},{"value":"Implementing the API","id":"implementing-the-api","depth":2}],"frontmatter":{"seo":{"title":"Before you start"}},"lastModified":"2026-01-28T10:41:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/vas/public/airtime-direct-top-up/implementing-your-direct-top-up-airtime-solution","userData":{"isAuthenticated":false,"teams":["anonymous"]}}