Passer au contenu principal

Entrées de configuration prises en charge

Les entrées de configuration sont des paramètres et des options qui définissent le fonctionnement et le comportement du processus de paiement.

Les entrées de configuration peuvent être définies dans votre solution Ventrata Checkout en utilisant l’une des deux méthodes suivantes :

  • Mise à jour de l’attribut data-config Ajoutez le bloc de code ci-dessous en remplaçant input par le nom de l’une des entrées prises en charge et en spécifiant sa valeur (voir le tableau de configuration ci-dessous).
    Plusieurs entrées peuvent être incluses, séparées par une virgule (,).

    "input1" : "value", "input2" : "value"

  • Ajouter une entrée au script ou au bouton – ajoutez l’entrée à l’attribut data-config du script ou du bouton selon le format ci-dessous. Plusieurs entrées peuvent être incluses, séparées par une virgule (,).

    <script
    src="https://cdn.checkout.ventrata.com/v3/production/ventrata-checkout.min.js" type="module" data-config='{"apiKey":"<YOUR_API_TOKEN>", "input1": "value", "input2": "value" } }'>
    </script>

Le système de checkout de Ventrata prend en charge les entrées de configuration suivantes :

Entrée

Par défaut

Description

"lang"

par défaut non défini

optionnel, en minuscules, par exemple, en, cs

📒 REMARQUE

Si les deux "lang" et "currency" sont spécifiés dans le data-config, l'icône du globe utilisée pour sélectionner la langue et la devise lors du checkout est masquée car ces paramètres sont prédéfinis. Ceci est généralement utilisé avec la fonction de multi-réservation.

"currency"

par défaut non défini

optionnel, en majuscules, par exemple, USD, EUR, CZK

📒 REMARQUE

Si les deux "lang" et "currency" sont spécifiés dans le data-config, l'icône du globe utilisée pour sélectionner la langue et la devise lors du checkout est masquée car ces paramètres sont prédéfinis. Ceci est généralement utilisé avec la fonction de multi-réservation.

"env"

par défaut non défini

"live" OU "test" ; si laissé vide, le checkout utilise par défaut test

"apiKey"

votre apiKey DOIT être défini au moins une fois par importation de script

votre apiKey se trouve dans votre tableau de bord Ventrata

"embedded"

false

Permet l'utilisation du mode intégré (embedded).

La page nécessite la présence d'un élément HTML avec l'attribut ventrata-embedded-widget attribut.

"multibooking"

false

Permet l'utilisation d'un panier (ayant plusieurs réservations pour la même commande).

Cela déclenchera la barre inférieure, qui informe les utilisateurs du contenu actuel de la commande.

"productID"

par défaut non défini

ID du produit

Si non défini, la liste des produits sera affichée.

"optionID"

par défaut non défini

ID de l'option

si défini, l'option est pré-sélectionnée

"bookingID"

par défaut non défini

ID de la réservation (utilisé uniquement pour multibooking)

Sa présence doit être associée à orderID.

"orderID"

par défaut non défini

ID de la commande

ID de la commande. Obligatoire chaque fois que vous ouvrez une commande prédéfinie, par exemple avec bookingID (réservation multiple) ou avec page, voir Comment déclencher le paiement sur une page spécifique. bookingID est obligatoire en complément lorsque vous ciblez une réservation spécifique au sein d'une commande multiple.

📒 REMARQUE
Si la commande a été créée en dehors de la session de navigateur qui s'apprête à l'ouvrir, transmettez également recoveryToken (voir ci-dessous). orderID seul ne suffit pas à prouver que votre session est autorisée à l'ouvrir.

"recoveryToken"

par défaut non défini

Jeton renvoyé lors de la création d'une commande, en même temps que son orderID. Obligatoire avec orderID lorsque vous ouvrez une commande dans une session de navigateur différente de celle qui l'a créée, par exemple une commande créée par votre propre back-end via l'API, ou une commande que vous rouvrez dans un nouvel onglet ou après un rechargement de page.

Non requis pour une commande créée par le Checkout Widget lui-même dans la session en cours du client, car il dispose déjà de cette information en interne.

‼️ IMPORTANT
Traitez recoveryToken comme des identifiants de connexion (credentials) : toute personne en possession de ce jeton peut ouvrir cette commande et agir sur celle-ci. Transmettez-le uniquement via HTTPS et évitez de le consigner dans des journaux (logs).

"checkMarketingConsent"

par défaut non défini

si défini sur true, le consentement marketing sera pré-sélectionné pour les utilisateurs sur la Coordonnées de la Checkout page

"referrer"

par défaut non défini

valeur chaîne, par exemple, hilton.com

"promoCode"

par défaut non défini

valeur chaîne, existant code promotionnel

"page"

par défaut non défini

valeur chaîne ; déclencher le paiement avec une page spécifique dans le processus de paiement telle que Billets ou Checkout; utiliser uniquement en combinaison avec orderID,

valeurs prises en charge : [

"upgrade"/ "cross-sell" / "pickups" / "dropoffs" / "questions" / "order-questions" / "cart-summary" / ”checkout” / "package-availability"

] > {"page": "checkout"}

"dateToPreselect"

par défaut non défini

déclencher le checkout avec une date de visite spécifique

utiliser le format ISO 8601 (AAAA-MM-JJ); inclure ce paramètre dans le data-config, à côté de apiKey et productID

"timeslotToPreselect"

par défaut non défini

déclencher le checkout avec une heure de visite spécifique ;

inclure ce paramètre dans le data-config, à côté de apiKey et productID

Avez-vous trouvé la réponse à votre question ?