Introduction

Découvrez comment accepter des paiements rapides et sécurisés par Mobile Money avec Chipdeals.

Nous avons écrit cette documentation en supposant que vous êtes habitué aux principes des APIs et que vous pouvez effectuer des requêtes. Si vous êtes nouveau dans le monde des APIs, vous devriez consulter notre article sur les bases de l'API.

Les bases

Nos APIs vous donnent accès à pratiquement toutes les fonctionnalités que vous pouvez utiliser pour développer vos produits pour accepter ou faire des paiements Mobile Money en ligne.

Opérations prises en charge

L'API Chipdeals prend en charge la reception de fonds depuis des comptes Mobile Money et les cartes bancaires. Elle permet aussi le virement de fonds depuis votre solde vers des comptes Mobile Money du même pays de reception.

Pour comprendre comment recevoir des paiements, il faut lire la documentation sur comment accepter des paiements.

Pour comprendre comment faire des virements, il faut lire la documentation sur comment faire des paiements

Avant de faire quoi que ce soit

Vous devez créer un compte Chipdeals gratuit. Vous obtiendrez ainsi vos clés API de test pour effectuer des transactions.

Exemples de requête

Nous fournissons des exemples de requêtes vers nos APIs en utilisant cURL. Il vous suffit d'insérer vos propres paramètres et vous pourrez tester les requêtes depuis votre ligne de commande. Consultez ce tutoriel sur l'utilisation de cURL avec les API

Vous pouvez également utiliser Postman si vous n'êtes pas familier avec cURL. Postman est un environnement de développement d'API facile à utiliser pour effectuer des requêtes HTTP. Des collections Postman sont disponible pour démarrer vos tests avec plus de facilités.

Vous pouvez aussi utiliser REST Client si vous utilisez l'environnement de développement VSCode. REST Client est un plugin téléchargeable afin de faciliter vos requêtes HTTP directement depuis VSCode.

Après avoir installé l'extension, téléchargez notre fichier .http et ouvrez-le dans VSCode afin de démarrer directement les tests avec des requêtes prêtes à l'emploi.

Format de reponses

Les données de la requête et les données de la réponse sont au format JSON. Le type de contenu pour les réponses sera toujours application/json. Généralement, toutes les réponses seront dans le format suivant :

Format de réponse

{
  "success": [boolean], // true uniquement lorsque votre requête a été validée
  "message": [string], // Détails d'une opération. Généralement vide.
  "errorCode": [string], // Présent uniquement lorsque la propriété success est à false
  "anyObject": [array or object] //Selon la requête nous ajoutons des données spécifiques
}

Bien que nous recommandions généralement aux développeurs d'utiliser des codes d'état HTTP fournis dans l'entête de chaque réponse pour déterminer le résultat d'une requête, nous avons également fourni une propriété success pour vous informer si la demande a été traitée ou non.

La propriété message est une chaîne qui contiendra un résumé de la réponse et son état. Par exemple, lorsque vous essayez de récupérer une liste de transaction, le message peut indiquer « Transactions récupérées ». En cas d'erreur, la propriété message contiendra une description de l'erreur.

La propriété anyobject est l'endroit où vous trouverez le résultat de votre requête. Il peut s'agir soit d'un objet, soit d'un tableau selon la requête effectuée. Par exemple, une demande de récupération d'une seule transaction renverra un objet transaction dans un propriété transaction, tandis que la propriété contiendrait un tableau de transactions si une liste est demandée à la place.

anyObject peut varier en fonction de la requête. Par exemple pour une requête de votre solde, anyObject devient balances. Par contre si ce sont vos transactions que vous essayez de récupérer, anyObject devient transactions