Fonction de configuration
La fonction de configuration crée et initialise Paysafe Checkout dans une superposition. Elle comporte les paramètres suivants :
- La clé API publique fournie dans le portail d'entreprise. Notez que cette clé ne peut être utilisée que pour générer des jetons de "payment handle" à utiliser avec les paiements, et qu'elle n'a pas d'autres droits d'accès à l'API, tels que ceux requis pour percevoir des paiements. Par conséquent, cette clé peut être exposée publiquement dans le navigateur de l'utilisateur.
- Un objet options contient l'environnement à utiliser (Test ou Direct), le montant du paiement, la devise et plusieurs paramètres permettant d'afficher des fonctionnalités supplémentaires dans le formulaire de paiement.
- Une fonction resultCallback reçoit l'instance Paysafe Checkout, gère le "payment handle" réussi (en envoyant le "payment handle" à votre serveur marchand) ou répond à toute erreur causée par l'échec de la création d'un "payment handle".
- 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, Sightline et Apple Pay).
La signature de la fonction est la suivante :
paysafe.checkout.setup (apiKey, options, resultCallback, closeCallback, riskCallback)
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, lorsque le "payment handle" doit être transmis au marchand. 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. Invoqué lorsqu'un client ferme la caisse sans effectuer de paiement. |
| riskCallback | false | function | Fonction de rappel invoquée lorsque le marchand souhaite appliquer sa propre règle de risque en utilisant le montant et le mode de paiement. En fonction de la réponse du rappel, un gestionaire de paiement sera créé et renvoyé dans resultCallback (uniquement pour les cartes, PaySafe Cash, VIPP et Sightline). |
| {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 :
|
| 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 :
La valeur par défaut est « Live » |
| locale | false | string | Langue locale pour le passage à la caisse :
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 de paiements, les informations relatives à l'adresse provenant du singleUseCustomerToken seront utilisées et le marchand n'aura pas besoin d'inclure l'objet billingAddress. Remarque : Les informations relatives à l'adresse de cet objet seront affichées à la place des informations relatives à l'adresse du singleUseCustomerToken, si elles sont toutes deux incluses. L'adresse de facturation est requise pour Interchecks. |
| 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 Interchecks, Mazooma, Apple Pay, Paysafecash, Paysafecard, Skrill, Interac, virement Interac eTransfer, 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. |
| interchecks | true | object | Informations relatives à Interchecks à transmettre dans l'objet. |
| 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 | conditional | 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 | conditional | string | Utilisé pour le contrôle des risques à PT. Soit userCookie ou deviceId doit être spécifié. |
| deviceId | conditional | string | Utilisé pour le contrôle des risques à PT. Soit userCookie ou deviceId doit être spécifié. |
| question | true | string | S'affiche lorsque le client n'est pas inscrit au dépôt automatique. |
| answer | true | string | S'affiche lorsque le client n'est pas inscrit au dépôt automatique. Doit être utilisé par le client pour s'authentifier auprès d'Interac lorsqu'il n'est pas inscrit au dépôt automatique. |
| 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 :
|
| 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. |
| phone | true | object | Obligatoire si le marchand propose le mode de paiement 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. |
| 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. |
| requestShippingAddress | false | bool | La valeur par défaut est « false ». Si cette option est réglée sur « true », Apple Pay demandera une adresse de livraison. |
| requestBillingAddress | false | bool | La valeur par défaut est « false ». Si cette option est réglée sur « true », Apple Pay demandera une adresse de facturation. |
| supportedCountries | false | tableau de codes de pays à deux lettres de l'ISO 3166 | Limite les paiements aux cartes de certains pays. |
| 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. |
| interchecks | |||
| consumerId | true | string | Le Interchecks consumerId à transmettre dans l'objet Interchecks. |
| mazooma | |||
| consumerId | true | string | Le consumerId Mazooma à transmettre dans l'objet Mazooma. De même, le Interchecks consumerId doit être transmis dans l'objet Interchecks. |
| 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. |