PCI/Charge/CreatePayment (PCI)

POSThttps://api-sogecommerce.societegenerale.eu/api-payment/V4.1/PCI/Charge/CreatePayment

L’opération PCI/Charge/CreatePayment est un Web Service de l’API REST. Il permet de créer une nouvelle transaction authentifiée à partir d'un numéro de carte.

En mode PCI-DSS, vous pouvez renseigner directement les informations de carte dans le Web Service.

Pour une utilisation non-PCI avec le formulaire embarqué, rendez-vous ici : Charge/CreatePayment(non-PCI).

A noter que la précédente version dépréciée de ce web service peut-être trouvée ici : PCI/Charge/CreatePayment (depréciée)

Authentification avec notre serveur d'authentification

Ce Web Service permet de faire une transaction 3DS. Il est donc nécessaire de prendre connaissance du fonctionnement de cette fonctionnalité. Pour voir comment l'intégrer, la documentation de référence est présente ici: Web Service PCI de création de paiement.

Point important concernant les paiements CB

Avec l'application de la DSP2, les émetteurs peuvent refuser la transaction si l'authentification 3D Secure n'a pas été réalisée. Ce comportement s'appelle "Soft Decline".

Dans le cas d'un "Soft Decline" le champ transactionDetails.cardDetails.authorizationResponse.authorizationResult est valorisé à 81. Il est de la responsabilité du marchand d'initier un nouveau paiement avec une authentification 3D secure.

Authentification avec un autre serveur d'authentification

Le service PCI/Charge/CreatePayment permet aux marchands PCI-DSS ayant réalisé l'authentification du porteur via leur propre serveur d'authentification, de réaliser des paiements en transmettant dans leur requête les informations de la carte ainsi que les données d'authentification du porteur.

Consultez le guide d'intégration pour plus d'informations.

Paramètres d'entrée

Le Web Service REST PCI/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

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
Real du Brésil (986)	BRL	2
Dollar canadien (124)	CAD	2
Franc suisse (756)	CHF	2
Renminbi yuan chinois (156)	CNY	1
Couronne tchèque (203)	CZK	2
Couronne danoise (208)	DKK	2
Euro (978)	EUR	2
Livre Sterling (826)	GBP	2
Dollar de Hong Kong (344)	HKD	2
Forint hongrois (348)	HUF	2
Roupie Indienne (356)	INR	2
Roupie indonésienne (360)	IDR	2
Yen (392)	JPY	0
Riel Cambodgien (116)	KHR	0
Won Sud Coréen (410)	KRW	0
Dinar Koweïtien (414)	KWD	3
Dirham Marocain (504)	MAD	2
Peso mexicain (484)	MXN	2
Ringgit malais (458)	MYR	2
Dollar néo-zélandais (554)	NZD	2
Couronne norvégienne (578)	NOK	2
Peso philippin (608)	PHP	2
Zloty polonais (985)	PLN	2
Leu Roumain (946)	RON	2
Rouble russe (643)	RUB	2
Dollar de Singapour (702)	SGD	2
Couronne suédoise (752)	SEK	2
Baht thailandais (764)	THB	2
Dinar Tunisien (788)	TND	3
Lire turque (949)	TRY	2
Nouveau dollar de Taïwan (901)	TWD	2
Dollar des États-Unis (840)	USD	2
Rand sud-africain (710)	ZAR	2

orderId

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

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.
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.

paymentMethodType

Chemin: paymentForms.paymentMethodType

Type de moyen de paiement. Exemple: PAYCONIQ

Format

paymentForms.pan

Le PAN (Primary Account Number) est le numéro principal de la carte généralement composé de 16 chiffres).

Format

expiryMonth

Chemin: paymentForms.expiryMonth

Mois d’expiration sur 2 chiffres. Exemple : "09" pour septembre.

Format

expiryYear

Chemin: paymentForms.expiryYear

Année d’expiration sur 2 chiffres. Exemple : "25" pour 2025.

Format

securityCode

Chemin: paymentForms.securityCode

Code de sécurité de la carte.

Sa longueur peut varier entre 3 ou 4 chiffres en fonction du type de carte.

Format

paymentForms.brand

Marque de la carte.

Format

cardHolderName

Chemin: paymentForms.cardHolderName

Nom et prénom du porteur de la carte (recommandé)

Format

firstInstallmentDelay

Chemin: paymentForms.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

identityDocumentNumber

Chemin: paymentForms.identityDocumentNumber

Numéro de pièce d'identité de l'acheteur.

Le format dépend du type de pièce d'identité: de 7 à 13 caractères, chiffres, lettres et/ou points.

En Amérique Latine, ce paramètre peut être obligatoire pour certains acquéreurs.

Format

identityDocumentType

Chemin: paymentForms.identityDocumentType

Type de pièce d'identité.

Format

installmentNumber

Chemin: paymentForms.installmentNumber

Nombre d'échéances.

Format

overridePaymentCinematic

Chemin: paymentForms.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

paymentMethodToken

Chemin: paymentForms.paymentMethodToken

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

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

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

customer.ipAddress

Adresse IP de l'acheteur.

Format

address

Chemin: customer.billingDetails.address

Adresse de facturation.

Attention : Les caractères > et < ne sont pas autorisés.

Format

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

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.

L'objet device et ses attributs ne sont pas requis si paymentSource est valorisé à MOTO, CC ou OTHER ou si l'objet authenticationDetails est renseigné.

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:

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

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

Type de livraison.

Format

Valeurs possibles

Valeur	Description
RECLAIM_IN_SHOP	Retrait de marchandise en magasin
RELAY_POINT	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
VERIFIED_ADDRESS	Livraison à une adresse vérifiée
NOT_VERIFIED_ADDRESS	Livraison à une adresse non vérifiée
SHIP_TO_STORE	Livraison en magasin
DIGITAL_GOOD	Livraison digitale
ETRAVEL_OR_ETICKET	Billet électronique
OTHER	Autre
PICKUP_POINT	Retrait en point relais
AUTOMATED_PICKUP_POINT	Retrait en point relais automatique

shippingSpeed

Chemin: customer.shippingDetails.shippingSpeed

Rapidité de livraison.

Format

Valeurs possibles

Valeur	Description
STANDARD	Livraison standard
EXPRESS	Livraison en moins de 24 h
PRIORITY	Livraison Prioritaire (Click & Collect)
ELECTRONIC_DELIVERY	Téléchargement électronique
SAME_DAY_SHIPPING	Livraison le même jour
OVERNIGHT_SHIPPING	Livraison de nuit
TWO_DAYS_OR_MORE_SHIPPING	Livraison 2 jours ou plus

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

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

contrib

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

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

fingerPrintId

Ce champ est utilisé par les marchands qui implémentent l'analyseur de risque dans leur page de paiement.

Il permet de transmettre l'identifiant de session (ou fingerPrint Id) à la plateforme de paiement pour finaliser l'analyse de risque.

Les analyseurs de risque supportés sont :

NOTO
Konduto
Cybersource
MonitorPlus
ClearSale

Dans le cas de l'analyseur de risque ClearSale ce champ a une taille fixe de 128 caractères et peut contenir des majuscules, des minuscules, des chiffres ou des tirets ([A-Z][a-z], 0-9, \_, -).

Dans les autres cas il est recommandé de renseigner un UUID standard d'une taille de 36 caractères.

Ex: dd7a3898-2e1b-40d0-aaf7-5482c73bf0c4

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 Marchand.

Format

merchantPostUrlRefused

Permet de définir l'URL vers laquelle sera redirigé le navigateur après une authentification 3D Secure en échec.

Format

merchantPostUrlSuccess

Permet de définir l'URL vers laquelle sera redirigé le navigateur après une authentification 3D Secure réussie.

Format

strongAuthentication

Permet d'indiquer la préférence 3-D Secure du marchand :

Sans interaction du porteur : Frictionnless (option Frictionless 3DS2 requise).

Avec interaction du porteur : Challenge.

Pas de préférence du marchand.

Cas particulier : enregistrer une carte

Une authentification forte est requise, lors de l'enregistrement d'une carte (Création d'un alias).

Dans ce cas, le champ strongAuthentication prend automatiquement la valeur CHALLENGE_MANDATE.

Cas d'utilisation	Valeurs possibles
Avec interaction du porteur : Challenge	ENABLED : Cette valeur est dépréciée.
	CHALLENGE_REQUESTED : Cette valeur permet de demander une authentification forte pour la transaction.
	CHALLENGE_MANDATE : Cette valeur permet de demander une authentification forte pour la transaction pour des raisons règlementaires.
Sans interaction du porteur : Frictionless	DISABLED : Cette valeur permet de demander une exemption à l'authentification forte. Avec l'option Frictionless 3DS2 : Transactions à faible montant Safe'R by CB 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. Sans l'option Frictionless 3DS2, le choix de la préférence est délégué à l'émetteur de la carte (No Preference). DATA_SHARE_ONLY : Réservée au Brésil et à l'amérique Latine. Cette valeur permet de demander une transaction sans interaction du porteur (ni authentification) mais pour laquelle le marchand souhaite partager les données via le processus 3DS avec l'émetteur pour réduire le risque de refus lors de l'autorisation.
Pas de préférence du marchand	NO_PREFERENCE : 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.
Pas de préférence du marchand	AUTO: Le choix de la préférence est délégué à l'émetteur de la carte (No Preference).

Tableau des exemptions pour le Frictionless (valeur DISABLED)

Exemption	Description
Transactions à faible montant	Pour les paiements en euro, vous pouvez demander une exemption à l'authentification forte : Si le montant est inférieur à 30 EUR, et dans la limite soit de 5 opérations successives ou d’un montant cumulé inférieur à 100 EUR. Si le montant est supérieur à 30 EUR, 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 de contestation du porteur.
Safe'R by CB	Le programme Safe'R by 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 : Si le montant est inférieur à 100 EUR, l'exemption est systématique pour les marchands éligibles. Si le montant est compris entre 100 EUR et 250 EUR, une expérimentation est en cours. Le marchand doit remplir ces conditions : Avoir un contrat CB. Être éligible à la TRA acquéreur. Transmettre les valeurs requises dans le flux 3-D Secure, selon les règles définies par la plateforme. 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. Pour bénéficier du programme Safe'R by CB, vous devez contacter votre conseiller clientèle Société Générale pour obtenir un accord explicite.

Exemption

Description

Transactions à faible montant

Pour les paiements en euro, vous pouvez demander une exemption à l'authentification forte :

Si le montant est inférieur à 30 EUR, et dans la limite soit de 5 opérations successives ou d’un montant cumulé inférieur à 100 EUR.
Si le montant est supérieur à 30 EUR, 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 de contestation du porteur.

Safe'R by CB

Le programme Safe'R by 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 :

Si le montant est inférieur à 100 EUR, l'exemption est systématique pour les marchands éligibles.
Si le montant est compris entre 100 EUR et 250 EUR, une expérimentation est en cours. Le marchand doit remplir ces conditions :
- Avoir un contrat CB.
- Être éligible à la TRA acquéreur.
- Transmettre les valeurs requises dans le flux 3-D Secure, selon les règles définies par la plateforme.

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.

Format

useCase

Permet de spécifier le cas d'utilisation souhaité.

Valeurs possibles

Valeur	Description
`BILLING_AGREEMENT`	Accord de facturation entre l'acheteur et le marchand dans lequel l'acheteur autorise des paiements futurs ou souscrit à un abonnement, sans avoir besoin d'authentifier chaque transaction individuellement.
`CARD_SECURITY_CODE_STATUS_CHECK`	Utilisé par exemple lorsqu'un service de vérification de carte effectue une vérification du cryptogramme visuel de la carte avant qu'une future transaction ne soit terminée.
`DECOUPLED_AUTHENTICATION_FALLBACK`	Utilisé lorsque le procesus d'authentification découplée a échoué et qu'une alternative est requise.
`DELAYED_SHIPMENT`	Utilisé lorsque le paiement est traité immédiatement mais la livraison est différée, par exemple si certains produits ne sont pas disponibles pour une expédition immédiate.
`DEVICE_BINDING_STATUS_CHECK`	Utilisé lorsqu'il est nécessaire de vérifier si un appareil est correctement appairé à une carte ou un compte.
`FIDO_CREDENTIAL_DELETION`	Utilisé lors d'une demande de suppression des informations d'identification FIDO associées à un compte ou un appareil. FIDO (Fast Identity Online) est une norme d'authentification sans mot de passe.
`FIDO_CREDENTIAL_REGISTRATION`	Utilisé lors de l'inscription de nouvelles informations d'identification FIDO.
`INSTALLMENT`	Paiement en plusieurs fois.
`MAINTAIN_CARD`	Utilisé par exemple pour confirmer l'état de la carte lors de paiements récurrents (abonnements ou paiements en plusieurs fois).
`OTHER_USE_CASE`	Autre cas d'utilisation.
`PAYMENT`	Paiement comptant.
`RECURRING_VARIABLE_TOTALAMOUNT`	Abonnement à fréquence et/ou échéances variables.
`RECURRING_FIXED_TOTALAMOUNT`	Abonnement à fréquence et échéances fixes.
`REGISTER`	Enregistrement de la carte.
`RESERVATION_AND_RENTAL`	Utilisé pour le paiement d'une réservation ou location d'un bien ou d'un service et des frais complémentaires associés.
`SHIPMENT_MULTIPLE_AUTHORISATION`	Paiement à l'expédition avec autorisations multiples.
`SPLIT_PAYMENT`	Utilisé lorsque le paiement est réalisé avec différents modes de paiement.
`TOP_UP`	Rechargement de compte.
`TRUST_LIST_STATUS_CHECK`	Utilisé pour demander à l'emetteur si le marchand fait partie de la liste des bénéficiaires de confiance de l'acheteur. Dans ce cas, le marchand peut ensuite demander une exemption à l'authentification forte lors du paiement.
`VERIFY_ONLY`	Utilisé par exemple pour vérifier le solde de la carte lors de paiements récurrents (abonnements ou paiements en plusieurs fois).

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é.
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.

Un contrat CB ne peut être utilisé pour une transaction AMEX.

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 Marchand sera utilisée.

Cette dernière est paramétrable dans le Back Office Marchand 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 (3 par défaut).

Format

restrictedInstallments

Chemin: transactionOptions.cardOptions.restrictedInstallments

Champ pour restreindre les échéances proposées lors du paiement. Voir :lien.

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

initiatedTransactionIndicator

Chemin: transactionOptions.cardOptions.initiatedTransactionIndicator

Objectif d'utilisation d'un alias associé à une carte.

Format

initialIssuerTransactionIdentifier

Chemin: transactionOptions.cardOptions.initialIssuerTransactionIdentifier

Référence de chainage.

Format

name

Chemin: authenticationDetails.protocol.name

Nom du protocole d'authentification du porteur de carte.

Valeurs possibles

Valeur	Description
THREEDS	Protocole 3D Secure

Format

version

Chemin: authenticationDetails.protocol.version

Version du protocole d'authentification du porteur de carte.

Valeurs possibles

Valeur	Description	Protocole compatible
2	A renseigner si la version exacte n'est pas connue. Dans ce cas la dernière version supportée en 3D Secure 2 par la plateforme de paiement sera considérée	Tous
2.1.0	Version 2.1.0	THREEDS
2.2.0	Version 2.2.0	THREEDS

Format

directoryServer

Chemin: authenticationDetails.protocol.directoryServer

Nom du réseau DS sur lequel l'authentification s'est effectué.

Valeurs possibles

NOM DU PROTOCOLE	VALEUR DE DIRECTORYSERVER	NOM DU RESEAU
THREEDS	CB	Réseau Carte Bancaire
THREEDS	AMEX	Réseau American Express (Safekey)
	MASTERCARD	Réseau Mastercard
	VISA	Réseau Visa
	ELO	Réseau Elo (Brésil)
	DINERS	Réseau Diners
	DISCOVER	Réseau Discover
	ELO	Réseau Elo

Format

challengePreference

Chemin: authenticationDetails.protocol.challengePreference

Indique si le marchand a demandé un challenge ou pas.

Valeurs possibles

Valeur	Carte 3DS2
NO_PREFERENCE	Le choix de la préférence est délégué à l'émetteur de la carte.
NO_CHALLENGE_REQUESTED	Permet de demander une authentification sans interaction (frictionless)
CHALLENGE_REQUESTED	Permet de demander une authentification forte pour la transaction.
CHALLENGE_MANDATED	Permet d'indiquer que pour des raisons réglementaires, une authentification forte est requise pour la transaction.
DATA_ONLY	Permet de demander une authentification sans interaction, prise en charge par le DS au lieu de l'ACS de la banque émettrice. La transaction ne bénéficiera pas du transfert de responsabilité. L'authentification sera désactivée si le réseau n'est pas compatible avec cette fonctionnalité. Le service PCI/Charge/Authenticate retourne un code erreur INT_808, si le champ `transactionCategory` n'est pas valorisé à `PAYMENT`.
DATA_SHARE_ONLY	Permet de demander une transaction sans interaction du porteur mais pour laquelle le marchand souhaite partager les données via le processus 3DS avec l'émetteur pour réduire le risque de refus lors de l'autorisation.

Format

authenticationType

Chemin: authenticationDetails.authenticationType

Le type d'authentification qui a eu lieu.

Valeurs possibles

Valeur	Description
FRICTIONLESS	Authentification en mode Frictionless, c'est à dire de manière transparente pour le client
CHALLENGE	Authentification avec Challenge, le client a dû s'authentifier explicitement auprès de l'ACS
DATA_ONLY	Authentification prise en charge par le DS sans interraction du client

Format

status

Chemin: authenticationDetails.status

Le statut d'authentification, c'est à dire le résultat positif/négatif de l'authentification.

Valeurs possibles

Valeur	Description
ATTEMPT	Preuve de tentative d'authentification quand l'authentification n'est pas disponible
ENROLLED_UNAVAILABLE	Impossible d'obtenir le statut d'enrôlement
FAILED	Authentification erronée
NOT_ENROLLED	Carte non enrôlée
SUCCESS	Authentification réussie
UNAVAILABLE	L'authentification n'a pas pu se terminer (erreur technique, etc.)
DISABLED	Authentification débrayée. Le champ exemption devient obligatoire

Format

commerceIndicator

Chemin: authenticationDetails.commerceIndicator

Le Commerce Indicator, appelé ECI (Electronic Commerce Indicator) pour le protocole 3DS. Indicateur renvoyé par l'ACS pour indiquer les résultats de la tentative d'authentification du porteur de carte.

En cas d'authentification sans paiement (cas de l'enregistrement d'une carte) Mastercard peut retourner les 2 valeurs suivantes :

VALEUR	DESCRIPTION
N0	Not authenticated
N2	Authenticated

Format

authenticationValue

Chemin: authenticationDetails.authenticationValue

Valeur d'authentification finale (en fonction du DS cette valeur peut s'appeler CAVV, AEVV ou AAV). Chaine de caractère encodée en base64 d'une taille de 28 caractères.

Format

dsScore

Chemin: authenticationDetails.dsScore

Score de l'authentification spécifié par le DS, uniquement pour le réseau CB. Voir : Guide d'intégration.

Format

authValueAlgorithm

Chemin: authenticationDetails.authValueAlgorithm

Algorithme utilisé pour calculer le champ authenticationValue. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration.

Format

requestorName

Chemin: authenticationDetails.requestorName

RequestorName utilisé lors de l'authentification initiale. En général ce champ correspond au nom du marchand. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration.

Format

dsTransID

Chemin: authenticationDetails.dsTransID

Identifiant de transaction du DS. (Requis en 3D Secure V2).

Format

acsTransID

Chemin: authenticationDetails.acsTransID

Identifiant de transaction de l'ACS.

Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration

Format

xid

Chemin: authenticationDetails.xid

Identifiant unique de la transaction.

Format

exemption

Chemin: authenticationDetails.exemption

Indique la raison justifiant l'absence d'authentification forte. (Requis en cas de statut DISABLED, ou en cas d'authentification FRICTIONLESS).

Valeurs possibles

valeurs	Description
LOW_VALUE	Transaction de faible montant (ex: montant inférieur à 30€ en Europe)
ACQUIRER_TRA	Analyse de risques effectuée au préalable par l'acquéreur
ISSUER_TRA	Analyse de risques effectuée au préalable par l'émetteur
LOW_RISK_MERCHANT	Commerçant inscrit dans le programme LOW RISK MERCHANT CB
OUT_OF_SCOPE	Authentification non requise car hors du scope RTS SCA
DELEGATED_SCA	Authentification forte déléguée à un tiers.
FIXED_RECURRING_PAYMENT	Paiement récurrent à montant fixe et durée déterminée
TRUSTED_BENEFICIARY	Bénéficiaire de confiance
AUTOMATIC_PAYMENT_MACHINES	Automate de paiement
CORPORATE	Procédure de paiement sécurisé pour les entreprises
OTHER_EXEMPTION	Autres cas d'usages exemptés d'authentification
TECHNICAL_ERROR	Problème technique rendant impossible l'authentification

Format

challengeCancelationIndicator

Chemin: authenticationDetails.challengeCancelationIndicator

Indicateur d'annulation de challenge reçu dans le RReq. (Valeur retournée par le DS en cas d'annulation de l'authentification).

Format

transactionStatusReason

Chemin: authenticationDetails.transactionStatusReason

Indique la raison de l'échec d'authentification. (Valeur retournée par le DS en cas d'échec d'authentification).

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.

Format

Référence de la réponse

Plusieurs réponses sont possibles en fonction du contexte:

Réponse	Contexte
AuthenticationSessionResponse	Objet contenant le résultat de l'authentification de la session
Payment	Objet contenant la transaction générée. Cet objet est directement retourné lors d'un paiement par identifiant simple.

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

Catégories

Tags

Aucun formToken n'a été défini

PCI/Charge/CreatePayment (PCI)

Authentification avec notre serveur d'authentification

Authentification avec un autre serveur d'authentification

Paramètres d'entrée

amount

Format

currency

Format

Valeurs possibles

orderId

Format

formAction

Format

Valeurs possibles

paymentMethodType

Chemin: paymentForms.paymentMethodType

Format

paymentForms.pan

Format

expiryMonth

Chemin: paymentForms.expiryMonth

Format

expiryYear

Chemin: paymentForms.expiryYear

Format

securityCode

Chemin: paymentForms.securityCode

Format

paymentForms.brand

Format

cardHolderName

Chemin: paymentForms.cardHolderName

Format

firstInstallmentDelay

Chemin: paymentForms.firstInstallmentDelay

Format

identityDocumentNumber

Chemin: paymentForms.identityDocumentNumber

Format

identityDocumentType

Chemin: paymentForms.identityDocumentType

Format

installmentNumber

Chemin: paymentForms.installmentNumber

Format

overridePaymentCinematic

Chemin: paymentForms.overridePaymentCinematic

Format

paymentMethodToken

Chemin: paymentForms.paymentMethodToken

Format

taxAmount

Format

taxRate

Format

customer.reference

Format

customer.email

Format

customer.ipAddress

Format

address

Chemin: customer.billingDetails.address

Format

category

Chemin: customer.billingDetails.category

Format

Valeurs possibles

cellPhoneNumber

Chemin: customer.billingDetails.cellPhoneNumber

Format

city

Chemin: customer.billingDetails.city

Format

country

Chemin: customer.billingDetails.country

Format