Notifications push
API Webhook swagger
Notre interface API de notifications push vous permet d'automatiser facilement le suivi de l'état de tous vos paiements générés par l'interface API. Au lieu d'avoir à effectuer des appels manuels répétés pour obtenir l'état actuel, nous vous informerons automatiquement dès que vos paiements passeront à l'état suivant.
Il s'agit d'une solution entièrement personnalisable qui vous permet de choisir pour quels changements d'état vous souhaitez recevoir des notifications et comment vous souhaitez les recevoir. Nous offrons des notifications en temps réel par API Webhook, courriel, message texte ou toute combinaison des trois. Vous pouvez même spécifier qui dans votre entreprise doit recevoir ces mises à jour, en fournissant jusqu'à 10 numéros de téléphone et 5 courriels pour chaque opération API (par exemple, un virement télégraphique ou un déboursement Fedwire).
Pour vous lancer, veuillez communiquer avec votre représentant de BMO.
Aperçu
| Interfaces API prises en charge : | Toutes les interfacse API de paiement |
| Méthodes de livraison : | API Webhook Courriel Message texte |
| Limites: | Jusqu'à 10 numéros de téléphone/opération API Jusqu'à 5 adresses courriel/opération API |
| Vitesse : | Notifications instantanées (les déclencheurs de changement d’état sont personnalisables) |
Endpoints Summary
Fournir le jeton d'accès
Avant de pouvoir communiquer avec votre application, nous devons demander un jeton d'accès à votre serveur OAuth. Voici la procédure :
- Étape 1 : Nous contactons votre point de terminaison OAuth pour demander un jeton d'accès.
- Étape 2 : Votre serveur OAuth renvoie un jeton d'accès à BMO.
- Étape 3: Nous validons la signature avec votre serveur OAuth.
- Étape 4: Votre serveur OAuth renvoie une clé publique à des fins de validation.
Nous avons récupéré et validé votre jeton d'accès. Ensuite, nous l'utiliserons pour envoyer la notification d'état du paiement.
Fournir la clé publique
Par mesure de sécurité, les notifications relatives à l'état des paiements sont chiffrées. Pour ce faire, nous devons vous demander une clé publique. Cette clé publique est différente de celle que nous avons utilisée à l'étape précédente pour la validation. Voici la procédure :
- Étape 1:Nous vous demandons une nouvelle clé publique.
- Étape 2 : Vous renvoyez la clé publique à l'aide du point de terminaison (POST /public-keys/v1). Remarque : Pour des détails techniques, y compris des exemples de code, veuillez télécharger le swagger de clé de chiffrement ci-dessus.
- Étape 3: Nous utilisons la clé publique pour chiffrer notre notification d'état.
Maintenant que la notification d'état du paiement est chiffrée, nous procédons à son envoi.
Obtenir la notification d'état du paiement
En dernière étape, nous vous envoyons la notification d’état chiffrée. Voici la procédure :
- Étape 1: Nous envoyons la notification chiffrée (Pain.002) sous forme de requête .json à l'aide du point de terminaison (PUT / paymentStatusUpdate/v1).
- Étape 2: Vous déchiffrez le message à l'aide de votre clé privée.
- Étape 3: Vous renvoyez un message de réussite ou d'échec sous forme de réponse .json à BMO.
Une fois que nous avons reçu votre réponse positive, la notification push est considérée comme ayant été délivrée avec succès. Si nous recevons une réponse négative ou si nous ne recevons aucune réponse, nous réessaierons une fois par heure pendant 24 heures maximum.
Remarque : Pour plus d'informations sur les états possibles qui peuvent être renvoyés, veuillez consulter le tableau des réponses pour le point de terminaison « Obtenir l'état du paiement » sur chaque page de documentation des interfaces API.