Fonction de configuration

La fonction de configuration crée et initialise Paysafe Checkout dans une superposition. Elle comporte les paramètres suivants :

La version encodée en Base64 de la clé API générant des jetons à usage unique utilisée pour l’authentification avec l’API REST Coffre-fort client. Notez que cette clé ne peut être utilisée que pour générer des jetons à usage unique à utiliser avec les API Paiements par carte et Prélèvements automatiques, et qu’elle ne dispose d’aucun autre droit d’accès à l’API, comme ceux requis pour encaisser des paiements. Par conséquent, cette clé peut être exposée publiquement dans le navigateur de l'utilisateur.
Un objet options contenant l’environnement à utiliser (Test ou Production), le montant du paiement, la devise et plusieurs paramètres permettant de personnaliser le formulaire de paiement et d’en adapter l’apparence.
Une fonction resultCallback que vous fournissez pour recevoir l’instance de Paysafe Checkout, gérer une tokenisation réussie (en envoyant le jeton à votre serveur marchand) ou répondre à toute erreur causée par une tokenisation échouée.
Une fonction closeCallback facultative que vous fournissez pour gérer la fermeture de la superposition de paiement par le client.
eventCallback – invoquée immédiatement après l’apparition d’un ou de plusieurs événements dans Paysafe Checkout.

La signature de la fonction est la suivante :

paysafe.checkout.setup(apikey,options,resultsCallback,closeCallback, eventCallback);

Environnement

L’objet options contient une chaîne permettant de sélectionner l’environnement à utiliser pour la tokenisation, soit LIVE (l’environnement de production Paysafe) ou TEST (l’environnement de test marchand Paysafe ou bac à sable).

N’utilisez pas de vrais numéros de cartes ou d’autres détails d’instruments de paiement dans l’environnement de test du marchand. Il n’est pas conforme aux normes de sécurité des données de l’industrie des cartes de paiement (PCI-DSS) et ne protège pas les informations relatives aux titulaires de cartes et aux bénéficiaires. Tout téléchargement de données réelles de titulaires de cartes est strictement interdit, comme décrit dans les conditions d’utilisation..

Test

paysafe.checkout.setup("my Merchant test Base 64 encoded single-use-token API key", {

    environment: "TEST"

  },

  function(instance, error, result) {...});

Production

paysafe.checkout.setup("my Production Base64 Encoded single-use-token API key", {

    environment: "LIVE"

  },

  function(instance, error, result) {...});

Si vous omettez l’objet environment, en transmettant une valeur vide ou nulle pour ce paramètre, l’environnement Live sera utilisé.

Fonction et objets de configuration

Voici la liste complète des paramètres de la fonction de configurations, des objets JavaScript utilisés par la fonction de configuration et des paramètres qu'ils contiennent.

Paramètre	Requis	Type	Description
apiKey	true	string	Il s'agit de votre clé API publique, disponible dans le portail d'entreprise.
options	true	object	Il s'agit de la configuration du marchand pour le rendu du passage à la caisse.
resultCallback	true	function	Fonction de rappel invoquée avec le résultat ou l’erreur du paiement. Renvois d’une instance pour le contrôle du flux.
closeCallback	false	function	Cela permet de notifier le script du marchand lorsque la caisse est fermée.
{return}	false	any
options
montant length = 1-9	true	number	Montant du paiement en unités mineures à débiter de la carte du client. Utilisez le montant correct des unités mineures pour la devise du compte marchand. Par exemple, pour traiter 10,99 $ US, cette valeur doit être 1099. Pour traiter 1000 yens japonais, cette valeur doit être 1000. Pour traiter 10 139 dinars tunisiens, cette valeur doit être 10139. Min = 1 Max = 999999999 Lors de l'utilisation de 3DS 2 (c'est-à-dire useThreeDSecureVersion2= true), montant avec valeur : « 0 » peut être ignoré.
amountoptions	Non	number array	Ce paramètre est utilisé pour remplir les options de la grille de montant dans la caisse, afin que l'utilisateur puisse choisir en cliquant plutôt que de modifier le montant rempli. Le champ ne sera utilisé que si le paramètre « canEditAmount » dans les options est réglé sur « true ». Validations : Le champ doit être un « number array ». Chaque option numérique doit satisfaire à une condition de minimum 1 et de maximum 9999. Le marchand ne peut pas passer le montant décimal dans l'option « Grille des montants » Les valeurs en double ne sont pas autorisées. L'option maximale que le marchand peut passer est 3. ex : [1000, 5000, 67000]
devise	true	string	Il s'agit de la devise de paiement du compte marchand, par exemple, USD pour les dollars américains.
merchantRefNum	true	string	Un identifiant unique fourni par le marchand pour chaque transaction effectuée à partir de la caisse.
environment	false	string	Environnement utilisé pour effectuer les appels API et charger la caisse. Les valeurs éventuelles sont : LIVE – utilisé en mode Production TEST – utilisé pour l'environnement de test ou de bac à sable du marchand La valeur par défaut est « Live »
locale	false	string	Langue locale pour le passage à la caisse : en_US fr_CA S'il est omis, la langue par défaut est en_US.
billingAddress	false	object	Il s'agit de l'adresse de facturation du client qui sera affichée au moment du passage à la caisse. Le marchand doit inclure cet objet s'il s'agit d'un nouveau client qui n'a pas de profil de client. Si l’entité client a été créée avec l’API Paiements, les informations relatives à l’adresse provenant du jeton client à usage unique seront utilisées et le marchand n’aura pas besoin d’inclure l’objet billingAddress. Remarque : Les informations d’adresse de cet objet seront affichées à la place des informations d’adresse du jeton client à usage unique, si les deux sont inclus.
singleUseCustomerToken	false	string	Il s'agit du singleUseCustomerToken que le marchand a généré à l'aide de la requête Create a Single-Use Customer Token (Créer un jeton client à usage unique). Les adresses et/ou les données de paiement enregistrées s'affichent dans la caisse.
canEditAmount	false	boolean	Si la valeur est « true », le client peut modifier le montant dans la caisse avant de cliquer sur Payer. Si la valeur est « false », le montant ne peut être modifié.
client	false (pour tous les autres modes de paiement) Conditionnel (pour les mode de paiement PagoEfectivo et SafetyPay)	object	Si un client est un nouvel utilisateur et que son profil n'existe pas dans Paysafe, le marchand peut choisir de transmettre le profil (s'il existe chez lui) dans l'appel à la création d'une "payment handle". Mode de paiement PagoEfectivo : Il est obligatoire de fournir le profil du client si le marchand propose le mode de paiement PagoEfectivo. Mode de paiemen SafetyPay : Obligatoire, si le marchand propose l'un des modes de paiement suivants : SafetyPay Bank Transfer, SafetyPay Cash, Boleto Bancario, PIX, Khipu, MACH, SPEI
displayPaymentMethods	false	array	Ceci détermine les modes de paiement disponibles qui seront proposés au consommateur. Les valeurs de « l’array » sont affichées dans la caisse dans l'ordre où elles ont été transmises. Ceci est sensible à la casse. Valeurs acceptées - "displayPaymentMethods":[ "applePay","card", "mazooma" ,"skrill","paysafecard", "neteller", "paysafecash","instantach","sightline","vippreferred","paypal"], Si ce paramètre n'est pas inclus, tous les modes de paiement proposés au consommateur seront affichés dans la caisse.
paymentMethodDetails	conditional	object	Il s’agit de paramètres supplémentaires requis pour les types de paiement Mazooma, Apple Pay, Paysafecash, Paysafecard, Skrill, Interac, virement Interac, Paypal, PagoEfectivo, Play+ (Sightline), virement bancaire SafetyPay, SafetyPay Cash, Boleto Bancario, PIX, Khipu, MACH et SPEI.
payout	false	boolean	Si la valeur est « true » l’écran de retrait à la caisse sera lancé. Si la valeur est « false » Payment Checkout sera lancé. Valeurs par défauts à « false ».
payoutConfig	conditional	object	Obligatoire uniquement pour les retraits. Cette configuration est utilisée pour spécifier les limites de retrait.
merchantDescriptor	false	object	Il s'agit d'un descripteur de marchand.
billingAddress
nickName length<=50	false	string	Un identifiant du type d'adresse, par exemple, Travail ou Domicile.
street	false	string	Première ligne de l'adresse municipale du client.
street2	false	string	Deuxième ligne de l'adresse municipale du client. Ce champ est ignoré en cas de prélèvement automatique.
city	false	string	Ville de l’adresse.
zip	true	string	Code zip ou postal de l’adresse.
country	true	string	Pays de l’adresse.
state	false	string	Il s'agit de l'État, de la province ou de la région dans laquelle vit le client. Ce champ est ignoré en cas de prélèvement automatique.
paymentMethodDetails
carte	conditional	object	Obligatoire s'il y a plusieurs comptes de carte avec la même devise. Il s'agit de paramètres supplémentaires pour la carte.
paysafecard	conditional	object	Il s'agit de paramètres supplémentaires pour Paysafecard. Obligatoire pour le paiement/retrait par Paysafecard.
paysafecash	conditional	object	Il s'agit de paramètres supplémentaires pour Paysafecash. Obligatoire pour le paiement/retrait par Paysafecash.
skrill	conditional	object	Il s'agit de paramètres supplémentaires pour Skrill. Obligatoire pour les retraits par Skrill uniquement.
sightline	conditional	object	Il s'agit de paramètres supplémentaires pour Play+ (Sightline).
vippreferred	conditional	object	Il s'agit de paramètres supplémentaires pour VIP Preferred.
interacEtransfer	true	object	Obligatoire, si le marchand propose ce mode de paiement.
paypal	conditional	object	Il s’agit de paramètres supplémentaires pour PayPal. Obligatoire pour les retraits par PayPal uniquement.
pagoefectivo	true	object	Obligatoire, si le marchand propose ce mode de paiement.
applePay	true	object	Obligatoire, si le marchand propose ce mode de paiement.
mazooma	true	object	Informations relatives à Mazooma à transmettre dans l'objet.
SafetyPayBankTransfer	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
SafetyPayCash	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
BoletoBancario	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
PIX	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
KHIPU	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
MACH	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
SPEI	true	object	Obligatoire, si le marchand propose le mode de paiement SafetyPay.
interacEtransfer
accountId	true	string	Obligatoire s'il y a plusieurs comptes Apple Pay avec la même devise.
consumerId	true	string	Le numéro de téléphone ou l'adresse courriel du marchand (par défaut, l'adresse électronique).
type	false	string	Type de consumerID spécifié. SOIT EMAIL ou PHONE. Valeurs par défaut pour EMAIL
userCookie	true	string	Utilisé pour le contrôle des risques à PT. Soit userCookie ou deviceId doit être spécifié.
deviceId	true	string	Utilisé pour le contrôle des risques à PT. Soit userCookie ou deviceId doit être spécifié.
paypal
consumerId length<=50	true	string	La source des fonds pour le paiement, l'adresse courriel du consommateur ou du payeur.
accountID length<=10	Conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
recipientDescription length<=127	false	string	Une étiquette qui remplace le nom de l'entreprise dans le compte PayPal du marchand sur les pages de paiement PayPal.
language length=2	false	string	Code à deux caractères de la langue préférée du consommateur (par exemple, AU, AT, BE, BR, CA, CH, CN, DE, ES, GB, FR, IT, NL, PL, PT, RU ou US) ou un code à cinq caractères est également valide pour les langues de ces pays (par exemple) : da_DK, he_IL, id_ID, ja_JP, no_NO, pt_BR, ru_RU, sv_SE, th_TH, zh_CN, zh_HK et zh_TW)
shippingPreference	false	enum	La préférence de livraison. Les valeurs éventuelles sont : NO_SHIPPING - Expurge l'adresse de livraison des pages PayPal. Recommandé pour les produits numériques. GET_FROM_FILE - Utilise l'adresse de livraison sélectionnée par le client sur les pages PayPal. SET_PROVIDED_ADDRESS. Si disponible, utilise l'adresse de livraison fournie par le marchand, que le client ne peut pas modifier sur les pages PayPal. Si le marchand ne fournit pas d'adresse, le client peut la saisir sur les pages PayPal.
consumerMessage	false	string	Remarque à afficher sur la page PayPal.
orderDescription	false	string	Description de la commande à afficher sur la page PayPal. Si le marchand ne renseigne pas ce champ, la valeur par défaut est «Paiement pour la commande ».
recipientType	true	string	Type de destinataire de paiement. La seule valeur prise en charge est « PAYPAL_ID ».
pagoefectivo
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes PagoEfectivo avec la même devise.
consumerId	true	string	L’identifiant du client dans PagoEfectivo.
client
firstName length<=80	true	string	Le prénom du client.
lastName length<=80	true	string	Le nom du client.
adresse courriel length<=255	true	string	L’adresse courriel du client.
dateOfBirth	true	object	La date de naissance du client.
adresse courriel	true	object	Obligatoire si le marchand propose les modes de paiement PagoEfectivo et SafetyPay.
phone	true	object	Obligatoire si le marchand propose le mode de paiement PagoEfectivo.
payoutConfig
maximumAmount llength=1-9	true	number	Indique le montant maximum qu'un utilisateur est autorisé à retirer de la caisse dans la session en cours.
carte
accountID length<=10	Conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
paysafecard
consumerId length<=50	true	string	Il s'agit de l'identifiant du client que le marchand a stocké dans son système pour les paiements Paysafecard.
accountID length<=10	Conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
paysafecash
consumerId length<=50	true	string	Il s'agit de l'identifiant du client que le marchand a stocké dans son système pour les paiements Paysafecash.
accountID length<=10	Conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
sightline
consumerId length<=50	true	string	Il s'agit d'un numéro d'identification du consommateur que le marchand a stocké pour les paiements Play+ (Sightline). Cette information sera utilisée par Play+ pour l'inscription des clients.
NAS length=9	false	string	Il s'agit du numéro d'assurance sociale du client. S'il est renseigné, le champ des 4 derniers chiffres du NAS sera pré-rempli et verrouillé lors de l'inscription ainsi que pendant le flux de paiement. S'il n'est pas fourni, le client doit saisir son NAS complet lors de l'inscription et les 4 derniers chiffres du NAS dans le flux de paiement.
last4ssn length=4	false	string	Il s'agit des 4 derniers chiffres du numéro d'assurance sociale du client. Si le client est déjà inscrit à Sightline, au lieu d'envoyer le champ du NAS complet, vous pouvez envoyer les 4 derniers chiffres du NAS qui seront préremplis pendant le flux de paiement. S'il n'est pas renseigné, le système vérifiera si le champ « NAS » est présent pour préremplir les 4 derniers chiffres. Si ces deux champs ne sont pas renseignés, le client doit saisir les 4 derniers chiffres de son NAS pour effectuer le paiement.
accountID length<=10	Conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
applepay
accountid	true (conditional)	string	Obligatoire s'il y a plusieurs comptes Apple Pay avec la même devise.
label	false	string	Affiché sur la fiche de paiement.
type	false	string	("plain", "buy", "addMoney", "book", "checkout", "continue", "contribute", "donate", "instore", "order", "reload", "rent", "setup", "subscribe", "support", "tip", "topup") Default; pay Cliquez ici pour consulter les lignes directrices d’Apple. Si aucune valeur n'est fournie ou si elle est erronée, la caisse créera des boutons avec des valeurs par défaut.
color	false	string	(white, black, white-outline) Default: white-outline « Cliquez ici pour consulter les lignes directrices d'Apple ». Si aucune valeur n'est fournie ou si elle est erronée, la caisse créera des boutons avec des valeurs par défaut.
skrill
consumerId length <= 50	true	string	Il s'agit de l'identifiant d’adresse courriel Skrill du consommateur à payer. Obligatoire pour les retraits à la caisse. Le marchand doit avoir stocké ces données avant que le consommateur n'effectue un paiement par Skrill.
paymentId length <= 36	false	string	Il s'agit de l'identifiant renvoyé dans la réponse à un paiement antérieur effectué par le client à l'aide d'Instant ACH(CCA). Obligatoire pour les retraits à la caisse.
emailSubject length <= 30	true	string	Il s'agit de la ligne d'objet à utiliser dans le courriel du client. Obligatoire pour les retraits à la caisse.
emailMessage length <= 50	true	string	Il s'agit du message à utiliser dans le courriel du client. Obligatoire pour les retraits à la caisse.
recipientDescription length <= 30	false	string	Une description à afficher sur la page de paiement Skrill dans la zone du logo, s'il n’y a pas de paramètre logo_url. Si aucune valeur n'est soumise et qu'il n'y a pas de logo, la valeur « merchant_skrill_email » est indiquée comme destinataire du paiement.
language length <= 2	false	string	Code à deux caractères de la langue préférée du consommateur (par exemple : EN, FR).
logoUrl	false	string	L'URL du logo que vous souhaitez voir apparaître en haut à droite de la page Skrill. Le logo doit être accessible via HTTPS, sinon il ne sera pas affiché. Le logo sera redimensionné. Pour éviter les distorsions d'échelle, la taille minimale doit être la suivante : Si le logo a une largeur et une hauteur - au moins 107px de large Si le logo a une largeur et une hauteur - au moins 65px de haut Évitez les images de grande taille (plus de 256 x 256 px) afin de réduire le temps de chargement de la page.
detail1Description	false	string	Vous pouvez afficher des détails supplémentaires sur le produit dans la section Plus d'informations dans l'en-tête de Quick Checkout.
detail1Text	false	string	Le detail1Text est affiché à côté du detail1Description dans la section Plus d'informations dans l'en-tête du formulaire de paiement avec les autres détails du paiement. La detail1Description combinée au detail1Text est affichée dans le champ « Plus d'informations » du fichier CSV de l'historique du compte du marchand.
accountID length <= 10	conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
vippreferred
consumerId length=9	true	string	Il s'agit du numéro d'assurance sociale du client.
accountId length<=10	conditional	string	Si vous êtes un marchand, ce champ n'est obligatoire que si vous avez plus d'un compte configuré pour le même mode de paiement et la même devise.webhooks Si vous êtes un partenaire utilisant une clé API partagée, ce champ est obligatoire.
dateOfBirth
year length=4 min=1900	true	number	Il s’agit de l'année de naissance.
month length=2 max=12	true	number	Il s’agit du mois de naissance.
day length=2 max=31	true	number	Il s’agit du jour de naissance.
merchantDescriptor
dynamicDescriptor length<=20	true	string	Il s'agit d'un descripteur de marchand.
phone length<=13	true	string	Il s'agit du numéro de téléphone du marchand, qui sera ajouté au descripteur du marchand.
mazooma
consumerId	true	string	Le consumerId Mazooma à transmettre dans l'objet Mazooma.
SafetyPayBankTransfer
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.
SafetyPayBankCash
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.
BoletoBancario
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.
PIX
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.
KHIPU
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.
MACH
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.
SPEI
consumerId	true	string	L'identifiant du client dans SafetyPay.
accountId	conditional	string	Obligatoire s'il y a plusieurs comptes avec la même devise.

resultCallback

Le rappel de résultat est invoqué lorsqu’un jeton est émis ou qu’une erreur de tokenisation se produit.

La signature est la suivante :

Paramètre	Requis	Type	Description
instance	true	object	Instance Paysafe Checkout
error	false	object	Objet contenant des informations sur l’erreur. Ce champ est présent en cas d’échec de la tokenisation. Le contenu de cet objet est décrit ci-dessous.
result	false	object	Le résultat contenant le jeton de paiement. Le contenu de cet objet est décrit ci-dessous.
{return}	false	undefined
instance
isOpen	true	function	Vérifie si la superposition est encore ouverte.
close	true	function	Ferme la superposition sans afficher le résultat du paiement.
showSuccessScreen	true	function	Modifie la présentation de la caisse pour en faire un écran de réussite.
showFailureScreen	true	function	Modifie la présentation de la caisse pour en faire un écran d’échec.
error
code	true	string	Code d’erreur court identifiant le type d’erreur.
displayMessage	true	string	Fournit un message d’erreur qui peut être affiché aux utilisateurs.
detailedMessage	true	string	Fournit un message d'erreur détaillé qui peut être consigné.
correlationId	true	string	Identifiant unique qui peut être fourni à l’équipe de soutien Paysafe comme référence pour l’investigation.
fieldErrors	false	array	Détails de toute erreur de valeur de paramètre (facultatif). Actuellement, seulement lorsqu’une erreur 9003 est générée.
fieldError
field	true	string	Nom du champ. Par exemple : threeDS.userAccountDetails.userLogin.time.
message	true	string	Erreur dans le champ.
result
token	true	string	Jeton de paiement représentant les données sensibles de la carte et du compte bancaire en cas de tokenisation réussie. Vous devrez envoyer ce jeton de manière sécurisée à votre serveur pour effectuer un paiement à l’aide de l’API Paiements par carte, Prélèvement automatique ou Paiements alternatifs.
paymentMethod	true	string	Il s’agit du mode de paiement utilisé par le client : Cartes DirectDebit Interac PayPal
saveInstrument	false	boolean	Marqueur indiquant si l’instrument de paiement doit être sauvegardé.
setInstrumentAsDefault	false	boolean	Marqueur indiquant si l’instrument de paiement doit être défini par défaut.

Voici un exemple :

function(instance, error, result) {        

if (result.token) {



	// Successfully tokenized card, use result.token to process a payment

             

	console.log(result.token);



	// add AJAX code to send token to your merchant server



	instance.showSuccessScreen("Your goods are now purchased. Expect them to be delivered in next 5 business days.");         

} else {



	// tokenization failed



	instance.showFailureScreen("The payment was declined. Please, try again with the same or another payment method.");          

}



}

closeCallback

Invoquée lorsque le client ferme la fenêtre de paiement. Cette fonction a la signature suivante :

Paramètre	Requis	Type	Description
stage	true	string	Phase pendant laquelle la fenêtre de la caisse est fermée. Les valeurs éventuelles sont : BeforePayment DuringPayment AfterPayment
{return}	false	any

Paramètre

Requis

Type

Description

stage

true

string

Phase pendant laquelle la fenêtre de la caisse est fermée. Les valeurs éventuelles sont :

BeforePayment
DuringPayment
AfterPayment

{return}

false

any

Exemple d’utilisation :

function(stage) {

if (stage === "BeforePayment") {

	// No payment have been made

} else if (stage === "DuringPayment") {

	// Token have been issued, but the checkout overlay was closed from the user before instance flow control method was invoked

} else if (stage === "AfterPayment") {

	// Closed either via instance.close method or by the user from the success screen

}

eventCallback

Invoquée immédiatement après l’apparition d’un ou de plusieurs événements dans Paysafe Checkout.

Modes de paiement > modifier la carte enregistrée
Modes de paiement > supprimer la carte enregistrée

Paramètre		Requis	Type	Description
instance		true	object	Instance de passage à la caisse avec fonctions de contrôle des flux
	isOpen	true	function	Vérifie si la superposition est encore ouverte.
	close	true	function	Ferme la superposition sans afficher le résultat du paiement.
	showSuccessScreen	true	function	Modifie la présentation de la superposition pour en faire un écran de réussite
	showFailureScreen	true	function	Modifie la présentation de la caisse pour en faire un écran d’échec
événement		true	object	L’événement qui s’est produit.
	action	true	string[]	Action exécutée côté client Valeurs éventuelles : Événements relatifs au mode de paiement setAsDefault expiryDateModified deleted Traiter uniquement les actions requises par le besoin de mise en œuvre actuel. D’autres actions peuvent être ajoutées à l’avenir.
	correlationId	false	string	Identifiant unique qui peut être fourni à l’équipe de soutien Paysafe comme référence pour l’analyse.
	paymentToken	false	string	le paymentToken du type de paiement, sur lequel l’événement est exécuté. Certaines actions n’ont pas de paymentToken connexe. Sa valeur peut être vide.

Exemple d’utilisation

function(instance, event) {

    if (event.action.indexOf("setAsDefault") > -1) {

	    // Payment method saved as default

    }

	if (event.action.indexOf("expiryDateModified") > -1) {

	    // Payment method saved expiry date has changed

    }

	if (event.action.indexOf("deleted") > -1) {

	    //  Payment method deleted

    }

}

Erreurs de configuration

Code	Message affiché	Message détaillé	Description
9004	Une erreur est survenue (9004); veuillez contacter notre service de soutien.	Callback doit être une fonction.
9012	Une erreur s’est produite (9012); veuillez contacter notre service de soutien.	Nombre d’arguments non valides	Utilisé lorsque le nombre d’arguments fourni n’est ni 3 ni 4.
9062	Une erreur est survenue (9062); veuillez contacter notre service de soutien.	Paysafe Checkout est déjà ouvert.	La fonction de configuration a été invoquée et Paysafe Checkout est déjà ouvert ou en cours de chargement.

Erreurs transmises lors du resultCallback

Code	Message affiché	Message détaillé	Description
9012	Une erreur s’est produite (9012); veuillez contacter notre service de soutien.	Nombre d’arguments non valides	Utilisé lorsque le nombre d’arguments fourni n’est ni 3 ni 4.
9013	Une erreur s’est produite (9013); veuillez contacter notre service de soutien.	Paramètre apiKey non valide.	Utilisé lorsque le paramètre fourni n’est pas une chaîne, que son format n’est pas valide ou qu’il n’est pas configuré pour Paysafe Checkout.
9014	Une erreur s’est produite (9014); veuillez contacter notre service de soutien.	Une erreur non gérée s’est produite.	Utilisé lorsqu’une erreur non gérée par la SDK Paysafe Checkout est déclenchée.
9015	Il y a eu une erreur (9015), veuillez contacter notre service de soutien.	Argument d’options non valide.	Utilisé lorsque le paramètre options fourni n’est pas un objet.
9017	Une erreur est survenue (9017); veuillez contacter notre service de soutien.	Les options d’environnement ne sont ni une chaîne ni un objet.	Utilisé lorsque l’environnement fourni n’est pas une chaîne ni un objet.
9018	Une erreur est survenue (9018); veuillez contacter notre service de soutien.	L’environnement ne correspond à aucune des valeurs prédéfinies (possible : TEST, LIVE; actual: ${environment}).
9043	Une erreur est survenue (9043); veuillez contacter notre service de soutien.	HolderName doit être un nom valide.	Utilisé lorsque le paramètre holderName fourni n’est pas une chaîne.
9044	Une erreur est survenue (9044); veuillez contacter notre service de soutien.	Le paramètre BillingAddress country doit être un code de pays valide.	Utilisé lorsque le paramètre billingAddress.country fourni n’est pas une chaîne.
9045	Une erreur est survenue (9045); veuillez contacter notre service de soutien.	Le paramètre BillingAddress zip doit être un code postal valide.	Utilisé lorsque le paramètre billingAddress.zip fourni n’est pas une chaîne.
9046	Une erreur est survenue (9046); veuillez contacter notre service de soutien.	Le paramètre BillingAddress state doit être un État valide.	Utilisé lorsque le paramètre billingAddress.state fourni n’est pas une chaîne.
9047	Une erreur est survenue (9047); veuillez contacter notre service de soutien.	Le paramètre BillingAddress city doit être une ville valide.	Utilisé lorsque le paramètre billingAddress.city fourni n’est pas une chaîne.
9048	Une erreur est survenue (9048); veuillez contacter notre service de soutien.	Le paramètre BillingAddress street doit être une rue valide.	Utilisé lorsque le paramètre billingAddress.street fourni n’est pas une chaîne.
9049	Une erreur est survenue (9049); veuillez contacter notre service de soutien.	Le paramètre BillingAddress street2 doit être valide.	Utilisé lorsque le paramètre billingAddress.street2 fourni n’est pas une chaîne.
9052	Une erreur est survenue (9052); veuillez contacter notre service de soutien.	billingAddress doit être un objet.	Utilisé lorsque le paramètre billingAddress fourni n’est pas un objet.
9053	Une erreur est survenue (9053); veuillez contacter notre service de soutien.	Paramètre companyName non valide.	Utilisé lorsque le paramètre companyName fourni n’est pas une chaîne.
9054	Une erreur est survenue (9054); veuillez contacter notre service de soutien.	Paramètre de montant non valide.	Utilisé lorsqu’un montant n’est pas fourni, n’est pas un nombre, n’est pas positif ou est supérieur à 9 chiffres.
9055	Une erreur s’est produite (9055); veuillez contacter notre service de soutien.	Paramètre de devise non valide.	Utilisé lorsque le paramètre currency fourni n’est pas une chaîne.
9057	Une erreur est survenue (9057); veuillez contacter notre service de soutien.	Paramètre locale non valide.	Utilisé lorsque le paramètre locale fourni ne correspond pas aux valeurs prises en charge.
9059	Une erreur est survenue (9059); veuillez contacter notre service de soutien.	Accounts doit être un objet.	Utilisé lorsque le paramètre accounts fourni n’est pas un objet.
9060	Une erreur est survenue (9060); veuillez contacter notre service de soutien.	Le rappel de fermeture doit être une fonction.	Utilisé lorsque closeCallback fourni n’est pas une fonction.
90619061	Une erreur est survenue (9061); veuillez contacter notre service de soutien.	Identifiant de compte invalide pour ${paymentMethod}.	Utilisé lorsque Idaccount fourni pour un mode de paiement spécifique n’est pas un nombre ou n’est pas positif.
9062	Une erreur est survenue (9062); veuillez contacter notre service de soutien.	Paysafe Checkout est déjà ouvert.	La fonction de configuration a été invoquée et Paysafe Checkout est déjà ouvert ou en cours de chargement.
9063	Une erreur s’est produite (9063); veuillez contacter notre service de soutien.	Paramètre buttonColor non valide.	Utilisé lorsque la couleur fournie n’est pas une couleur hexagonale valide, par exemple ’#ee33ee’.
9064	Une erreur est survenue (9064); veuillez contacter notre service de soutien.	Échec de l’initialisation de l’iframe Paysafe Checkout.	Utilisé lorsque l’iframe de paiement n’a pas réussi à s’initialiser dans les 5 secondes; la raison peut être que le serveur qui sert HTML pour l’iframe n’est pas disponible pour le moment.
9065	Une erreur est survenue (9065); veuillez contacter notre service de soutien.	Mode de paiement non valide : ${paymentMethod}.	Utilisé lorsque preferredPaymentMethod fourni n’est pas l’un des suivants : Cartes DirectDebit Interac PayPal
9073	Une erreur s’est produite (9073); veuillez contacter notre service de soutien.	Le compte n’est pas configuré correctement.	Utilisé lorsque l’identifiant ou la devise du compte a été mal configuré.
9094	Une erreur est survenue (9094); veuillez contacter notre service de soutien.	Paramètre displayPaymentMethods non valide.	Utilisé pour les motifs suivants : Le paramètre displayPaymentMethods n’est pas un ensemble de chaînes valide. L’ensemble est vide ou plus de 4 modes de paiement ont été transmis. Un ou plusieurs des éléments transmis dans l’ensemble ne sont pas des modes de paiement valides : Cartes DirectDebit Interac PayPal
9095	Une erreur est survenue (9095); veuillez contacter notre service de soutien.	Saisies en double dans le paramètre displayPaymentMethods non autorisées.	Utilisé lorsque des méthodes de paiement en double sont transmises dans le paramètre displayPaymentMethods.
9096	Une erreur est survenue (9096); veuillez contacter notre service de soutien.	Votre compte n’est pas configuré pour la transmission de displayPaymentMethods. Modes de paiement pris en charge : ${supportedPaymentMethods}.	Utilisé lorsqu’un ou plusieurs des modes de paiement fournis dans le paramètre displayPaymentMethods ne correspondent pas aux modes de paiement configurés pour le marchand.
9098	Une erreur est survenue (9098); veuillez contacter notre service de soutien.	Le rappel d’événement doit être une fonction.	Utilisé lorsque le paramètre eventCallback fourni n’est pas une fonction.
9106	Une erreur est survenue (9106); veuillez contacter notre service de soutien.	Paramètre buttonLabel non valide.	Utilisé lorsque la valeur fournie pour le paramètre buttonLabel dépasse 40 caractères.
9107	Une erreur est survenue (9107); veuillez contacter notre service de soutien.	Paramètre singleUseProfileToken non valide.	Utilisé lorsque supplied singleUseProfileToken est non valide ou expiré.
9108	Une erreur est survenue (9108); veuillez contacter notre service de soutien.	Valeur showSaveCardCheckboxes non valide.	Utilisé lorsque les showSaveCardCheckboxes fournies sont non valides.
9109	Une erreur est survenue (9109); veuillez contacter notre service de soutien.	Valeur hideAmount non valide.	Utilisé lorsque la valeur fournie pour hideAmount est non valide.
9110	Il y a eu une erreur (9110), veuillez contacter notre service de soutien.	Impossible de lancer la SDK ThreeDs.	Utilisé lorsque la SDK ThreeDs n’a pas réussi à se charger ou que le rappel de démarrage de la SDK ThreeDs a été invoqué avec une erreur non gérée.
9111	Il y a eu une erreur (9111), veuillez contacter notre service de soutien.	Configuration du marchand non valide.	Utilisé lorsque la configuration marchand n’est pas valide
9112	Une erreur est survenue (9112); veuillez contacter notre service de soutien.	Paramètre threeDS useThreeDSecureVersion2 non valide.	Utilisé lorsque le paramètre useThreeDSecureVersion2 fourni n’est pas un booléen.
9113	Une erreur est survenue (9113); veuillez contacter notre service de soutien.	L’identifiant de compte fourni n’est pas activé pour la version 2 de 3DS.	Utilisé lorsque accountId fourni (accounts.CC) n’est pas activé pour la version 2 de 3DS.
9114	Il y a eu une erreur (9114), veuillez contacter notre service de soutien.	Impossible de lancer le défi de la SDK ThreeDs.	Utilisé lorsque le rappel de défi de la SDK ThreeDs est invoqué avec une erreur.
9115	Une erreur est survenue (9115); veuillez contacter notre service de soutien.	ShippingAddress doit être un objet.	Utilisé lorsque le paramètre shippingAddress fourni n’est pas un objet.
9116	Une erreur est survenue (9116); veuillez contacter notre service de soutien.	ShippingAddress recipientName doit être un nom de destinataire valide.	Utilisé lorsque le paramètre shippingAddress.recipientName fourni n’est pas une chaîne.
9117	Une erreur est survenue (9117); veuillez contacter notre service de soutien.	ShippingAddress street doit être une rue valide.	Utilisé lorsque le paramètre shippingAddress.street fourni n’est pas n’est pas une chaîne.
9118	Une erreur est survenue (9118); veuillez contacter notre service de soutien.	ShippingAddress street2 doit être une rue valide.	Utilisé lorsque le paramètre shippingAddress.street2 fourni n’est pas une chaîne.
9119	Une erreur est survenue (9119); veuillez contacter notre service de soutien.	ShippingAddress city doit être une ville valide.	Utilisé lorsque le paramètre shippingAddress.city fourni n’est pas une chaîne.
9120	Une erreur est survenue (9120); veuillez contacter notre service de soutien.	ShippingAddress state doit être un État valide.	Utilisé lorsque le paramètre shippingAddress.state fourni n’est pas une chaîne.
9121	Une erreur est survenue (9121); veuillez contacter notre service de soutien.	ShippingAddress country doit être valide.	Utilisé lorsque le paramètre shippingAddress.country fourni n’est pas une chaîne.
9122	Une erreur est survenue (9122); veuillez contacter notre service de soutien.	ShippingAddress zip doit être un code postal valide.	Utilisé lorsque le paramètre shippingAddress.zip fourni n’est pas une chaîne.
9123	Une erreur est survenue (9123); veuillez contacter notre service de soutien.	Paramètre de préférence de livraison PayPal non valide.	Utilisé lorsque paypal.ShippingPreference fourni ne correspond pas aux valeurs prises en charge.
9125	Il y a eu une erreur (9125), veuillez contacter notre service de soutien.	Marque de carte non prise en charge utilisée : [...].	Utilisé lorsque le client utilise une carte dont la marque n’est pas prise en charge par la configuration 3D Secure 2 du marchand.
9003	Invalid fields: ${fields}.	Invalid fields: ${fields}. Par exemple, champs non valides : threeDS.authenticationPurpose,threeDS.billingCycle.endDate.	Un ou plusieurs champs ont des valeurs non valides. L’erreur pour les champs non valides provient des validations frontales ou lorsque l’API 3D Secure 2 renvoie l‘erreur 5068. Les valeurs éventuelles sont tous les champs liés à 3D Secure 2, soit threeDS.billingCycle.endDate
9004	Une erreur est survenue (9004); veuillez contacter notre service de soutien.	Callback doit être une fonction.

Cette page a-t-elle été utile ?

Sur cette page

Environnement
Test
Production
resultCallback
closeCallback
eventCallback
Erreurs de configuration
Erreurs transmises lors du resultCallback

Search Overlay

Fonction de configuration

Cette page a-t-elle été utile ?

Merci pour votre réponse!