Ajouter des champs personnalisés
Mise en garde
N’utilisez pas de champs personnalisés pour collecter des données personnelles, protégées ou sensibles ni des informations faisant l’objet de restrictions légales.
Vous pouvez ajouter des champs personnalisés au formulaire de paiement afin de recueillir des informations supplémentaires auprès de vos clients. Les informations seront disponibles une fois le paiement effectué et pourront servir à traiter la commande.
Limitations
- Jusqu’à trois champs autorisés.
- Non disponible en mode
setup
. - Prise en charge de 255 caractères maximum dans les champs de texte.
- Prise en charge de 255 chiffres maximum dans les champs numériques.
- Prise en charge de 200 options maximum dans les champs des listes déroulantes.
Créer une session Checkout
Créez une session Checkout en spécifiant un tableau de champs personnalisés. Chaque champ doit être associé à une key
unique que votre intégration utilise pour rapprocher le champ. Indiquez également le libellé du champ qui sera affiché pour votre client. Les libellés de champs personnalisés ne sont pas traduits, mais vous pouvez utiliser le paramètre locale pour définir la langue de votre session Checkout correspondant à celle de vos libellés.
Récupérer des champs personnalisés
Lorsque votre client termine la session Checkout, nous lui envoyons un webhook checkout.session.completed avec les champs renseignés.
Exemple de charge utile checkout.session.completed
:
{ "id": "evt_1Ep24XHssDVaQm2PpwS19Yt0", "object": "event", "api_version": "2022-11-15", "created": 1664928000, "data": { "object": { "id": "cs_test_MlZAaTXUMHjWZ7DcXjusJnDU4MxPalbtL5eYrmS2GKxqscDtpJq8QM0k", "object": "checkout.session", "custom_fields": [{ "key": "engraving", "label": { "type": "custom", "custom": "Personalized engraving" }, "optional": false, "type": "text", "text": { "value": "Jane", } }], "mode": "payment", } }, "livemode": false, "pending_webhooks": 1, "request": { "id": null, "idempotency_key": null }, "type": "checkout.session.completed" }