Liens de paiement
Le lien de paiement est une méthode sécurisée de réception de paiement via une URL de lien de paiement simple. Cela vous permet de proposer une méthode supplémentaire pour l'acceptation d'un paiement, qui consiste à générer une URL de lien de paiement, puis à la partager avec le payeur via différents canaux de communication, tels que les e-mails, les SMS et les codes QR. Lorsqu'un payeur clique sur l'URL du lien de paiement, il est redirigé vers la page de paiement, où il peut sélectionner le mode de paiement pour terminer la transaction.
Avantages clés
Les avantages clés d'un lien de paiement sont les suivants :
- Simplification du traitement de paiement
- Amélioration de l'expérience client
- Paiement plus rapide
- Vous permet de suivre un client après l'échec d'une transaction ou l'abandon d'un panier
Utiliser un lien de paiement
Lorsque les payeurs reçoivent une URL de lien de paiement unique pour un paiement, ils peuvent cliquer sur le lien et effectuer le paiement.
Le diagramme ci-dessous illustre les différentes étapes pour effectuer une transaction à l'aide d'un lien de paiement.
- Entrez les informations de paiement, telles que le numéro de facture, le montant total et la demande de génération d'une URL de lien de paiement.
- La passerelle génère un lien unique que vous pouvez partager avec les payeurs.
- Lorsque les payeurs cliquent sur le lien, ils sont redirigés vers une page Hosted Checkout.
- Les payeurs entrent les informations de paiement sur la page Hosted Checkout et terminent la transaction.
Demander une opération Initiate Checkout (Lancer le paiement)
Conditions préalables
Avant de lancer une opération de paiement, assurez-vous que les attributs ci-dessous sont définis pour les liens de paiement :
- apiOperation : définissez le champ sur INITIATE_CHECKOUT.
- checkoutMode : définissez le champ sur PAYMENT_LINK.
- interaction.operation : choisissez le type de transaction (AUTHORIZE (Autoriser) ou PURCHASE (Acheter), par exemple).
- interaction.merchant.name : nom de votre entreprise affiché au payeur sur la page de paiement.
- interaction.merchant.url : URL du site Web de votre entreprise.
- order.amount : montant total de la commande. Il s'agit du montant net plus tout surcoût.
- order.currency : devise de la commande.
- order.description : brève description textuelle du contenu de la commande.
- paymentLink.errorUrl : URL vers laquelle vous souhaitez rediriger le navigateur du payeur en cas d'erreur lors de l'appel du lien de paiement, comme une commande déjà payée, un lien de paiement expiré, un lien de paiement non valide, etc.
Si spécifié et si une erreur se produit, la passerelle fournira le code d'erreur (
errorCode) et la description (errorDescription) en tant que paramètres de chaîne de requête. La passerelle conservera également tous les paramètres de chaîne de requête que vous avez pu inclure dans errorUrl.Par exemple, si vous spécifiez paymentLink.errorUrl comme https://merchant.com/myPaymentLinkErrorPage.html, en cas d'erreur, errorUrl recevrait les paramètres de chaîne de requête suivants de la passerelle : https://merchant.com/myPaymentLinkErrorPage.html?errorCode=ERROR_CODE&errorDescription=Erreur+message. Pour plus d'informations, voir la rubrique Codes d'erreur et descriptions.
Ce champ est facultatif. Lorsque ce champ n'est pas renseigné, le payeur, en cas d'erreur, sera redirigé vers l'écran d'erreur par défaut. - order.id : identifiant unique de cette commande permettant de la différencier des autres commandes que vous créez.
- paymentLink.expiryDateTime : date et heure d'expiration du lien de paiement. La valeur par défaut est de 3 mois.
- paymentLink.numberOfAllowedAttempts : nombre de tentatives autorisées après lequel le payeur ne pourra plus payer à l'aide du lien de paiement. La valeur par défaut est de 25 tentatives.
Exemple de demande
Pour créer une URL de lien de paiement, vous devez demander une opération Initiate Checkout (Lancer le paiement) avec la méthode payment link. Ceci est un exemple d'extrait de code pour l'opération Initiate Checkout (Lancer le paiement).
{
"apiOperation": "INITIATE_CHECKOUT",
"checkoutMode": "PAYMENT_LINK",
"interaction": {
"operation": "AUTHORIZE",
"merchant": {
"name": "<your_merchant_name>",
"url": "<website_url>"
}
},
"order": {
"currency": "USD",
"amount": 1234,
"id": "<order_ID>",
"description": "Ordered goods"
},
"paymentLink": {
"expiryDateTime": "2021-12-10T02:16:00.993Z",
"numberOfAllowedAttempts": "3"
}
}
Référence de l'API Initiate Checkout (Lancer le paiement) [REST][NVP]
Une réponse réussie à cette opération contient les paramètres URL du lien de paiement et identifiant du lien de paiement, qui peuvent être partagés avec le client pour effectuer le paiement.
Exemple de réponse
{
"checkoutMode": "PAYMENT_LINK",
"merchant": "<your_merchant_id>",
"paymentLink": {
"expiryDateTime": "2021-12-10T02:16:00.993Z",
"id": "PAYLINK0001060519617G19059484L2",
"numberOfAllowedAttempts": 3,
"url": https://pbl/PAYLINK0001060519617G19059484L2
},
"result": "SUCCESS",
"successIndicator": "c89f62baad174e12"
}
Partager des liens de paiement
Le commerçant partage le lien de paiement avec le payeur via différents canaux de communication, tels que les e-mails, les SMS et les codes QR. Le payeur clique sur le lien de paiement qui le redirige vers la page de paiement Hosted Checkout dans un navigateur et termine la transaction en utilisant l'un des modes de paiement disponibles.
Supprimer les liens de paiement
L'opération Delete Payment Link (Supprimer le lien de paiement) permet de supprimer ou d'invalider explicitement le lien de paiement si le payeur a déjà effectué le paiement hors ligne ou si le paiement n'est plus requis.
| URL | https://api/rest/version/64/merchant/{merchantId}/link/{linkId} |
| Méthode HTTP | DELETE |
Référence de l'API Delete Payment Link (Supprimer le lien de paiement) [REST][NVP]
La passerelle fait automatiquement expirer la session si :
- le paiement n'est pas effectué dans les 3 mois suivant la génération du lien de paiement, le payeur ne pourra plus utiliser le lien de paiement pour effectuer le paiement,
- le nombre de tentatives de paiement est supérieur à 25, le payeur ne pourra plus accéder au lien de paiement pour terminer la transaction,
- le paiement à l'aide d'un lien de paiement a été effectué, ou
- le commerçant lance la demande de suppression.
Tester un lien de paiement
Une fois votre compte avec le prestataire de site Web de paiement configuré et votre intégration générée, vous devez tester le lien de paiement en utilisant votre profil de commerçant de test (votre identifiant de commerçant commençant par « TEST »). La passerelle fournit une page Hosted Checkout de test pour vérifier le lien de paiement.
- Entrez les détails du paiement et demandez le lien de paiement via l'opération INITIATE_CHECKOUT. Une URL de lien de paiement est retournée lorsque l'opération INITIATE_CHECKOUT est réussie.
- Effectuez le paiement à l'aide de la carte de test répertoriée dans les détails du test d'une transaction de carte.
Notifications Webhook
Nous vous recommandons d'opter pour le service de notifications afin de recevoir des notifications Webhook si le paiement est réussi. Pour plus d'informations sur les notifications et la configuration Webhook, voir Notifications Webhook.
Codes d'erreur et descriptions
Le tableau ci-dessous répertorie les codes d'erreur et leurs descriptions.
| Code d'erreur | Description |
|---|---|
| EXPIRED | Le lien de paiement a expiré. Veuillez contacter le demandeur du paiement. |
| PAID | La commande associée à ce lien de paiement a été payée. Veuillez contacter le demandeur du paiement. |
| USAGE_COUNT_EXCEEDED | Le nombre maximal de tentatives autorisées a été dépassé. Veuillez contacter le demandeur du paiement. |
| DOES_NOT_EXIST | Ce lien de paiement n'est pas valide. Veuillez contacter le demandeur du paiement. |
| UNEXPECTED_ERROR | Une erreur inattendue s'est produite. Veuillez contacter le demandeur du paiement. |
| DELETED | Ce lien de paiement a été supprimé. Veuillez contacter le demandeur du paiement. |