support
Retour à la documentation
Rechercher
Catégories
Tags
Paramètres principauxtout montrer
amount
requis
currency
requis
orderId
recommandé
formAction
information sur l'acheteur
customer
reference
recommandé
email
recommandé
billingDetails
title
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
language
cellPhoneNumber
identityCode
identityType
legalName
shippingDetails
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
deliveryCompanyName
shippingSpeed
shippingMethod
legalName
identityCode
shoppingCart
insuranceAmount
shippingAmount
taxAmount
cartItemInfo
[1]
productLabel
productType
productRef
productQty
productAmount
productVat
options générales
acquirerTransientData
[1]
:
contrib
ipnTargetUrl
fingerPrintId
metadata
[1]
:
overridePaymentCinematic
paymentMethodToken
strongAuthentication
taxAmount
taxRate
options relatives à la méthode de paiement
transactionOptions
cardOptions
paymentSource
mid
manualValidation
captureDelay
firstInstallmentDelay
installmentNumber
retry
debitCreditSelector
informations sur le sous-marchand
subMerchantDetails
companyType
legalNumber
name
requis
url
phoneNumber
address1
address2
zip
city
country
mcc
mid
softDescriptor
state
facilitatorId
nouveaux paramètres
useCase
Testez moi
Documentation

Web Service Charge/CreatePayment

POSThttps://api.lyra.com/api-payment/V4/Charge/CreatePayment

L’opération Charge/CreatePayment est un Web Service de l’API REST.

Il permet d'effectuer plusieurs opérations:

Créer une transaction à partir d'une nouvelle carte

Vous pouvez créer des transactions à partir d'une carte, conjointement au formulaire embarqué.

Dans ce cas, le Web Service REST Charge/CreatePayment vous retournera un formToken (token de formulaire) qu'il faudra ensuite utiliser avec notre formulaire JavaScript.

Pour plus de détails, rendez-vous ici: Démarrer: Paiement simple.

Pour consulter la documentation de référence de la réponse qui contient le formToken, c'est par ici: Charge/PaymentForm

Une fois le paiement effectué, la transaction nouvellement créée sera contenue dans un object Payment documenté ici.

Créer une transaction à partir d'un alias

Vous pouvez également créer une transaction à partir d'un moyen de paiement préalablement enregistré (alias, aussi appelé token de paiement).

Pour plus de détails, rendez-vous ici : Paiement par alias.

Emettre une demande de prélèvement SEPA

Vous pouvez déclencher l'émission d'une demande de prélèvement SEPA en utilisant le Web Service Charge/CreatePayment en mode SILENT.

Pour plus de détails, rendez-vous ici : Paiement par alias.

Pour consulter la documentation de référence de la réponse, c'est par ici: Payment.

Si vous êtes certifiés PCI-DSS

Si vous êtes certifiés PCI-DSS, vous pouvez directement passer les informations sensibles au Web Service (comme le numéro de carte).

D’un point de vue contractuel:

Pour plus d’informations merci de prendre contact avec votre interlocuteur commercial pour vérifier votre éligibilité à cette option.

D’un point de vue technique

Rendez-vous sur notre page dédiée à l'utilisation du Web Service REST Charge/CreatePayment en mode PCI-DSS.

Paramètres de la requête

Le web service REST Charge/CreatePayment supporte les paramètres suivants:

amount

Montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro).

Exemple: 30050 pour 300, 50 EUR.

Format

contrib

Nom de la solution e-commerce utilisée sur le site marchand ainsi que son numéro de version.

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

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

orderId

Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.

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 Back Office Expert.

Format

fingerPrintId

Ce champ est utilisé par les marchands qui implémentent l'analyseur de risque dans leur page de paiement. Permet de transmettre l'identifiant de session (ou fingerPrint Id) à la plateforme de paiement pour finaliser l'analyse de risque.

Les analyseurs supportés sont :

  • NOTO
  • Cybersource
  • MonitorPlus
  • ClearSale

Peut contenir des majuscules, des minuscules, des chiffres ou des tirets ([A-Z][a-z], 0-9, _, -).

Format

formAction

formAction permet de définir le type de comportement souhaité lors de la création de la transaction.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description
PAYMENT Création d'une transaction simple. Comportement par défaut.
REGISTER_PAY Création d'un alias (token) du moyen de paiement en même temps de la transaction. Ne permet pas de créer un alias associé à un IBAN.
ASK_REGISTER_PAY Ajoute une case à cocher sur le formulaire pour la création d'un alias (token). Ne permet pas de créer un alias associé à un IBAN.
SILENT Transaction initiée par le marchand sans la présence de l'acheteur. Effectue un paiement par alias sans passer par le formulaire embarqué.
CUSTOMER_WALLET Ajoute une case à cocher sur le formulaire pour l'association de la carte au wallet. Le champ customer.reference est obligatoire pour ce cas d'utilisation. Consultez le guide d'intégration pour plus d'informations.
null Si la valeur est nulle ou non définie, PAYMENT s'applique.

PAYMENT:

Le Web Service retournera un formToken.

C'est le comportement par défaut. L'appel à Charge/CreatePayment créé une transaction sans effectuer d'opération supplémentaire.

REGISTER_PAY:

Le Web Service retournera un formToken.

Un alias (ou token) du moyen de paiement est créé en même temps que la transaction. Cet alias vous permettra ensuite de créer des transactions en un clic. L'alias nouvellement créé sera renseigné dans la propriété paymentMethodToken. Pour plus d'informations, voir l'article dédié au Création et utilisation d’alias.

ASK_REGISTER_PAY:

Le Web Service retournera un formToken.

Ce paramètre permet d'ajouter une case à cocher dans le formulaire de de paiement, demandant à l'acheteur s'il veut enregister sa carte.

action acheteur Description
La case est cochée Enregistre un alias de carte (comme formAction=REGISTER_PAY).
La case n'est pas cochée L'alias n'est pas crée (comme formAction=PAYMENT). Comportement par défaut.

Pour plus d'informations, rendez-vous sur l'article dédié au Création et utilisation d’alias.

CUSTOMER_WALLET:

Le Web Service retournera un formToken.

Ce paramètre permet d'ajouter une case à cocher dans le formulaire de de paiement, demandant à l'acheteur s'il veut enregister sa carte dans son wallet. Nécessite la référence acheteur customer.reference.

action acheteur Description
La case est cochée Ajoute une carte dans le wallet.
La case n'est pas cochée Comportement par défaut. la carte n'est pas ajoutée au wallet.

SILENT: Réservé pour les transactions initiées par le marchand sans la présence de l'acheteur et notamment pour les paiements récurrents lorsque la récurrence est gérée par le marchand.

Dans la zone d'application de la DSP2, l'authentification du porteur est obligatoire lorsque le porteur est présent. Le mode SILENT est donc réservé lorsque le porteur est absent ou pour les marchands hors zone DSP2.

Dans la zone d'application de la DSP2, le champ strongAuthentication est ignoré et aucune authentification du porteur n'est réalisée.

Le Web Service retournera directement une transaction plutôt qu'un formToken lors d'un paiement par alias (token). La transaction se fait donc de serveur à serveur.

paymentMethodToken

Alias (ou token) associé à un moyen de paiement.

Seuls les tokens associés à une carte bancaire sont supportés.

Format

strongAuthentication

strongAuthentication permet d'indiquer la préférence du marchand concernant l'authentification forte de l'acheteur.

Avec 3DS2, il n'est plus possible de désactiver le 3DS. Cependant, le marchand peut demander une exemption dans sa requête de paiement (on parle de "préférence du marchand").

Dans ce cas, si la demande est acceptée par l'émetteur, l'acheteur n'aura pas à s'authentifier (pas de challenge) mais le marchand assurera la responsabilité en cas d'impayé (pas de transfert de responsabilité à l'émetteur).

Dans tous les cas, la banque émettrice détermine seule si l'interaction avec l'acheteur (le challenge) est nécessaire.

Dans le cadre de l'application de la DSP2, une authentification forte est requise lors de l'enregistrement d'une carte. C'est le cas lorsque formAction est valorisé à REGISTER_PAY mais aussi ASK_REGISTER_PAY et CUSTOMER_WALLET si l'acheteur décide d'enregistrer son moyen de paiement. Le champ strongAuthentication est ignoré et la valeur CHALLENGE_MANDATE est appliquée automatiquement.

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description 3DS1 Description 3DS2
ENABLED

Active (si possible) l'authentification forte.

Dépréciée. Cette valeur sera interprétée comme CHALLENGE_REQUESTED.

DISABLED

Désactive (si possible) l'authentification forte. Nécessite l'option "3DS1 Sélectif".

En utilisant cette valeur, vous vous exposez à des refus "Soft decline".

La désactivation ne sera pas prise en compte si le moyen de paiement requiert obligatoirement une authentification forte. C'est le cas pour les cartes MAESTRO.

Permet de demander une authentification sans interaction (frictionless). Nécessite l'option "Frictionless 3DS2".

  • Transactions à faible montant

    Pour les paiements en euro, vous pouvez demander une exemption à l'authentification forte, pour les transactions d'un montant inférieur à 30 €, et dans la limite soit de 5 opérations successives ou d’un montant cumulé inférieur à 100 €.

    Si le montant est supérieur à 30€, la valeur transmise par le marchand est ignorée et le choix de la préférence est délégué à l'émetteur de la carte ( No Preference).

    Pour les paiements réalisés dans une devise différente de l'euro, une demande de frictionless est transmise à l'émetteur.

    Si la demande de frictionless est acceptée, la transaction ne bénéficie pas du transfert de responsabilité en cas d'impayé.

Si la boutique ne dispose pas de l'option "Frictionless 3DS2", le choix de la préférence est délégué à l'émetteur de la carte ( No Preference).

CHALLENGE_REQUESTED

Active (si possible) l'authentification forte.

Permet de demander une authentification forte pour la transaction.

CHALLENGE_MANDATE

Active (si possible) l'authentification forte.

Permet d'indiquer que pour des raisons règlementaires, une authentification forte est requise pour la transaction.

NO_PREFERENCE

Active (si possible) l'authentification forte.

Permet d'indiquer au DS que le marchand n'a pas de préférence. Si l'émetteur décide de réaliser une authentification sans interaction (frictionless), le paiement sera garanti.

AUTO

Active (si possible) l'authentification forte.

Le choix de la préférence est délégué à l'émetteur de la carte (No Preference).

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

customer.reference

Identifiant de l’acheteur chez le marchand.

Obligatoire si formAction est valorisé à CUSTOMER_WALLET.

Dans ce cas, la référence de l'acheteur est utilisée comme identifiant du wallet.

Format

customer.email

Adresse e-mail de l'acheteur.

Lorsque vous souhaitez créer un alias du moyen de paiement (en définissant formAction à REGISTER_PAY, ASK_REGISTER_PAY ou CUSTOMER_WALLET) l'email n'est pas obligatoire. Cependant l'acheteur devra le renseigner dans le formulaire.

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

En fonction du moyen de paiement, certaines restrictions peuvent modifier le format. Veuillez vous reporter à la documentation technique spécifique au moyen de paiement pour plus de détails.

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

En fonction du moyen de paiement, certaines restrictions peuvent modifier le format. Veuillez vous reporter à la documentation technique spécifique au moyen de paiement pour plus de détails.

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

paymentSource

Chemin: transactionOptions.cardOptions.paymentSource

Origine du paiement.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description
EC E-Commerce: les données du moyen de paiement sont saisies par l'acheteur. Cette valeur permet d'avoir une authentification forte lors du paiement.
MOTO MAIL OR TELEPHONE ORDER: Saisie réalisée par un opérateur. Les informations du moyen de paiement sont transmises par courrier ou par e-mail. Nécessite un contrat de type VAD.
CC Call Center: paiement effectué via un centre d’appel. Nécessite un contrat de type VAD.
OTHER Autre canal de vente. Valeur de sortie retournée pour les paiements réalisés depuis le Back Office Marchand, les paiements par fichier, les paiements récurrents, les paiements de proximité, les remboursements depuis le CMS Shopify.
Absent ou null La valeur par défaut est "EC".

mid

Chemin: transactionOptions.cardOptions.mid

Numéro de contrat commerçant. Si ce champ est renseigné, veillez à utiliser le bon contrat en fonction du réseau de la carte.

Format

manualValidation

Chemin: transactionOptions.cardOptions.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 Back Office Marchand).

captureDelay

Chemin: transactionOptions.cardOptions.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 Back Office Expert sera utilisée.

Cette dernière est paramétrable dans le Back Office Expert par toutes les personnes dûment habilitées.

Si le délai avant remise est supérieur à 365 jours dans la requête de paiement, il est automatiquement repositionné à 365 jours.

Format

firstInstallmentDelay

Chemin: transactionOptions.cardOptions.firstInstallmentDelay

Nombre de mois de différé à appliquer sur la première échéance d'un paiement en plusieurs fois. Champ spécifique aux acquéreurs d’Amérique Latine.

Format

installmentNumber

Chemin: transactionOptions.cardOptions.installmentNumber

Nombre d'échéances.

Format

retry

Chemin: transactionOptions.cardOptions.retry

Nombre de nouvelles tentatives disponibles en cas de refus de paiement (1 par défaut).

Format

debitCreditSelector

Chemin: transactionOptions.cardOptions.debitCreditSelector

Ce champ est spécifique au Brésil pour la gestion des cartes multiplo.

Les cartes "multiplo" sont des cartes de paiement (Elo, Visa ou Mastercard), permettant de régler :

  • soit en débit immédiat : le montant est débité tout de suite, et le marchand est crédité à J+1.
  • soit en crédit : le débit est différé et le montant peut être débité en une ou plusieurs échéances. Le marchand est crédité plus tard de la totalité ou seulement d'une partie du montant total.

Ce champ permet de forcer l'utilisation de la carte en débit ou en crédit.

Valeurs possibles

valeurs Description
DEBIT Utilisation de la fonction "débit" de la carte
CREDIT Utilisation de la fonction "crédit" de la carte

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

overridePaymentCinematic

Permet de modifier le mode de capture. Spécifique aux acquéreurs d'Amérique Latine. Cette fonctionnalité n'est pas utilisable en Colombie.

Valeurs possbiles:

Valeur Description
IMMEDIATE_CAPTURE Cinématique de capture immédiate : la capture est déclenchée par l'acquéreur, le jour du paiement.
DELAYED_CAPTURE Cinématique de capture différée : la capture est déclenchée par la plateforme de paiement, toujours avant l'expiration de la demande d'autorisation.

Format

formTokenVersion

formTokenVersion définit la version du formToken renvoyé par le web service.

Ce paramètre est utilisé dans le cadre du SDK mobile. Il permet de s'assurer que la version du formToken retournée est toujours en phase avec l'application mobile déployée sur le téléphone de l'acheteur.

La valeur par défaut est 2.

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

Numéro légal du sous-marchand. 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.

Format

Référence de la réponse

Plusieurs réponses sont possibles en fonction du contexte:

Réponse Contexte
Payment Objet contenant la transaction générée. Cet objet est directement retourné lors d'un paiement par identifiant simple.
Charge/PaymentForm Objet contenant un hash à utiliser avec le formulaire embarqué pour créer une nouvelle transaction.

Voir la référence de chaque réponse pour plus de détails.