Cash Out- OM

Description

Le mobile money se développe fortement en Afrique, grâce aux acteurs locaux et aux grandes enseignes internationales. Ainsi,  pour répondre à la forte attente des populations et pour innover davantage, les acteurs ont besoin d’accéder directement aux services des opérateurs.

Ces solutions APIs sont mises en place pour :

  • Répondre de façon efficiente  aux besoins d’ouverture des services Orange Money face aux défis imposés par la transformation digitale.
  • Proposer une architecture totalement orientée services et de façon sécurisée.
  • Exposer les services sous forme d’API (Application Programming Interface) de façon standardisée.

L’API CASH OUT(retrait automatique d’argent d'un compte client) d’Orange Money est maintenant disponible pour les distributeurs.

Ce service  permet d'effectuer un retrait d’argent depuis un compte client. En d’autres termes, c’est le positionnement, par un commerçant, d’un montant à destination du compte Orange Money d’un client.

Le distributeur aura deux possibilités d’utilisation :

  • Dépôt unitaire: Exécuter une requête de dépôt d’un montant défini pour un client.
  • Dépôt multiple (BULK CASH IN) : Exécuter dans une seule requête plusieurs dépôts de montants différents à des destinataires tout aussi différents.

 

À qui est destiné l’API ?

 

Si vous êtes déjà distributeur Orange Money, ou que vous souhaitez le devenir, rejoignez un écosystème sécurisé en vous inscrivant sur ce site.

 

 

Intégration rapide en trois étapes 

 

Le service est facile à intégrer grâce à un accès en ligne, la possibilité de tester en toute autonomie et une documentation détaillée :
 

  1. S’inscrire pour créer son compte développeur.
  2. Créer une application pour tester rapidement la solution grâce aux multiples exemples disponibles dans la documentation.
  3. Envoyer ses documents administratifs depuis le site pour passer en production.

Conditions d’accès

Etre une entreprise légalement enregistrée et fournir les documents ci-après dans le formulaire de complément d'informations (nécessite un accès à votre compte développeur):

 

  • Registre de Commerce et du Crédit Mobilier (RCCM)
  • Numéro d'Identification National des Entreprises et des Associations (NINEA)
  • Carte Nationale d'Identité (CNI) ou Passeport de toutes les personnes mentionnées sur le RCCM et celui du gestionnaire du compte (celui qui effectue les opérations) 
  • Procuration du dirigeant social au profit du gestionnaire (si l'entreprise a un gestionnaire différent des personnes mentionnées sur le RCCM)

Pour plus de détails, veuillez lire le contrat d’engagement à télécharger depuis le formulaire de complément d'informations.

Commencer

Avec les APIs d'Orange et quelques lignes de code, vous pouvez très facilement effectuer des dépôts d’argent sur un compte client Orange Money après une authentification sécurisée, ensuite vérifier le statut de la transaction et votre solde.

Ci-après la liste des APIs inclues :

  • Authentification
  • Récupération de la clé publique de cryptage du code PIN
  • Changement de code PIN
  • Consultation de solde
  • Cash out
  • Confirmation de cash out
  • Rejet de cash out
  • Historique des transactions
  • Consultation du statut d’une transaction


Prérequis pour commencer
 

  1. Créer son compte développeur
  2. Créer une application de test
  3. Générer un token
     

Pour plus d’informations sur les prérequis, rendez-vous sur la page Premiers pas.

 


Cash In (dépôt d’argent vers un compte Orange Money)

 

Pour faire un dépôt, vous aurez besoin d’un numéro de distributeur avec du cash, d’un numéro client, du montant à déposer, et du code PIN crypté.

 

Toutes les URLs référencées dans la documentation suivent les liens ci-après:
 

Sandbox (Environnement test) : https://api.sandbox.orange-sonatel.com

Live (Environnement production) : https//api.orange-sonatel.com

 

Toutes les APIs fonctionnent en HTTPS pour garantir la sécurité et la confidentialité des données.
 

  1. Demander des numéros de test par API
  2. Récupérer la clé publique pour crypter le code PIN 
    GET [BASE_URL]/api/account/v1/publicKeys
     
  3. Crypter vote code PIN en RSA en utilisant par exemple ce site.
  4. Lancer la requête en utilisant l’exemple ci-après (Cash in): 
    
[
  {
    "partner": {
      "idType": "MSISDN",
      "id": "771234567",
      "encryptedPinCode": "Bs39XVxP0s[..]A==",
      "walletType": "PRINCIPAL"
    },
    "customer": {
      "idType": "MSISDN",
      "id": "771234567",
      "walletType": "PRINCIPAL"
    },
    "amount": {
      "value": 1,
      "unit": "XOF"
    },
    "requestDate": "2021-05-10T12:37:23.437Z",
    "receiveNotification": false,
    "reference": "0e3efaa9-2734-49c8-b43d-3884a62b8274",
    "metadata": {}
  }
]

 

 

Pour tester plus simplement les APIs, vous pouvez utiliser le logiciel POSTMAN.

 


Le lien ci-dessus vous permet d'importer la collection dans votre espace de travail ou de le voir en public sur le navigateur. En cas de problème, vous pouvez installer séparément Postman, depuis ce lien.

L'environnement Postman inclut les requêtes suivantes :

 

  • Cash out
  • Get Public Key
  • Change Pin Code
  • Get transaction status
  • Get transactions
  • Get Customer Balance
  • Get Retailer Balance
  • Search user profile by criteria

Note: Si vous rencontrez un problème dans le téléchargement ou l’ouverture de l’appli Postman, veuillez alors la télécharger depuis leur site ( https://www.getpostman.com​​​​ ), puis importer dans l’application la collection et l’environnement que nous avons regroupés dans un zip à télécharger ci-dessous : (clic droit + "enregistrer la cible du lien sous" / ou "save link as", si la pop-up de chargement ne s'affiche pas).

 

 

 

CASHIN.postman_collection.json.zip

/sites/default/files/apidoc_specs/api-documentation2.json
S'abonner à Cash Out- OM