GSMA Mobile Money API Documentation

GSMA Mobile Money API

The purpose of this site is to detail the design principles, objects, behaviours and error handling for the Mobile Money API.

The overriding goal of the API is to enable all parties to implement mobile money API’s in a flexible, yet consistent manner. This has been achieved by the implementing the following principles:

  • Use of REST architectural principles
  • Providing a set of well-defined objects that are abstracted from the underlying object representations held in the various mobile money systems. This 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 ISO international standards for enumerators such as currency and country codes
  • Use of supplementary metadata and sub-types to enable use case and/or mobile money provider-specific properties to be conveyed where necessary.
  • Recognising that no common mobile money account identifier exists, use of a flexible construct to enable the target account(s) and transaction parties to be identified using one or multiple identifier types.

Quick Start Guide

The quick start guide provides a basic reference point to enable a developer to identify which objects and URI’s to use for their target use cases. Using the selection below you can choose a use case, this will show you the URI format required and also a link to which API is required in the chosen scenario:

URI Format Refer to these sections
/accounts/bills/payments Bill Payments API
URI Format Refer to these sections
/transactions Transactions APIs
URI Format Refer to these sections
/transactions Transactions APIs
URI Format Refer to these sections
/transactions Transactions APIs
URI Format Refer to these sections
/transactions Transactions APIs
URI Format Refer to these sections
/transactions Reversals APIs
URI Format Refer to these sections
/transactions Reversals APIs
URI Format Refer to these sections
/transactions Transactions APIs
URI Format Refer to these sections
/transactions Transactions APIs
URI Format Refer to these sections
/accounts/status Accounts APIs
Accounts Status API
URI Format Refer to these sections
/accounts/balance Accounts APIs
Balance API
URI Format Refer to these sections
/accounts/accountName Accounts APIs
Account Name API
URI Format Refer to these sections
/accounts/statemententries Statement Entries API
URI Format Refer to these sections
/statemententries Statement Entries API
URI Format Refer to these sections
/accounts/bills Bills API
URI Format Refer to these sections
/accounts/debitmandates Debit Mandates API
URI Format Refer to these sections
/quotations Quotations API
URI Format Refer to these sections
/accounts/links Links API
URI Format Refer to these sections
/batchtransactions Batch Transactions API
URI Format Refer to these sections
/batchtransactions/rejections Batch Transactions API
URI Format Refer to these sections
/batchtransactions/completions Batch Transactions API

Mobile Money API

API Fundamentals
API Behaviour & Error Handling
Security
Accounts
Transactions
Quotations