Intégration du passage à la caisse
Cette section décrit l'intégration de Paysafe Checkout. Quelques lignes de code suffisent pour intégrer le passage à la caisse et commencer à percevoir des paiements.
La caisse permet de traiter et stocker en toute sécurité toutes les informations relatives au paiement, comme les données saisies par l'utilisateur (carte de crédit et coordonnées bancaires) et vous renvoie les informations de paiement sous forme de jetons.
Elle fonctionne avec les API de paiements Paysafe et les informations sur la structure de la requête, les objets et les variables sont disponibles dans la référence API.
Avant de commencer
Inclure des scripts dans votre page Web
Initier le passage à la caisse
Intégrer le passage à la caisse
Paysafe Checkout recueille les coordonnées de vos clients, comme les informations sur le compte, les données de facturation, etc. Il aide vos clients à finaliser leur commande en traitant les paiements. La trousse de développement logiciel de Paysafe Checkout vous donne la liberté de créer votre intégration personnalisée.
Contactez notre équipe dédiée à l'aide à l'intégration à l'adresse integrations@paysafe.com pour créer un compte de test, et indiquez les paiements pris en charge que vous souhaitez ajouter à votre compte de test.
Comment utiliser la SDK
Incluez la SDK Paysafe Checkout dans votre formulaire de paiement HTML.
Appelez la fonction de configuration de la caisse avec votre clé d'API publique.
Le rappel utilise AJAX pour envoyer le jeton de "payment handle" (contenant les détails de paiement du client) à votre site Web (marchand), où vous pouvez écrire votre propre logique pour envoyer ce jeton à votre serveur (marchand) afin d'effectuer un paiement ou de traiter un paiement à l'aide de l'API de paiements Paysafe.
Inclure la SDK
La SDK se trouve ici :
https://hosted.paysafe.com/checkout/v2/paysafe.checkout.min.js
Vous devez l'inclure dans votre formulaire HTML en ajoutant un élément <script> dans l'en-tête ou le corps du formulaire.
La fonction de configuration
La fonction de configuration crée une superposition « iframe » contenant le formulaire de paiement/formulaire de retraite hébergé sur les serveurs de Paysafe. Vous devrez passer une fonction de rappel dans le cadre de la configuration pour gérer la réussie ou l’échec des paiements. Elle comporte les paramètres suivants :
La version encodée en Base64 de la clé API
Un objet options contenant l'environnement à utiliser (Test ou Direct), le montant du paiement, la devise et plusieurs paramètres permettant de personnaliser le formulaire de paiement et d'en adapter l'apparence.
Un resultCallback qui reçoit l'instance Paysafe Checkout et gère la tokenisation (en envoyant le jeton à votre serveur de marchand). Elle répond également aux erreurs provoquées par l'échec de tokenisation.
Une fonction facultative closeCallback pour gérer la fermeture de la superposition de paiement par le client.
Une fonction facultative riskCallback pour recevoir le montant et le mode de paiement que le client a sélectionnés et exécuter vos contrôles de risque avant que le "payment handle" ne soit créé. En fonction de la réponse de riskCallback, un "payment handle" sera créé et renvoyé dans resultCallback (applicable uniquement aux cartes, PaySafe Cash, VIPP et Sightline).
La signature de la fonction est la suivante :
<paysafe.checkout.setup(apikey, options,resultsCallback, closeCallback, riskCallback);>
resultCallback
Le rappel de résultat est invoqué lorsque le "payment handle" a été créé avec succès et se trouve dans l'état PAYABLE ou en cas d'erreur lors du passage à la caisse. Il transmet également une instance de l'objet Caisse. En utilisant les fonctions fournies dans l'objet d'instance, le marchand peut contrôler l'expérience au passage à la caisse.
Le resultCallback comporte les éléments suivants.
Paramètre | Type | Requis | Description |
---|---|---|---|
instance | object | Oui | Il s'agit de l'instance de paiements de Paysafe Checkout. |
error | object | Non | Cet objet comporte des informations d'erreur et est présent en cas d'échec de la création d'un "payment handle". |
result | object | Oui | C'est le résultat qui contient le jeton de paiement. |
{return} | undefined | false |
instance
Paramètre | Type | Requis | Description |
---|---|---|---|
isOpen | function | Oui | Vérifie si la superposition est encore ouverte. |
close | function | Oui | Ferme la superposition sans afficher le résultat du paiement. |
showSuccessScreen | function | Oui | Modifie la présentation de la caisse pour en faire un écran de réussite. |
showFailureScreen | function | Oui | Modifie la présentation de la caisse pour en faire un écran d'échec. |
error
Paramètre | Type | Requis | Description |
---|---|---|---|
message | string | Oui | Fournit une erreur qui peut être affichée aux utilisateurs. |
detailedMessage | string | Oui | Fournit un message d'erreur détaillé qui peut être consigné. |
correlationId | string | Oui | Il s’agit d’un identifiant unique qui peut être fourni à l'équipe d'assistance Paysafe comme référence pour l'invsestigation. |
result
Paramètre | Type | Requis | Description |
---|---|---|---|
paymentHandleToken | string | Oui | Il s'agit du jeton de "payment handle" à inclure dans l'appel à l'API des paiements. |
paymentMethod | string | Oui | Il s’agit du mode de paiement utilisé par le client. |
customerOperation | string | Oui | Il s'agit de l'opération client pour la carte. Les valeurs éventuelles sont :
|
montant | number | Oui | Il s'agit du montant utilisé pour créer le "payment handle". Cela est nécessaire car l'utilisateur peut modifier le montant lors du passage à la caisse. |
Voici un exemple :
closeCallback
Le rappel de fermeture. Il notifie le script marchand lorsque la caisse est fermée. Les actions suivantes invoquent le closeCallback :
- Lorsque le client ferme la caisse.
- Lorsque le marchand ferme la caisse à l'aide de la méthode instance.close() dans le rappel de résultat après l'appel de paiements.
Le closeCallback comporte les éléments suivants.
Paramètre | Type | Requis | Description |
---|---|---|---|
stage | string | Oui | Phase pendant laquelle la superposition de la caisse est fermée. Les valeurs éventuelles sont : PAYMENT_HANDLE_NOT_CREATED, PAYMENT_HANDLE_CREATED, PAYMENT_HANDLE_REDIRECT, PAYMENT_HANDLE_PAYABLE
|
expired | boolean | Oui | Ceci indique si l'événement a été déclenché après l'expiration du passage à la caisse. |
{return} | undefined | false |
riskCallback
Applicable uniquement aux cartes, PaySafe Cash, VIPP et Sightline.
Ceci avise le marchand du montant et du mode de paiement lorsque l'utilisateur clique sur le bouton Payer/retrait lors du passage à la caisse. Les actions suivantes invoquent le riskCallback :
Lorsque le client clique sur le bouton Payer/Retrait à la caisse.
Le riskCallback comporte les éléments suivants.
Paramètre | Type | Requis | Description | |
---|---|---|---|---|
montant | string | Oui | Il s'agit du montant que le client souhaite payer. | |
paymentMethod | string | Oui | Il s’agit du mode de paiement utilisé par le client. | |
instance | object | Oui | Il s'agit de l'instance de paiements de Paysafe Checkout. | |
decline | function | Lorsque cette fonction est invoquée, la caisse considère que la vérification du risque a échoué & rend le message que vous transmettez en paramètre dans cette fonction. Veuillez consulter l’exemple. | ||
accept | function | Lorsque cette option est invoquée, la caisse considère que le rappel de vérification de risque est transmis & et procède à la création du "payment handle". Veuillez consulter l’exemple. |