Présentation des web services ordre de paiement par e-mail
Les web services sont développés suivant le protocole SOAP version 1.2 (Simple Object Access Protocol) et sont décrits par le fichier wsdl suivant :
Si vous passez par un proxy pour vous connecter à Internet depuis un serveur applicatif, veuillez-vous rapprocher de votre service informatique pour savoir s'il est nécessaire de configurer l'accès à cette URL.
Afin de sécuriser les échanges, les webservices (SOAP) sont cryptés grâce au protocole HTTPS. De plus un mécanisme de signature a été mis en place afin de valider et d’authentifier l’échange des données.
Description du service
Ce service permet d'automatiser la création / modification d'un ordre de paiement à destination d'un ou plusieurs destinataires.
Pour cela 2 méthodes sont disponibles :
- create pour la création d'un ordre de paiement par e-mail.
- updatepour la modification d'un ordre de paiement par e-mail.
La réponse renvoyée par la plateforme de paiement contient la liste des ordres créés/modifiés.
Chaque ordre est associé à un identifiant, une adresse e-mail et une URL de paiement.
Envoi à une liste de destinataires :
Il est possible de définir dans la requête une liste de destinataires.
Dans ce cas, un ordre de paiement est créé par destinataire. Il y a donc autant d'ordres de paiement que de destinataires.
Ainsi, après le règlement, chaque transaction correspondra à un unique destinataire.
Afin d'identifier les différents ordres créés, le champ reference est incrémenté de 1 sur 3 caractères numériques.
Ces caractères sont concaténés à la référence de l'ordre avec un tiret. Exemple : [ref]-001, [ref]-002, [ref]-003.
Exemple d'un ordre dont le champ reference est valorisé à "Recouvrement" :
Si l'ordre est envoyé à 3 destinataires, alors 3 ordres seront créés avec les références suivantes :
- Recouvrement-001
- Recouvrement-002
- Recouvrement-003
Utilisation d'un outil de mailing externe :
Si le marchand souhaite utiliser son propre outil de diffusion, il devra désactiver l'envoi automatique des e-mails dans ses requêtes de création / modification d'ordre de paiement.
En analysant la réponse, il retrouvera les informations nécessaires pour compléter son e-mail : URL de paiement, référence de l'ordre et adresse e-mail du destinataire.