The purpose of this site is to detail the design principles, objects, behaviours and error handling for the MTN Mobile Money API. The overriding goal of the API is to enable all parties to implement MTN Mobile Money APIs in a flexible, yet consistent manner. We hope to achieve this by the implementing the following principles:

L'objectif de ce site est de detailler les principes de conception, les objets, les comportements et la gestion des erreurs pour l'API MTN Mobile Money. L'objectif principal de l'API est de permettre a toutes les parties d'implementer les API MTN Mobile Money de maniere flexible, tout en garantissant la coherence. Nous esperons atteindre cet objectif en appliquant les principes suivants :

• Use of REST architectural principles.

• Utilisation des principes d'architecture REST.

• 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.

• Fourniture d'un ensemble d'objets bien definis, abstraits des representations d'objets sous-jacentes presentes dans les differents systemes de mobile money. Cela permet a un client API de construire un message API sans necessiter de connaissance specifique de l'implementation du serveur cible.

• 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.

• Creation d'un ensemble standard de types de transactions et d'autres enumerations cles, supprimant ainsi la necessite pour les developpeurs de faire des correspondances pour chaque implementation d'API.

• Use of ISO international standards for enumerators such as currency and country codes

• Utilisation des normes internationales ISO pour les enumerations telles que les codes de devise et les codes pays.

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

• Utilisation de metadonnees supplementaires et de sous-types afin de permettre la transmission, lorsque necessaire, de proprietes specifiques aux cas d'usage et/ou aux fournisseurs de mobile money.

• 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.

• Reconnaissance de l'absence d'un identifiant commun pour les comptes de mobile money, et utilisation d'une structure flexible permettant d'identifier le(s) compte(s) cible(s) et les parties a la transaction a l'aide d'un ou de plusieurs types d'identifiants.

The Open API is a JSON REST API that is used by Partner systems to access services in the Wallet platform. The Open API exposes services that are used by e.g. online merchants for managing payments and other financial services. This document gives an overview of the structure of the API.

L'Open API est une API REST basee sur JSON, utilisee par les systemes partenaires pour acceder aux services de la plateforme Wallet. L'Open API expose des services utilises, par exemple, par les commercants en ligne pour la gestion des paiements et d'autres services financiers. Ce document fournit une vue d'ensemble de la structure de l'API.

---

← Home Getting Started →