Skip to content

Introduction ​

The purpose of this document is to detail the design principles, objects, behaviors and error handling for Teleport's Airtime API. The ultimate goal of this document is to provide a clear and consistent detail for all parties interfacing our Airtime APIs. We hope to achieve this by the implementing the following principles:

Use of REST architectural principles. ​

  • Providing a set of well-defined objects that allows an API client to construct an API message without requiring specific knowledge of the target server implementation.

  • Creation of a standard set of transaction types and other key enumerations, removing the need for developers to map for each and every API implementation.

  • Use of accepted industry standards for objects and interactions representation

  • Use of supplementary metadata and sub-types to enable use case and/or mobile money provider-specific properties to be conveyed where necessary