Réponse PaymentOrder
Objet contenant les informations relatives à un ordre de paiement.
Référence de la réponse
amount
Montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
currency
Devise du paiement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.
Exemple: "EUR" pour l'euro.
Format
Valeurs possibles
Les valeurs possibles sont les suivantes:
Devise | CODIFICATION ISO 4217 | Unité fractionnaire |
---|---|---|
Dollar australien (036) | AUD | 2 |
Dollar canadien (124) | CAD | 2 |
Franc suisse (756) | CHF | 2 |
Couronne danoise (208) | DKK | 2 |
Euro (978) | EUR | 2 |
Livre Sterling (826) | GBP | 2 |
Yen (392) | JPY | 0 |
Couronne norvégienne (578) | NOK | 2 |
Couronne suédoise (752) | SEK | 2 |
Dollar des États-Unis (840) | USD | 2 |
channelType
Chemin: channelDetails.channelType
Type de l'ordre de paiement à créer. La valeur par défaut est URL.
Format
Valeurs possibles
Les valeurs possibles sont les suivantes:
Valeur | Description |
---|---|
L'ordre de paiement est envoyé par mail à l'acheteur | |
URL | Seule la création de l'URL de paiement renvoyée dans la réponse est effectuée |
SMS | L'ordre de paiement est envoyé par SMS à l'acheteur |
INVOICE | L'ordre de paiement est envoyé sous forme de facture à régler |
IVR | L'ordre de paiement est créé et payable via le SVI |
L'ordre de paiement est envoyé sur la messagerie WhatsApp de l'acheteur |
bcc
Chemin: channelDetails.mailDetails.bcc
BCC ("Blind Carbon Copy" ou "Copie Carbone Invisible"). Liste des destinataires supplémentaires de l'ordre de paiement. Ces destinataires ne sont pas visibles par le destinataire principal (recipient). Utilisez le point-virgule ";" comme séparateur entre chaque adresse.
Format
body
Chemin: channelDetails.mailDetails.body
Permet de personnaliser le corps de l'e-mail envoyé. Si le paramètre est laissé vide, le template par défaut sera appliqué.
Format
Contenu
Pour personnaliser le corps de l'e-mail, vous pouvez utiliser les variables ci-dessous:
Valeur | Description |
---|---|
%url% | URL de l'ordre de paiement. Si cette variable est absente, le lien de paiement sera ajouté automatiquement à la fin du message. |
%amount% | Montant et devise du paiement |
%start_date% | Date de création de l'ordre de paiement |
%end_date% | Date d'expiration de l'ordre de paiement |
%shop_name% | Nom de votre boutique tel que défini dans le Back Office |
%reference% | Référence de la commande |
%shop_url% | URL de votre boutique |
%shop_contact% | Adresse e-mail du "gestionnaire de la boutique" telle que définie dans le Back Office |
{: .lita-excluded-col1 } Exemple: Bonjour, cet e-mail comporte un lien de paiement d'un montant de %amount% valable jusqu'au %end_date%. Pour confirmer le paiement, cliquez sur le lien suivant: %url%
recipient
Chemin: channelDetails.mailDetails.recipient
Destinataire de l'e-mail.
Format
subject
Chemin: channelDetails.mailDetails.subject
Permet de personnaliser l'objet de l'e-mail. Ce paramètre est obligatoire sauf si vous spécifiez un nom de template valide dans le paramètre channelOptions.mailOptions.template.
Format
Contenu
Pour personnaliser l'objet de l'e-mail, utilisez les variables ci-dessous:
Valeur | Description |
---|---|
%url% | URL de l'ordre de paiement, il est important de la positionner dans le corp du mail |
%amount% | Montant et devise du paiement |
%start_date% | Date de création de l'ordre de paiement |
%end_date% | Date d'expiration de l'ordre de paiement |
%shop_name% | Nom de votre boutique tel que défini dans le Back Office |
%reference% | Référence de la commande |
%shop_url% | URL de votre boutique |
%shop_contact% | Adresse e-mail du "gestionnaire de la boutique" telle que définie dans le Back Office |
{: .lita-excluded-col1 } Exemple: Offre %reference% valable du %start_date% au %end_date% d'un montant de %amount%
message
Chemin: channelDetails.smsDetails.message
Message SMS à envoyer.
Format
phoneNumber
Chemin: channelDetails.smsDetails.phoneNumber
Numéro de téléphone sur lequel envoyer le SMS.
Format
phoneNumber
Chemin: channelDetails.whatsappDetails.phoneNumber
Numéro de téléphone sur lequel envoyer le messge WhatsApp.
Format
ivrPaymentOrderId
Chemin: channelDetails.ivrDetails.ivrPaymentOrderId
Champ normalement automatiquement renseigné par la plateforme. Si le marchand a des contraintes fonctionnelles spécifiques, ce champ pourra exceptionnellement être surchargé en entrée avec sa propre référence numérique en garantissant son unicité.
Format
orderId
Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.
Format
paymentOrderId
Référence unique de l'ordre de paiement générée par la plateforme.
Format
formAction
Permet de définir le type de comportement souhaité lors de la création de la transaction.
Valeurs possibles
Les valeurs possibles sont les suivantes :
Valeur | Description |
---|---|
PAYMENT | Création d'une transaction simple. Comportement par défaut. |
REGISTER | Création de l'alias sans paiement. Le montant doit être transmis à 0. |
REGISTER_PAY | Création de l'alias lors d'un paiement. |
REGISTER_UPDATE | Modification des informations associées à l’alias. |
REGISTER_UPDATE_PAY | Modification des informations associées à l’alias lors d'un paiement. |
ASK_REGISTER_PAY | Paiement avec proposition au porteur de créer un alias. |
null | Si la valeur est nulle ou non définie, la valeur PAYMENT s'applique. |
Format
creationDate
Date et heure de creation de l'ordre de paiement.
Format
message
Message de l'ordre de paiement.
Valeur | Description du message |
---|---|
URL | Message destiné à l'acheteur contenant l'URL de l'ordre de paiement |
Message constituant le contenu (body) du mail envoyé |
Format
updateDate
Date et heure de de mise à jour de l'ordre de paiement.
Format
paymentURL
URL à appeler pour afficher l'ordre de paiement
Format
paymentOrderStatus
Statut de l'ordre de paiement.
Format
Valeurs possibles
Les valeurs possibles sont les suivantes:
Valeur | Description |
---|---|
RUNNING | Ordre de paiement en cours. En attente de paiement |
PAID | Ordre de paiement payé |
REFUSED | Ordre de paiement refusé |
EXPIRED | Ordre de paiement expiré |
CANCELLED | Ordre de paiement annulé |
dataCollectionForm
Utilisation du formulaire de collecte de données. Si défini à true, le formulaire de collecte de données sera affiché avant le formulaire de paiement.
Format
expirationDate
Date et heure d'expiration de l'ordre de paiement, au format ISO-8601.
Format
locale
Paramètre Régional (ou locale) au format cc_XX où :
- cc représente le code langue (deux caractères minuscules conformes à la norme ISO-639 (exemple "de" pour l'allemand, "fr" pour le français, "en" pour l'anglais,)
- XX répresente le code pays (deux caractères majuscules conformes à la norme ISO-3166 (exemple : "DE" pour l'Allemagne, "FR" pour la France,"GB" pour le Royaune-Uni).
Permet de définir la langue des pages de paiement et de l'e-mail de confirmation. Si le paramètre n'est pas défini, la langue de la boutique est utilisée.
Format
merchantComment
Commentaire associé à l'ordre de paiement.
Permet par exemple d'indiquer une référence à propos de l'émetteur de l'ordre de paiement.
Limité à 100 caractères maximum.
Format
paymentReceiptEmail
Adresse e-mail de l'acheteur à laquelle le ticket de paiement est envoyé. Cette fonctionnalité ne peut fonctionner que si la règle de notification "E-mail de confirmation à destination de l'acheteur" est activée dans le Back Office.
Format
taxAmount
Montant des taxes pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
taxRate
Utilisé par certains moyens de paiement en Amérique Latine. Permet de transmettre le taux de taxe appliqué sur l’ensemble de la commande. La valeur doit être le pourcentage à appliquer (21 pour 21%).
Format
allowDCFAmountUpdate
allowDCFAmountUpdate permet de définir si la modification du montant est possible dans le formulaire de collecte de données. Ce champ ne peut être utilisé que si le champ dataCollectionForm est valorisé à true.
Format
Valeurs possibles
Les valeurs possibles sont les suivantes:
Valeur | Description |
---|---|
NONE | Le montant n'est pas modifiable. Comportement par défaut. |
LOWER | Le montant est modifiable uniquement à la baisse. |
GREATER | Le montant est modifiable uniquement à la hausse. |
LOWER_AND_GREATER | Le montant est modifiable à la baisse ou à la hausse. |
null | Si la valeur est nulle ou non définie, NONE s'applique. |
Format
metadata
Valeurs personnalisées rattachées à la transaction, au format json.
Exemple d'appel
Par exemple, pour passer une valeur personnalisée, ajoutez à votre requête :
{ "metadata": { "MyValueKey": "1234" } }
Cette valeur sera retournée dans l'objet transaction nouvellement créé.
Vous pouvez aussi utiliser les metadatas "orderInfo", "orderInfo2" et "orderInfo3" pour transmettre des informations additionnelles sur la commande.
Ces données seront ensuite visibles dans l'onglet Extra du détail de la transaction depuis votre
Format
returnMode
returnMode permet de spécifier la méthode de transmission des données utilisée lors du retour vers le site marchand.
Valeurs possibles
Les valeurs possibles sont les suivantes :
Valeur | Description |
---|---|
NONE | Aucun paramètre ne sera passé à l’URL de retour vers le site marchand. |
GET | Les champs de retour seront transmis à l’URL de retour sous la forme d’un formulaire HTTP GET (dans la « query string »). |
POST | Les champs de retour seront transmis à l’URL de retour sous la forme d’un formulaire HTTP POST. Si le retour boutique se fait sur un environnement non https alors le navigateur affichera un pop-up de sécurité à l’acheteur. |
null | Si la valeur est nulle ou non définie, NONE s'applique. |
Format
returnUrl
returnUrl permet de définir l'URL où sera redirigé par défaut l’acheteur après un appui sur le bouton Retourner à la boutique , si les URL errorUrl , refusedUrl , successUrl ou cancelUrl ne sont pas renseignées.
Si ce champ n’est pas transmis, la configuration du
Si aucune URL n’est définie dans le
Format
cancelUrl
cancelUrl permet de définir l'URL où sera redirigé l’acheteur si celui-ci appuie sur Annuler et retourner à la boutique avant d'avoir procédé au paiement.
Format
successUrl
successUrl permet de définir l'URL où sera redirigé l’acheteur en cas de succès du paiement, après appui du bouton Retourner à la boutique.
Format
refusedUrl
refusedUrl permet de définir l'URL où sera redirigé l’acheteur en cas de refus, après appui du bouton Retourner à la boutique.
Format
errorUrl
errorUrl permet de définir l'URL où sera redirigé l’acheteur en cas d'erreur de traitement interne.
Format
postWalletUrl
postWalletUrl permet de définir l'URL vers laquelle sera redirigé l'acheteur lors d'un paiement via un wallet en deux étapes.
Cette url est utilisée pour transmettre des informations relatives au choix de l’acheteur (e-mail, adresse de livraison, moyen de paiement, etc.).
A partir de ces éléments, le marchand peut décider de l'action à effectuer (ajuster des frais de port, enregistrer le moyen de paiement, etc.) avant de permettre à l'acheteur de finaliser son paiement.
Format
ipnTargetUrl
Vous pouvez surcharger l’URL de notification instantanée (également appelée IPN) dans le formulaire dans le cas où vous utilisez une seule boutique pour différents canaux de ventes, différentes typologies de paiement, différentes langues etc...
Format
redirectSuccessTimeout
Permet de définir un délai en secondes avant redirection automatique vers le site marchand à la fin d’un paiement accepté.
Sa valeur est comprise entre 0 et 300s.
Passé ce délai, l'acheteur sera dirigé vers l'URL renseignée dans le champ successUrl
. Si ce champ n'est pas renseigné, l'acheteur sera redirigé vers l'URL de retour renseignée dans le champ returnUrl
ou vers l’URL de retour renseignée dans le
Format
redirectErrorTimeout
Permet de définir un délai en secondes avant redirection automatique vers le site marchand à la fin d’un paiement refusé.
Sa valeur est comprise entre 0 et 300s.
Passé ce délai, l'acheteur sera dirigé vers l'URL renseignée dans le champ errorUrl
. Si ce champ n'est pas renseigné, l'acheteur sera redirigé vers l'URL de retour renseignée dans le champ returnUrl
ou vers l’URL de retour renseignée dans le
Format
customer.reference
Identifiant de l’acheteur chez le marchand.
Format
customer.email
Adresse e-mail de l'acheteur.
- Spécifications sur la structure de l'e-mail : RFC-2822
Format
address
Chemin: customer.billingDetails.address
Adresse de facturation.
Attention : Les caractères > et < ne sont pas autorisés.
Format
address2
Chemin: customer.billingDetails.address2
Informations complémentaires sur l'adresse de facturation.
Attention : Les caractères > et < ne sont pas autorisés.
Format
category
Chemin: customer.billingDetails.category
Type de client.
Format
Valeurs possibles
valeurs | Description |
---|---|
PRIVATE | Client de type Particulier |
COMPANY | Client de type Société |
cellPhoneNumber
Chemin: customer.billingDetails.cellPhoneNumber
Téléphone portable de l'acheteur.
Accepte tous les formats:
Exemples:
- 0623456789
- +33623456789
- 0033623456789
- (+34) 824 65 43 21
- 87 77 12 34
- Pour MB WAY:
Seul, le format international est accepté.
Par exemple, +351 est l'indicatif international du Portugal. Le numéro portugais 21 031 27 00 devient +351210312700.
Si le champ ne respecte pas ce format ou est absent, une nouvelle saisie sera proposée à l'acheteur.
Format
city
Chemin: customer.billingDetails.city
Ville de facturation.
Format
country
Chemin: customer.billingDetails.country
Pays de l'acheteur (en majuscule, suivant la norme ISO 3166-1 alpha-2).
Format
Valeurs possibles
Exemples de valeurs possibles :
Pays | Code |
---|---|
AUTRICHE | AT |
BRESIL | BR |
CORSE | FR |
COTE D'IVOIRE | CI |
FRANCE | FR |
GUADELOUPE | GP |
INDE | IN |
MARTINIQUE | MQ |
NOUVELLE-CALÉDONIE | NC |
ST-PIERRE-ET-MIQUELON | PM |
POLYNESIE FRANCAISE | PF |
district
Chemin: customer.billingDetails.district
Quartier de l'adresse de facturation.
Format
firstName
Chemin: customer.billingDetails.firstName
Prénom de l'acheteur.
Format
identityCode
Chemin: customer.billingDetails.identityCode
Identifiant national. Permet d'identifier de façon unique chaque citoyen au sein d'un pays.
Format
identityType
Chemin: customer.billingDetails.identityType
Type de pièce d'identité.
Format
language
Chemin: customer.billingDetails.language
Code de la langue de l'acheteur, selon la norme norme ISO 639-1.
Permet de spécifier la langue dans laquelle sont envoyés les e-mails de confirmation de paiement.
Format
Valeurs possibles
Exemples de valeurs possibles:
Langue | Code |
---|---|
Allemand (Allemagne) | DE |
Anglais (Royaume Uni) | EN |
Anglais (Etats-Unis ) | EN |
Chinois (Traditionnel) | ZH |
Espagnol (Espagne) | ES |
Espagnol (Chili) | ES |
Français (France) | FR |
Italien (Italie) | IT |
Japonais (Japon) | JP |
Néerlandais (Pays-Bas) | NL |
Polonais (Pologne) | PL |
Portugais (Brésil) | PT |
Portugais (Portugal) | PT |
Russe (Russie) | RU |
lastName
Chemin: customer.billingDetails.lastName
Nom de l'acheteur.
Format
legalName
Chemin: customer.billingDetails.legalName
Raison sociale.
Format
phoneNumber
Chemin: customer.billingDetails.phoneNumber
Numéro de téléphone de l'acheteur.
Accepte tous les formats:
Exemples:
- 0123456789
- +33123456789
- 0033123456789
- (00.571) 638.14.00
- 40 41 42 42
Format
state
Chemin: customer.billingDetails.state
Région (état) de l'adresse de facturation. Il est recommandé mais non obligatoire de passer la valeur en ISO-3166-2.
Format
streetNumber
Chemin: customer.billingDetails.streetNumber
Numéro de rue de l'adresse de facturation.
Caractères acceptés:
- Caractères alphabétiques (de "A" à "Z" et de "a" à "z")
- Espace
Format
title
Chemin: customer.billingDetails.title
Civilité de l’acheteur.
Exemples:
- Mr
- M.
- Mme
Format
zipCode
Chemin: customer.billingDetails.zipCode
Code postal de l'adresse de facturation.
Format
address
Chemin: customer.shippingDetails.address
Adresse de livraison.
Attention : Les caractères > et < ne sont pas autorisés.
Format
address2
Chemin: customer.shippingDetails.address2
Deuxième ligne d'adresse de livraison.
Attention : Les caractères > et < ne sont pas autorisés.
Format
category
Chemin: customer.shippingDetails.category
Type de client.
Format
Valeurs possibles
valeurs | Description |
---|---|
PRIVATE | Client de type Particulier |
COMPANY | Client de type Société |
city
Chemin: customer.shippingDetails.city
Ville de livraison.
Format
country
Chemin: customer.shippingDetails.country
Pays de livraison (en majuscule, suivant la norme ISO 3166-1 alpha-2).
Format
Valeurs possibles
Exemples de valeurs possibles:
Pays | Code |
---|---|
AUTRICHE | AT |
BRESIL | BR |
CORSE | FR |
COTE D'IVOIRE | CI |
FRANCE | FR |
GUADELOUPE | GP |
INDE | IN |
MARTINIQUE | MQ |
NOUVELLE-CALÉDONIE | NC |
ST-PIERRE-ET-MIQUELON | PM |
POLYNESIE FRANCAISE | PF |
deliveryCompanyName
Chemin: customer.shippingDetails.deliveryCompanyName
Nom de la société qui délivre le produit.
Format
district
Chemin: customer.shippingDetails.district
Quartier de l'adresse de facturation.
Format
firstName
Chemin: customer.shippingDetails.firstName
Prénom du destinataire.
Format
identityCode
Chemin: customer.shippingDetails.identityCode
Identifiant national. Permet d'identifier de façon unique chaque citoyen au sein d'un pays.
Format
lastName
Chemin: customer.shippingDetails.lastName
Nom de l'acheteur.
Format
legalName
Chemin: customer.shippingDetails.legalName
Raison sociale en cas de livraison en entreprise.
Format
phoneNumber
Chemin: customer.shippingDetails.phoneNumber
Numéro de téléphone de l'acheteur.
Accepte tous les formats:
Exemples:
- 0123456789
- +33123456789
- 0033123456789
- (00.571) 638.14.00
- 40 41 42 42
Format
shippingMethod
Chemin: customer.shippingDetails.shippingMethod
Mode de livraison.
Format
Valeurs possibles
Valeur | Description |
---|---|
RECLAIM_IN_SHOP | Retrait de marchandise en magasin. |
RELAY_POINT | Utilisation d'un réseau de points de retrait tiers (Kiala, Alveol, etc). |
RECLAIM_IN_STATION | Retrait dans un aéroport, une gare ou une agence de voyage. |
PACKAGE_DELIVERY_COMPANY | Livraison par transporteur (Colissimo, UPS, etc). |
ETICKET | Emission d'un billet électronique, téléchargement de produit virtuel. |
CARD_HOLDER_ADDRESS | Livraison chez l'acheteur. Réservé à un usage futur. |
VERIFIED_ADDRESS | Livraison à une adresse vérifiée. Réservé à un usage futur. |
NOT_VERIFIED_ADDRESS | Livraison à une adresse non vérifiée. Réservé à un usage futur. |
SHIP_TO_STORE | Livraison en magasin. Réservé à un usage futur. |
DIGITAL_GOOD | Livraison digitale. Réservé à un usage futur. |
ETRAVEL_OR_ETICKET | Billet électronique. Réservé à un usage futur. |
OTHER | Autre: Réservé à un usage futur. |
PICKUP_POINT | Retrait en point relais. Réservé à un usage futur. |
AUTOMATED_PICKUP_POINT | Retrait en point relais automatique. Réservé à un usage futur. |
shippingSpeed
Chemin: customer.shippingDetails.shippingSpeed
Délai de livraison.
Format
Valeurs possibles
Exemples de valeurs possibles:
Valeur | Description |
---|---|
STANDARD | Livraison standard |
EXPRESS | Livraison en moins de 24h |
PRIORITY | Livraison Prioritaire (Click & Collect) |
state
Chemin: customer.shippingDetails.state
Région de l'adresse de facturation.
Format
streetNumber
Chemin: customer.shippingDetails.streetNumber
Numéro de rue de l'adresse de livraison.
Caractères acceptés:
- Caractères alphabétiques (de "A" à "Z" et de "a" à "z")
- Espace
Format
zipCode
Chemin: customer.shippingDetails.zipCode
Code postal de l'adresse de facturation.
Format
insuranceAmount
Chemin: customer.shoppingCart.insuranceAmount
Montant de l’assurance pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
shippingAmount
Chemin: customer.shoppingCart.shippingAmount
Montant des frais de livraison pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
taxAmount
Chemin: customer.shoppingCart.taxAmount
Montant des taxes pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
cartItemInfo
Chemin: customer.shoppingCart.cartItemInfo
cardItemInfo est une liste qui contient des objets Customer/ShoppingCartItemInfo.
Il permet de décrire chaque article du panier.
Format
productAmount
Chemin: customer.shoppingCart.cartItemInfo.productAmount
Montant du produit exprimé dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
productLabel
Chemin: customer.shoppingCart.cartItemInfo.productLabel
Nom du produit.
Format
productQty
Chemin: customer.shoppingCart.cartItemInfo.productQty
Quantité de produit.
Format
productRef
Chemin: customer.shoppingCart.cartItemInfo.productRef
Référence produit.
Format
productType
Chemin: customer.shoppingCart.cartItemInfo.productType
Type du produit.
Valeurs possibles
Valeur | Description |
---|---|
FOOD_AND_GROCERY | Produits alimentaires et d'épicerie |
AUTOMOTIVE | Automobile / Moto |
ENTERTAINMENT | Divertissement / Culture |
HOME_AND_GARDEN | Maison et jardin |
HOME_APPLIANCE | Equipement de la maison |
AUCTION_AND_GROUP_BUYING | Ventes aux enchères et achats groupés |
FLOWERS_AND_GIFTS | Fleurs et cadeaux |
COMPUTER_AND_SOFTWARE | Ordinateurs et logiciels |
HEALTH_AND_BEAUTY | Santé et beauté |
SERVICE_FOR_INDIVIDUAL | Services à la personne |
SERVICE_FOR_BUSINESS | Services aux entreprises |
SPORTS | Sports |
CLOTHING_AND_ACCESSORIES | Vêtements et accessoires |
TRAVEL | Voyage |
HOME_AUDIO_PHOTO_VIDEO | Son, image et vidéo |
TELEPHONY | Téléphonie |
Format
productVat
Chemin: customer.shoppingCart.cartItemInfo.productVat
Type du produit.
Montant de la taxe sur le produit (dans la plus petite unité de la devise).
Valeurs possibles
Valeur | Description |
---|---|
Un nombre entier | Montant de la transaction. Sa valeur doit être un entier positif (ex: 1234 pour 12,34 EUR). |
Un nombre décimal, inférieur à 100 | Pourcentage appliqué sur le montant. Exemples : 20.0 ou 19.6532 |
Pour exprimer un pourcentage appliqué sur le montant du produit concerné, la valeur doit avoir au maximum 4 chiffres après la virgule. La décimale est obligatoire pour exprimer un pourcentage. La décimale est marquée par le caractère ".".
Format
paymentMethodToken
Alias (ou token) associé à un moyen de paiement.
Format
strongAuthentication
strongAuthentication permet d'indiquer la préférence du marchand au sujet de l'authentification de l'acheteur.
- Sans interaction du porteur (frictionless).
- Avec interaction du porteur (authentification forte ou challenge).
- Pas de préférence du marchand.
Une authentification forte est requise, lors de l'enregistrement d'une carte. Utilisez le champ formAction avec les valeurs suivantes:
- REGISTER_PAY : pour effectuer un paiement avec l'enregistrement du moyen de paiement.
- ASK_REGISTER_PAY: pour effectuer un paiement avec une demande d'enregistrement du moyen de paiement.
- CUSTOMER_WALLET : pour enregistrer le moyen de paiement.
Dans ce cas, le champ strongAuthentication prend automatiquement la valeur CHALLENGE_MANDATE.
Cas d'utilisation | Valeurs possibles |
---|---|
CHALLENGE: Avec interaction du porteur |
|
| |
| |
FRICTIONLESS Sans interaction du porteur
Option "Frictionless 3DS2" obligatoire |
Si vous ne disposez pas de l'option "Frictionless 3DS2", le choix de la préférence est délégué à l'émetteur de la carte (No Preference). Si la demande de frictionless est acceptée, la transaction ne bénéficie pas du transfert de responsabilité en cas de contestation du porteur. |
Pas de préférence du marchand |
|
|
Tableau des exemptions (valeur DISABLED)
Exemption | Description |
---|---|
Transactions à faible montant | Pour les paiements en euro, vous pouvez demander
une exemption à l'authentification forte :
|
LRM (Low Risk Merchant) |
Le programme LRM (Low Risk Merchant) de CB a pour objectif de répondre aux attentes des marchands à très faible risque et à la volumétrie importante (120.000 transactions CB / an). Vous pouvez demander une exemption à l'authentification forte : |
Format
paymentMethods
Liste des moyens de paiement à proposer à l’acheteur
Exemple : ["VISA", "MASTERCARD"]
Si la liste ne contient qu'un moyen de paiement, la page de saisie des données de ce moyen de paiement sera directement présentée. Sinon la page de sélection des moyens de paiement sera présentée.
Si ce champ est vide (conseillé) alors les moyens de paiement éligibles (devises, contraintes techniques, etc) associés à la boutique seront proposés.
Format
acquirerTransientData
Permet de transmettre des informations spécifiques à certains acquéreurs / réseaux.
Utilisation avec Conecs
Champ facultatif qui permet de transmettre le montant des produits éligibles payables par carte Titre-Restaurant CONECS.
Si le champ n’est pas transmis, c'est la totalité du montant qui sera considérée comme éligible au paiement par Titre-Restaurant, y compris les frais éventuels de livraison inclus dans le montant de la commande.
Exemple pour un montant éligible de 17.25€ :
Exemple :
{"CONECS":{"eligibleAmount":"1725"}}
Restreindre les codes BIN acceptés
Pour limiter les cartes acceptées pour le paiement en fonction du code BIN, le format attendu est le suivant :
{"MULTI":{"bins": ["bin1","bin2","bin3"]}}
NB: Supporte les codes BIN à 6 chiffres ou les codes BIN à 8 chiffres.
Exemple :
code BIN à 6 chiffres : 4012 34XX XXXX XXXX;
code BIN à 8 chiffres : 4000 1234 XXXX XXXX.
Format
manualValidation
Chemin: transactionDetails.cardDetails.manualValidation
Mode de validation de la transaction.
Format
Valeurs possibles
Les valeurs possibles sont les suivantes:
Valeur | Description |
---|---|
NO | Validation automatique par la plateforme de paiement. |
YES | Validation manuelle par le marchand. |
null | Configuration par défaut de la boutique retenue (paramétrable dans le |
captureDelay
Chemin: transactionDetails.cardDetails.captureDelay
Délai à appliquer à la date de capture.
Description
Indique le délai en nombre de jours avant remise en banque.
Si ce paramètre n’est pas transmis, alors la valeur par défaut définie dans le
Cette dernière est paramétrable dans le
Si le délai avant remise est supérieur à 365 jours dans la requête de paiement, il est automatiquement repositionné à 365 jours.
Format
firstAmount
Chemin: transactionDetails.installmentDetails.firstAmount
Premier montant du paiement en N fois.
Format
count
Chemin: transactionDetails.installmentDetails.count
Nombre d'échéances du paiement en N fois.
Format
period
Chemin: transactionDetails.installmentDetails.period
Intervalle (jours) du paiement en N fois.
Format
amount
Chemin: transactionDetails.installmentDetails.schedules.amount
Montant de l'échéance.
Format
date
Chemin: transactionDetails.installmentDetails.schedules.date
Date de l'échéance.
Format
companyType
Chemin: subMerchantDetails.companyType
Type de société du sous-marchand. Transmis par le facilitateur de paiement.
Des règles différentes peuvent s’appliquer selon l’acquéreur.
Ce champ sert souvent à préciser le type de Legal Number
de l'acheteur.
Format
legalNumber
Chemin: subMerchantDetails.legalNumber
Número légal du sous-marchand en fonction du champ companyType
. Transmis par le facilitateur de paiement.
Format
name
Chemin: subMerchantDetails.name
Raison sociale du sous-marchand. Transmis par le facilitateur de paiement.
Format
url
Chemin: subMerchantDetails.url
URL du sous-marchand. Transmis par le facilitateur de paiement.
Format
phoneNumber
Chemin: subMerchantDetails.phoneNumber
Numéro de téléphone du sous-marchand. Transmis par le facilitateur de paiement.
Format
address1
Chemin: subMerchantDetails.address1
Adresse du sous-marchand. Transmis par le facilitateur de paiement.
Format
address2
Chemin: subMerchantDetails.address2
Complément de l'adresse du sous-marchand. Transmis par le facilitateur de paiement.
Format
zip
Chemin: subMerchantDetails.zip
Code postal du sous-marchand. Transmis par le facilitateur de paiement.
Format
city
Chemin: subMerchantDetails.city
Ville du sous-marchand. Transmis par le facilitateur de paiement.
Format
country
Chemin: subMerchantDetails.country
Code pays de l'adresse du sous-marchand (norme ISO 3166 alpha-2). Transmis par le facilitateur de paiement.
Format
mcc
Chemin: subMerchantDetails.mcc
Code MCC du sous-marchand. Transmis par le facilitateur de paiement.
Format
mid
Chemin: subMerchantDetails.mid
Numéro de contrat (MID) du sous-marchand. Transmis par le facilitateur de paiement.
Format
softDescriptor
Chemin: subMerchantDetails.softDescriptor
Libellé (soft-descriptor) du sous-marchand qui apparaît sur le relevé d'opérations bancaires de l'acheteur. Transmis par le facilitateur de paiement.
Format
state
Chemin: subMerchantDetails.state
Région de l'adresse du sous-marchand. Transmis par le facilitateur de paiement.
Format
facilitatorId
Chemin: subMerchantDetails.facilitatorId
Identifiant du facilitateur de paiement. Transmis par le facilitateur de paiement.