Fonctionnalité Webhook

Lorsqu'un événement se produit sur votre compte iPayMoney vous pouvez, en utilisant les webhooks, vous informer sur leur exécution. À ce jour, vous pouvez utiliser les webhooks afin de notifier à votre système de gestion le statut d'une transaction (la transaction, est-elle un succès ou un échec).

Configuration des webhooks

Il vous faudra suivre les étapes ci-après afin de procéder à la configuration de vos webhooks :

Cliquez sur le menu "Développeurs".

Ensuite, cliquez sur le sous-menu "Webhooks" en dessous du sous-menu "Clés API."

Cliquez sur le bouton "Ajouter un webhook" en haut à droite.

Dans le formulaire qui apparaît, veuillez inscrire l’URL sur lequel vous désirez être notifié. Vous pouvez entrer n'importe quel URL comme destination pour les événements. Toutefois, il doit s'agir d'une page dédiée sur votre serveur, configurée pour recevoir des événements.

Remplissez votre "Secret Hash". C’est votre clé API secrète, elle sera utilisée afin de vérifier la provenance des informations que vous recevez. Copiez-la du sous-menu "Clés API" pour la coller dans le champ à remplir le Secret Hash.

Attention ! Ne partagez surtout pas votre clé secrète.

Choisir les événements pour lesquels vous souhaitez être averti. Vous serez averti uniquement des événements spécifiés. Notez qu’il y a seulement deux (2) types d’événements : Succès et Échec.

Enfin, enregistrez votre Webhook en cliquant sur "Enregistrer".

Une fois le Webhook créé, vous pouvez procéder à un test afin de vérifier que iPayMoney contacte bien votre URL.

Voilà ! Désormais, vous serez averti de toute activité sur votre compte iPayMoney.

Gérer les webhooks

Après la configuration, il est important de comprendre l’accusé de réception d’un événement après notification d'iPayMoney. Pour ce faire, vous devez avant tout utiliser votre URL afin d'identifier le type d’événement et renvoyer un code statut HTTP 2xx. Tous les codes de réponse en dehors de cette plage, y compris les codes 3xx, indiquent à iPayMoney que vous n'avez pas reçu l'événement.

En cas de non réception iPayMoney tente 5 fois de suite (dans un intervalle de 500ms incrémentable) de vous renvoyer les informations.

Vérification des signatures webhook

iPayMoney signe les événements webhooks qu’il envoie à vos URL. Il est introduit dans l’en-tête de chaque requête x-iPayMoney-secret une signature. Elle est utilisée afin de vous permettre de vérifier que les événements ont été envoyés par iPayMoney et non par un tiers. Le squelette de la requête est le suivant :

{
  "content-length": "114",
  "accept": "application/json",
  "user-agent": "rest-client/2.1.0 (linux-gnu x86_64) ruby/2.7.2p137",
  "secret-hash": "sk_58951rhguiq859905dfn5903gh",
  "content-type": "application/json",
  "accept-encoding": "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
}

Toutes les requête x-iPayMoney-secret utilisent le secret hash fourni par votre personne sur le tableau de bord iPayMoney.

Payloads Response Body

À chaque notification d'événement iPayMoney envoie un body request au format json ci après :

• Dans le cas d'une transaction échouée:

{
  "data": {
    "external_reference": "random-39",
    "reference": "zug596nsydoh",
    "status": "failed",
    "msisdn": "40410000003"
  }
}

• Dans le cas d'une transaction réussie:

{
  "data": {
    "external_reference": "random-38",
    "reference": "yeweyk6rd7cm",
    "status": "succeeded",
    "msisdn": "40410000001"
  }
}