L'API Payments permet d’intégrer facilement une solution de paiement sécurisée par virement simplifié (instantané ou classique) directement dans vos applications métiers.
Pourquoi utiliser un webhook ?
Le webhook est très utile et vous permet de recevoir une notification à chaque changement de statut lié à une demande de paiement.
L'envoie de notification prend en charge tous les statuts (dont le "NEW" à la création de votre ordre de virement), dès lors que votre ordre de virement change de statut, nous vous notifions directement sur votre webhook.
Afin de s'assurer de bien recevoir les notifications, nous vous recommandons de whitelister les IP suivantes provenant de nos serveurs :
- 54.77.251.155
- 54.78.179.167
- 52.212.23.29
Comment enregistrer son webhook ?
Afin d’enregistrer son webhook, faites un POST /v1/subscribe sur le EndPoint suivant : https://pay.oxlin.io
Base Url : POST https://pay.oxlin.io/v1/subscribe
Exemple requête:
curl --request POST --location 'https://pay.oxlin.io/v1/subscribe' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx' \
--data '{
"callback_url":"https://domain/callback"
}'
NB : La longueur maximale de l’url webhook est de 512 caractères.
Comment tester le webhook (avant mise en place d'un serveur côté client) ?
Il est possible d’utiliser des sites en ligne qui fournissent gratuitement des URLs pour tester la réception des notifications. Par exemple : https://webhook.site/.
Comment supprimer son webhook ?
Afin de supprimer son webhook, faites un POST /v1/unsubscribe sur le EndPoint suivant : https://pay.oxlin.io
Base Url : POST https://pay.oxlin.io/v1/unsubscribe
Exemple requête:
curl --request POST --location 'https://pay.oxlin.io/v1/unsubscribe' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer xxxxx' \
--data '’
NB : Attendez d’être notifié sur votre webhook avant de venir consulter la mise à jour de votre demande de paiement.
Les notifications du webhook
Voici un exemple de réception d’une notification au sein du webhook :
curl -X 'GET' 'https://webhook.site/079cf204-202d-43d7-98a5-21353cc7c4f8?resource_id=c9xxxf72-2944-4xxb-9d75-9xxxxx7a8ea0&resource_type=orders' \
-H 'user-agent: Apache-HttpClient/5.4.1 (Java/17.0.14)' \
-H 'host: webhook.site' -H 'accept-encoding: gzip, x-gzip, deflate' \
-H 'content-type: application/json'
Le “resource_id” correspond à l’ ”order_id” de l’ordre de paiement.
Comment relancer une notification webhook ?
Il est possible de recevoir à nouveau une notification webhook pour une demande de paiement.
Relancer le webhook via URL
Pour cela veuillez appeler votre URL de webhook suivit des paramètres :
- ressource_id={order_id}
- resource_type=orders
Base Url : GET https://{votre url webhook}
Exemple requête:
curl -X 'GET' 'https://{votre url webhook}?resource_id={order_id}&resource_type=orders'
Exemple requête pour l’URL webhook client “https://webhook.site/bacceb49-854a-4c24-8279-fb3962bb31b9” et l’order_id “1234” :
curl -X 'GET' 'https://webhook.site/bacceb49-854a-4c24-8279-fb3962bb31b9?resource_id=1234&resource_type=orders'
Retrouvez la documentation de référence API sur le webhook via ce lien.
Relancer le webhook via Dashboard
Pour cela, depuis l'onglet "Ordres" de votre Dashboard, veuillez cliquer sur le bouton "..." de la demande d'ordre souhaitée. Puis sélectionner "Relancer les notifications" :
Ces informations ont-elles répondu à votre question ?
Si vous rencontrez des difficultés, n'hésitez pas à contacter notre équipe Support via ce lien