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

Web service Charge/CreateToken

L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

POSThttps://api.systempay.fr/api-payment/V4/Charge/CreateToken

Le Web Service REST Charge/CreateToken permet de créer un alias sans paiement.

Consultez le guide d'intégration Création d'un alias sans paiement.

Paramètres d'entrée

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
Lev Bulgare (975) BGN 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
Kuna Croate (191) HRK 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
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
Lire turque (949) TRY 2
Nouveau dollar de Taïwan (901) TWD 2
Dollar des États-Unis (840) USD 2
Franc CFP (953) XPF 0
Rand sud-africain (710) ZAR 2

formAction

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

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur Description
REGISTER Création d'un alias (token) du moyen de paiement. Ne permet pas de créer un alias associé à un IBAN.
CUSTOMER_WALLET Ajoute la liste des alias associés à la référence acheteur dans le formulaire. Le champ customer.reference est obligatoire pour ce cas d'utilisation.
null Si la valeur est nulle ou non définie, REGISTER s'applique.

REGISTER:

Le Web Service retournera un formToken.

C'est le comportement par défaut. L'appel à Charge/CreateToken créé un alias.

CUSTOMER_WALLET:

Le Web Service retournera un formToken.

Ce paramètre permet d'ajouter la liste des alias au formulaire d'enregistrement de carte. Nécessite la référence acheteur customer.reference.

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

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

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.

Dans tous les cas, la banque émettrice décide seule du mode d'authentification de l'acheteur.

Lors de l'enregistrement d'une carte, une authentification forte est requise, sans tenir compte de la préférence du marchand.

Cas d'utilisation Valeurs possibles
CHALLENGE: Avec interaction du porteur
  • ENABLED : Valeur dépréciée
  • CHALLENGE_REQUESTED : Permet de demander une authentification forte pour la transaction.
  • CHALLENGE_MANDATE : Permet de demander une authentification forte pour la transaction pour des raisons règlementaires.
FRICTIONLESS Sans interaction du porteur

Option "Frictionless 3DS2" obligatoire
  • DISABLED : Permet de demander une exemption à l'authentification forte.
    • Transactions à faible montant
    • LRM (Low Risk Merchant)

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
  • 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.
  • AUTO: Le choix de la préférence est délégué à l'émetteur de la carte (No Preference).

Tableau des exemptions (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 €, 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 de contestation du porteur.
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 :

    • Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles.
    • Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions :
      • Avoir un contrat CB.
      • Etre éligible à la TRA acquéreur.
      • Transmettre les valeurs requises dans le flux 3D 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 LRM de CB, vous devez contacter le Service client E-commerce pour obtenir un accord explicite.

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

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

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

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

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

retry

Chemin: transactionOptions.cardOptions.retry

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

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

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

Format

Référence de la réponse

Réponse Contexte
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.