Réponse Payment
Payment est un objet qui décrit le résultat d'un paiment. Il est retourné par le web service REST Charge/CreatePayment, et par l'IPN.
L'objet Payment peut contenir plusieurs transactions.
Structure de l'objet Payment
L'objet Payment est structuré de la façon suivante:
Dans le cas général, la liste transactions ne contient qu'une transaction. Mais dans le cas du paiement fractionné (la commande est réglée avec plusieurs moyens de paiements), plusieurs transactions peuvent être créées. C'est pour cette raison que vous devez toujours utiliser les champs orderStatus et orderCycle pour vérifier le statut de la commande.
Référence de la réponse
orderStatus
Statut consolidé des transactions contenues dans la commande.
Description
Une commande peut contenir plusieurs transactions. OrderStatus consolide le status de toutes les transactions rattachées à la commande.
Pour plus d'information, rendez-vous ici: Cycle de vie d'une transaction
Valeurs possibles
Les valeurs possibles sont les suivantes:
| STATUS | DESCRIPTION |
|---|---|
| PAID | La commande est payée |
| UNPAID | La commande n'a pas été payée |
| RUNNING | La commande est en cours |
| PARTIALLY_PAID | La commande a été partiellement payée |
| ABANDONED | La commande a été abandonnée |
Format
orderCycle
Défini si la commande est ouverte (OPEN, le paiement est autorisé), ou fermé (CLOSED, elle ne peut plus être modifiée).
orderCycle prend la valeur CLOSED si celle ci ne peux plus être modifiée:
- Lorsque la commande est entiérement payée
- Lorsque toutes le tentatives de paiement autorisées sont épuisées
Sinon, orderCycle prend la valeur OPEN
Valeurs possibles
Les valeurs possibles sont les suivantes:
| STATUS | DESCRIPTION |
|---|---|
| OPEN | La commande est en cours. Vous devez conserver le panier car d'autres tentatives de paiement peuvent intervenir. |
| CLOSED | La commande est soit totalement payée, soit la dernière tentative a été refusée (dans ce cas, vous devez générer un nouveau formToken). |
Format
Cas d'usages OPEN
Par défaut, un acheteur a 4 tentatives pour payer sa commande. Tant que toutes ces tentatives n'ont pas été éffectué, orderCycle est défini à OPEN.
Une commande peut aussi être payée à partir de plusieurs transactions, ou avec plusieurs moyens de paiement. Tant que la totalité de la commande n'est pas payée, orderCycle est défini à OPEN.
Si la transaction associée est en validation manuelle, orderCycle est défini à OPEN.
Cas d'usages CLOSED
Si la totalité de la commande est payée, orderCycle sera défini à CLOSED.
Lorsque la commande expire, orderCycle est défini à CLOSED.
Si toutes les tentatives de paiement autorisées ont échoué (4 par défaut), orderCycle est défini à CLOSED.
Si la transaction est initialement créée en validation manuelleorderCycle sera défini à CLOSED lorsque la transaction sera soit validée, soit annulée.
shopId
Identifiant de la boutique.
Format
orderEffectiveAmount
Chemin: orderDetails.orderEffectiveAmount
Montant original de la transaction en cas de conversion de devise.
Format
orderDetails.mode
Permet de définir le mode dans lequel a été créée la commande.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| STATUS | DESCRIPTION |
|---|---|
| TEST | pour une commande de test |
| PRODUCTION | pour une commande réelle |
Format
orderCurrency
Chemin: orderDetails.orderCurrency
Code de la devise de la commande, au format 4217 alpha-3.
Exemple: "EUR" pour l'euro.
Format
orderDetails.orderId
Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.
Format
orderTotalAmount
Chemin: orderDetails.orderTotalAmount
Montant total de la commande exprimé dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
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
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
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
ipAddress
Chemin: customer.extraDetails.ipAddress
Adresse IP de l'acheteur.
Format
fingerPrintId
Chemin: customer.extraDetails.fingerPrintId
Format
browserUserAgent
Chemin: customer.extraDetails.browserUserAgent
Header « User-Agent » du navigateur de l'acheteur (HTTP/1.1 - RFC. 2616).
Format
browserAccept
Chemin: customer.extraDetails.browserAccept
Header « Accept » du navigateur de l'acheteur (HTTP/1.1 - RFC. 2616).
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
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
transactions.amount
Montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
creationDate
Chemin: transactions.creationDate
Date et heure d'enregistrement de la transaction.
Format
currency
Chemin: transactions.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 |
detailedErrorCode
Chemin: transactions.detailedErrorCode
Code d'erreur détaillé retourné par l'acquéreur, sans filtre ni modification.
Voir Liste des codes retour autorisation pour plus de détails.
Format
detailedErrorMessage
Chemin: transactions.detailedErrorMessage
Message d'erreur détaillé retourné par l'application de paiement sans filtre.
Il contient des informations contextuelles pour aider à comprendre l'erreur.
Ce champ peut être valorisé à null lorsque errorCode vaut ACQ_001.
Consultez la description du champ detailedErrorCode pour connaitre le motif du refus d'autorisation.
Format
detailedStatus
Chemin: transactions.detailedStatus
Le paramètre detailedStatus donne des informations détaillées sur le statut du paiement. Chacun des statuts est propre au moyen de paiement utilisé.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| detailedStatus | Description |
|---|---|
| ACCEPTED | Statut d'une transaction de type VERIFICATION dont l'autorisation ou la demande de renseignement a été acceptée. Ce statut ne peut évoluer. Les transactions dont le statut est "ACCEPTED" ne sont jamais remises en banque. Une transaction de type VERIFICATION est créée lors de la mise à jour ou la création d'un alias sans paiement. |
| AUTHORISED | Le montant est autorisé et va être capturé automatiquement. |
| AUTHORISED_TO_VALIDATE | La transaction, créée en validation manuelle, est autorisée. Le marchand doit valider manuellement la transaction afin qu'elle soit remise en banque. La transaction peut être validée tant que la date d'expiration de la demande d'autorisation n’est pas dépassée. Si cette date est dépassée alors le paiement prend le statut EXPIRED. Le statut Expiré est définitif. |
| CANCELLED | La transaction a été annulée. |
| CAPTURED | Le montant de la transaction a été capturé. |
| CAPTURE_FAILED | La remise de la transaction a échoué. Contactez le Support. |
| EXPIRED | La date d'expiration de la demande d'autorisation est atteinte et le marchand n’a pas validé la transaction. Le porteur ne sera donc pas débité. |
| INITIAL | Ce statut est temporaire. Il est retourné lorsqu'aucune réponse n'est renvoyée par l'acquéreur ou le délai de réponse de la part de l'acquéreur est supérieur à la durée de session du paiement sur la plateforme de paiement. |
| PENDING | Remboursement: Le remboursement est en cours de traitement. Marketplace: Le paiement s'est déroulé avec succès. La ou les transactions correspondantes sont créées et en attente de remise, ou éventuellement en attente de validation manuelle. |
| PRE_AUTHORISED | Statut d'une transaction de type PRE_AUTHORISATION dont l'autorisation a été acceptée. Ce statut ne peut évoluer. Les transactions dont le statut est "PRE_AUTHORISED" ne sont jamais remises en banque. |
| REFUSED | La transaction a été refusée. |
| UNDER_VERIFICATION | Vérifications en cours par l'acquéreur. Ce statut n'est pas final. |
| WAITING_AUTHORISATION | Le délai de remise en banque est supérieur à la durée de validité de l'autorisation. |
| WAITING_AUTHORISATION_TO_VALIDATE | Le moyen de paiement a été vérifié mais la transaction n'a pas encore été autorisée car le délai de remise est supérieur à la durée de validité de l'autorisation. La demande d’autorisation sera déclenchée automatiquement à J-1 avant la date de remise en banque et une intervention manuelle sera nécessaire pour confirmer l'autorisation. Rien ne garantit que la demande d'autorisation sera acceptée. |
| WAITING_FOR_PAYMENT | Transaction en attente de paiement. Ce statut n'est pas final. |
| ERROR | Une erreur non prévue a eu lieu. |
Pour plus de détail sur le cycle de vie d'une transaction, rendez-vous ici: Cycle de vie d'une transaction
Format
Pour plus de détail sur le cycle de vie d'une transaction, rendez-vous ici: Cycle de vie d'une transaction
Format
effectiveStrongAuthentication
Chemin: transactions.effectiveStrongAuthentication
Indique si le porteur s'est authentifié avec succès durant le paiement.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| Valeur | Description |
|---|---|
| ENABLED | Le porteur s'est authentifié avec succès. |
| DISABLED | Le paiement n'est pas soumis à une authentification du porteur ou l'authentification du porteur est en échec. |
Format
errorCode
Chemin: transactions.errorCode
Code d'erreur. Voir Codes d'erreur pour plus de détails.
Format
errorMessage
Chemin: transactions.errorMessage
Message d'erreur. Voir Codes d'erreur pour plus de détails.
Format
metadata
Chemin: transactions.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
operationType
Chemin: transactions.operationType
Type d'opération.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| Valeur | Description |
|---|---|
| DEBIT | Opération de débit |
| CREDIT | Opération de remboursement |
| VERIFICATION | Opération de verification de moyen de paiement |
Format
transactions.uuid
Référence unique de la transaction générée par la plateforme de paiement.
Format
paymentMethodToken
Chemin: transactions.paymentMethodToken
Alias (ou token) associé à un moyen de paiement.
Format
paymentMethodType
Chemin: transactions.paymentMethodType
Type de moyen de paiement. Exemple: PAYCONIQ
Format
shopId
Identifiant de la boutique.
Format
transactions.status
Statut simplifié de la transaction. Il est commun à tous les modes de paiement. Il vous permet d'implementer un code générique compatible avec tous les moyens de paiements.
Chaque moyen de paiement possède également des status dédiés.voir la propriété detailedStatus pour plus de détails.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| STATUS | DESCRIPTION |
|---|---|
| PAID | La transaction est payé |
| UNPAID | La transaction n'a pas été payée |
| RUNNING | La transaction est en cours |
| PARTIALLY_PAID | La transaction a été partiellement payée |
Pour plus de détail sur le cycle de vie d'une transaction, rendez-vous ici: Cycle de vie d'une transaction
Format
liabilityShift
Chemin: transactions.transactionDetails.liabilityShift
Défini si le paiement est garanti.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| VALEURS | DESCRIPTION |
|---|---|
| YES | le paiement est garanti |
| NO | le paiement n'est pas garanti |
| nulle | le paiement n'est pas garanti |
Format
mid
Chemin: transactions.transactionDetails.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
effectiveAmount
Chemin: transactions.transactionDetails.effectiveAmount
Montant original de la transaction en cas de conversion de devise.
Format
sequenceNumber
Chemin: transactions.transactionDetails.sequenceNumber
Numéro de séquence de la transaction.
Format
effectiveCurrency
Chemin: transactions.transactionDetails.effectiveCurrency
Devise originale de la transaction en cas de conversion de devise.
Format
creationContext
Chemin: transactions.transactionDetails.creationContext
Précise le process qui a initié la transaction.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| VALEURS | DESCRIPTION |
|---|---|
| CHARGE | Pour une demande de débit |
| REFUND | Pour une demande de crédit |
Format
parentTransactionUuid
Chemin: transactions.transactionDetails.parentTransactionUuid
UUID de la transaction source.
Format
paymentSource
Chemin: transactions.transactionDetails.cardDetails.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 |
| Absent ou null | La valeur par défaut est "EC". |
manualValidation
Chemin: transactions.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 |
expectedCaptureDate
Chemin: transactions.transactionDetails.cardDetails.expectedCaptureDate
Date de remise en banque exprimée au format ISO 8601 définit par W3C.
Format
effectiveBrand
Chemin: transactions.transactionDetails.cardDetails.effectiveBrand
Marque de la carte.
| Moyen de paiement | Type de carte (effectiveBrand) |
|---|---|
| Carte enseigne Accord | ACCORD_STORE |
| Carte enseigne Accord - Mode sandbox | ACCORD_STORE_SB |
| Alipay | ALIPAY |
| Akulaku paylater ID (Indonésie) | AKULAKU_ID |
| Akulaku paylater PH (Philippines) | AKULAKU_PH |
| Alipay (Chine) | ALIPAY_CN |
| Alipay (Hong Kong) | ALIPAY_HK |
| BillEase (Philippines) | BILLEASE |
| Boost (Philippines) | BOOST |
| BPI (Philippines) | BPI |
| Dana (Indonésie) | DANA |
| GCash (Philippines) | GCASH |
| Kakao Pay (Corée du Sud) | KAKAOPAY |
| Kredivo (Indonésie) | KREDIVO_ID |
| Maya (Philippines) | MAYA |
| MPay (Macao) | MPAY |
| Rabbit LINE Pay (Thaïlande) | RABBIT_LINE_PAY |
| Touch 'n Go eWallet (Malaisie) | TNG |
| Toss Pay (Corée du Sud) | TOSS |
| TrueMoney Wallet(Thaïlande) | TRUEMONEY |
| Alma en 2 fois | ALMA_2X |
| Alma en 3 fois | ALMA_3X |
| Alma en 4 fois | ALMA_4X |
| Alma en 10 fois | ALMA_10X |
| Alma en 12 fois | ALMA_12X |
| American Express | AMEX |
| Titre-Restaurant Dématérialisé Apetiz | APETIZ |
| Paiement par Wallet Apple Pay | APPLE_PAY |
| Carte Cpay | AURORE-MULTI |
| Bancontact Mistercash | BANCONTACT |
| Bizum | BIZUM |
| CB | CB |
| Titre-Restaurant Dématérialisé Chèque Déjeuner | CHQ_DEJ |
| Carte Aurore "CORA" | CORA |
| Carte Aurore "CORA blanche" | CORA_BLANCHE |
| Carte Aurore "CORA Premium" | CORA_PREM |
| Carte Aurore "CORA VISA" | CORA_VISA |
| Cofidis en 3 fois (France) | COFIDIS_3X_FR |
| Cofidis en 4 fois (France) | COFIDIS_4X_FR |
| Cofidis en 5 ou 12 fois (France) | COFIDIS_LOAN_CB |
| Cofidis Pay | COFIDIS_PAY_FR |
| Cofidis Pay Later (France) | COFIDIS_DFPAY_FR |
| Cofidis en 10 ou 60 fois (France) | COFIDIS_LOAN_FR |
| Cofidis en 4 fois (Espagne) | COFIDIS_4X_ES |
| Cofidis en 5 ou 12 fois (Espagne) | COFIDIS_LOAN_ES |
| FLOA en 3 fois | FLOA_3X |
| FLOA en 4 fois | FLOA_4X |
| FLOA en 10 fois | FLOA_10X |
| FLOA Pay Later | FLOA_PAYLATER |
| Titre-Restaurant Dématérialisé Conecs | CONECS |
| Diners | DINERS |
| Discover | DISCOVER |
| e-carte bleue | E-CARTEBLEUE |
| Ticket Eco Chèque Edenred | EDENRED_EC |
| Ticket Sports & Culture Edenred | EDENRED_SC |
| Ticket Compliment Edenred | EDENRED_TC |
| Ticket Restaurant Edenred | EDENRED_TR |
| Paiement en 3X Franfinance | FRANFINANCE_3X |
| Paiement en 4X Franfinance | FRANFINANCE_4X |
| Paiement en 3x sans frais par BNPP PF | FULLCB3X |
| Paiement en 4x sans frais par BNPP PF | FULLCB4X |
| Paiement par Wallet Google Pay | GOOGLEPAY |
| iDeal Internet Banking | IDEAL |
| Carte Cadeau Illicado - Mode sandbox | ILLICADO_SB |
| Virement SEPA | IP_WIRE |
| JCB | JCB |
| Maestro | MAESTRO |
| Mastercard | MASTERCARD |
| Multibanco | MULTIBANCO |
| MB Referência | MULTIBANCO |
| MB Way | MULTIBANCO |
| MyBank | MYBANK |
| Payconiq | PAYCONIQ |
| PayDirekt | PAYDIREKT |
| PAYPAL | PayPal |
| PAYPAL_BNPL | PayPal Pay Later |
| PAYPAL_SB | PayPal - Mode sandbox |
| PAYPAL_BNPL_SB | PayPal Pay Later- Mode sandbox |
| PostFinance | POSTFINANCE |
| PostFinance E-finance | POSTFINANCE_EFIN |
| Przelewy24 | PRZELEWY24 |
| Paiement par Wallet Samsung Pay | SAMSUNG_PAY |
| Prélèvement Bancaire SEPA DIRECT DEBIT | SDD |
| Titre-Restaurant Dématérialisé Sodexo | SODEXO |
| Union Pay | UNION_PAY |
| BHIM-UPI | BHIM-UPI |
| Visa | VISA |
| Visa Electron | VISA_ELECTRON |
| Vpay | VPAY |
| WeChat Pay |
Format
pan
Chemin: transactions.transactionDetails.cardDetails.pan
Numéro de carte tronqué.
Format
expiryMonth
Chemin: transactions.transactionDetails.cardDetails.expiryMonth
Mois d’expiration sur 2 chiffres. Exemple : "09" pour septembre.
Format
expiryYear
Chemin: transactions.transactionDetails.cardDetails.expiryYear
Année d’expiration sur 2 chiffres. Exemple : "25" pour 2025.
Format
country
Chemin: transactions.transactionDetails.cardDetails.country
Code pays de la carte.
Format
issuerCode
Chemin: transactions.transactionDetails.cardDetails.issuerCode
Code banque associé à la banque émettrice.
Format
issuerName
Chemin: transactions.transactionDetails.cardDetails.issuerName
Nom de la banque associé à la banque émettrice.
Format
effectiveProductCode
Chemin: transactions.transactionDetails.cardDetails.effectiveProductCode
Code produit de la carte utilisée pour le paiement.
| VISA | Désignation |
|---|---|
| A | Visa Traditional |
| B | Visa Traditional Rewards |
| C | Visa Signature |
| D | Visa Signature Preferred |
| E | Proprietary ATM |
| F | Visa Classic |
| G | Visa Business |
| G1 | Visa Signature Business |
| G2 | Reserved |
| G3 | Visa Business Enhanced |
| G4 | Visa Infinite Business |
| G5 | Visa Business Rewards |
| H | Reserved |
| I | Visa Infinite |
| I1 | Visa Infinite Privilege |
| I2 | Visa Ultra High Net Worth |
| J | Reserved |
| J1 | Reserved |
| J2 | Reserved |
| J3 | Visa Healthcare |
| J4 | Reserved |
| K | Visa Corporate T&E |
| K1 | Visa GSA Corporate T&E |
| L | Electron |
| N | Visa Platinium |
| N1 | TBA |
| N2 | Visa Select |
| P | Visa Gold |
| Q | Private Label |
| Q1 | Reserved |
| Q2 | Private Label Basic |
| Q3 | Private Label Standard |
| Q4 | Private Label Enhanced |
| Q5 | Private Label Specialized |
| Q6 | Private Label Premium |
| R | Proprietary |
| S | Visa Purchasing |
| S1 | Visa Purchasing |
| S2 | Visa Purchasing |
| S3 | Visa Purchasing |
| S4 | Government Services Loan |
| S5 | Commercial Transport EBT |
| S6 | Business Loan |
| S7 | Visa Distribution |
| T | Reserved |
| U | Visa TravelMoney |
| V | Visa VPay |
| W | Reserved |
| X | Reserved |
| Y | Reserved |
| Z | Reserved |
| MASTERCARD | Désignation |
|---|---|
| BPD | MASTERCARD BUSINESS PREMIUM DEBIT |
| CIR | CIRRUS |
| DAG | GOLD DEBIT MASTERCARD SALARY |
| DAP | PLATINUM DEBIT MASTERCARD SALARY |
| DAS | STANDARD DEBIT MASTERCARD SALARY |
| DDB | DOMESTIC DEBIT BRAND |
| DLG | DEBIT GOLD DELAYED DEBIT |
| DLH | DEBIT WORLD EMBOSSED DELAYED DEBIT |
| DLP | DEBIT PLATINUM DELAYED DEBIT |
| DLS | MASTERCARD CARD-DELAYED DEBIT |
| DOS | STANDARD DEBIT MASTERCARD SOCIAL |
| DWF | DEBIT MASTERCARD HUMANITARIAN PREPAID |
| M | MASTERCARD |
| MAB | WORLD ELITE MASTERCARD |
| MAC | MASTERCARD CORPORATE WORLD ELITE |
| MAP | MASTERCARD COMMERCIAL PAYMENTS ACCOUNT |
| MBB | MASTERCARD PREPAID CONSUMER |
| MBC | MASTERCARD PREPAID VOUCHER |
| MBD | MASTERCARD PROFESSIONAL DEBIT BUSINESS CARD |
| MBE | MASTERCARD ELECTRONIC BUSINESS CARD |
| MBK | MASTERCARD BLACK |
| MBP | MASTERCARD UNKNOWN PRODUCT |
| MBS | MASTERCARD B2B PRODUCT |
| MBT | MASTERCARD CORPORATE PREPAID TRAVEL |
| MBW | WORLD MASTERCARD BLACK EDITION – DEBIT |
| MCB | MASTERCARD BUSINESS CARD |
| MCC | MASTERCARD CREDIT MIXED BIN CARD |
| MCD | MASTERCARD DEBIT CARD |
| MCE | MASTERCARD ELECTRONIC CARD |
| MCF | MASTERCARD FLEET CARD |
| MCG | MASTERCARD GOLD CARD |
| MCH | MASTERCARD PREMIUM CHARGE |
| MCO | MASTERCARD CORPORATE CARD |
| MCP | MASTERCARD PURCHASING CARD |
| MCS | MASTERCARD STANDARD CARD |
| MCT | TITANIUM MASTERCARD CARD |
| MCV | MERCHANT BRANDED PROGRAM |
| MCW | WORLD MASTERCARD CARD |
| MDB | DEBIT MASTERCARD BUSINESSCARD CARD |
| MDG | DEBIT GOLD MASTERCARD CARD |
| MDH | DEBIT OTHER EMBOSSED |
| MDJ | DEBIT OTHER 2 EMBOSSED |
| MDL | BUSINESS DEBIT OTHER EMBOSSED |
| MDN | BUSINESS DEBIT OTHER 2 EMBOSSED |
| MDO | DEBIT OTHER CARD |
| MDP | DEBIT PLATINUM CARD |
| MDR | DEBIT BROKERAGE CARD |
| MDS | DEBIT MASTERCARD CARD |
| MDT | MASTERCARD BUSINESS DEBIT |
| MDW | WORLD ELITE DEBIT MASTERCARD |
| MEB | MASTERCARD EXECUTIVE BUSINESS CARD |
| MEC | MASTERCARD ELECTRONIC COMMERCIAL CARD |
| MEF | ELECTRONIC PAYMENT ACCOUNT |
| MEO | MASTERCARD CORPORATE EXECUTIVE CARD |
| MET | TITANIUM DEBIT MASTERCARD CARD |
| MFB | FLEX WORLD ELITE |
| MFD | FLEX PLATINUM |
| MFE | FLEX CHARGE WORLD ELITE |
| MFH | FLEX WORLD |
| MFL | FLEX CHARGE PLATINUM |
| MFW | FLEX CHARGE WORLD |
| MGF | MASTERCARD GOUVERNMENT COMMERCIAL CARD |
| MHA | MASTERCARD HEALTHCARE PREPAID NON-TAX |
| MHB | MASTERCARD HSA SUBSTANTIATED (DEBIT MASTERCARD) |
| MHD | HELOC DEBIT STANDARD |
| MHH | MASTERCARD HSA NON-SUBSTANTIATED (DEBIT MASTERCARD) |
| MHL | HELOC DEBIT GOLD |
| MHM | HELOC DEBIT PLATINUM |
| MHN | HELOC DEBIT PREMIUM |
| MIA | PREPAID MASTERCARD UNEMBOSSED STUDENT CARD |
| MIP | PREPAID DEBIT MASTERCARD STUDENT CARD |
| MIU | DEBIT MASTERCARD UNEMBOSSED |
| MLA | MASTERCARD CENTRAL TRAVEL SOLUTIONS AIR CARD |
| MLD | MASTERCARD DISTRIBUTION CARD |
| MLL | MASTERCARD CENTRAL TRAVEL SOLUTIONS LAND CARD |
| MNF | MASTERCARD PUBLIC SECTOR COMMERCIAL CARD |
| MNW | MASTERCARD NEW WORLD |
| MOC | MASTERCARD UNKNOWN PRODUCT |
| MOG | MAESTRO GOLD |
| MOP | MAESTRO PLATINIUM |
| MOW | MAESTRO WORLD |
| MPA | MASTERCARD PREPAID DEBIT STANDARD-PAYROLL |
| MPB | PREFERRED BUSINESS CARD |
| MPC | MPC |
| MPD | MASTERCARD FLEX PREPAID |
| MPF | MASTERCARD PREPAID DEBIT STANDARD-GIFT |
| MPG | MASTERCARD UNEMBOSSED PREPAID STUDENT CARD |
| MPH | MASTERCARD CASH PREPAID |
| MPJ | PREPAID DEBIT MASTERCARD CARD GOLD |
| MPK | PREPAID MASTERCARD GOUVERNMENT COMMERCIAL CARD |
| MPL | PLATINIUM MASTERCARD CARD |
| MPM | MASTERCARD PREPAID DEBIT STANDARD-CONSUMER INCENTIVE |
| MPN | MASTERCARD PREPAID DEBIT STANDARD-INSURANCE |
| MPO | MASTERCARD PREPAID DEBIT STANDARD-OTHER |
| MPP | PRE-PAID CARD |
| MPR | MASTERCARD PREPAID DEBIT STANDARD-TRAVEL |
| MPT | MASTERCARD PREPAID DEBIT STANDARD-TEEN |
| MPV | MASTERCARD PREPAID DEBIT STANDARD-GOVERNMENT |
| MPW | DEBIT MASTERCARD BUSINESS CARD PREPAID WORK B2B |
| MPX | MASTERCARD PREPAID DEBIT STANDARD-FLEX BENEFIT |
| MPY | MASTERCARD PREPAID DEBIT STANDARD-EMPLOYEE INCENTIVE |
| MPZ | MASTERCARD PREPAID DEBIT STANDARD – GOVERNMENT CONSUMER |
| MRC | MASTERCARD ELECTRONIC CONSUMER PREPAID |
| MRF | MASTERCARD EUROPEAN REGULATED INDIVIDUAL PAY |
| MRG | MASTERCARD STANDARD PREPAID |
| MRH | MASTERCARD UNKNOWN PRODUCT |
| MRJ | PREPAID MASTERCARD GOLD CARD |
| MRK | PREPAID MASTERCARD PUBLIC SECTOR COMMERCIAL CARD |
| MRL | PREPAID MASTERCARD ELECTRONIC COMMERCIAL CARD (NON-US) |
| MRO | MASTERCARD REWARDS ONLY |
| MRP | STANDARD RETAILER CENTRIC PAYMENTS |
| MRW | MASTERCARD CREDIT BUSINESS CARD PREPAID |
| MSA | PREPAID MAESTRO PAYROLL CARD |
| MSB | MAESTRO SMALL BUSINESS CARD |
| MSF | PREPAID MAESTRO GIFT CARD |
| MSG | PREPAID MAESTRO CONSUMER RELOADABLE CARD |
| MSI | MAESTRO |
| MSJ | PREPAID MAESTRO GOLD |
| MSM | PREPAID MAESTRO CONSUMER PROMOTION CARD |
| MSN | PREPAID MAESTRO INSURANCE CARD |
| MSO | PREPAID MAESTRO OTHER CARD |
| MSQ | RESERVED FOR FUTURE USE |
| MSR | PREPAID MAESTRO TRAVEL CARD |
| MST | PREPAID MAESTRO TEEN CARD |
| MSV | PREPAID MAESTRO GOVERNMENT BENEFIT CARD |
| MSW | PREPAID MAESTRO CORPORATE CARD |
| MSX | PREPAID MAESTRO FLEX BENEFIT CARD |
| MSY | PREPAID MAESTRO EMPLOYEE INSENTIVE CARD |
| MSZ | PREPAID MAESTRO EMERGENCY ASSISTANCE CARD |
| MTP | MASTERCARD PLATINUM PREPAID TRAVEL (UK AND BRAZIL) |
| MUW | WORLD DOMESTIC AFFLUENT |
| MWB | WORLD MASTERCARD FOR BUSINESS |
| MWD | WORLD DEFERRED |
| MWE | MASTERCARD WORLD ELITE |
| MWF | MASTERCARD HUMANITARIAN PREPAID |
| MWO | MASTERCARD CORPORATE WORLD |
| MWR | WORLD RETAILER CENTRIC PAYMENTS |
| OLB | MAESTRO SMALL BUSINESS DELAYED DEBIT |
| OLG | MAESTRO GOLD DELAYED DEBIT |
| OLP | MAESTRO PLATINUM DELAYED DEBIT |
| OLS | MAESTRO-DELAYED DEBIT |
| OLW | MAESTRO WORLD DELAYED DEBIT |
| PVA | PRIVATE LABEL A |
| PVB | PRIVATE LABEL B |
| PVC | PRIVATE LABEL C |
| PVD | PRIVATE LABEL D |
| PVE | PRIVATE LABEL E |
| PVF | PRIVATE LABEL F |
| PVG | PRIVATE LABEL G |
| PVH | PRIVATE LABEL H |
| PVI | PRIVATE LABEL I |
| PVJ | PRIVATE LABEL J |
| PVL | PRIVATE LABEL CARD |
| SAG | GOLD MASTERCARD SALARY–IMMEDIATE DEBIT |
| SAL | STANDARD MAESTRO SALARY |
| SAP | PLATINUM MASTERCARD SALARY–IMMEDIATE DEBIT |
| SAP | PLATINUM MASTERCARD SALARY IMMEDIATE DEBIT |
| SAS | STANDARD MASTERCARD SALARY–IMMEDIATE DEBIT |
| SOS | STANDARD MASTERCARD SOCIAL–IMMEDIATE DEBIT |
| SUR | PREPAID MASTERCARD UNEMBOSSED (NON-US) |
| SUR | PREPAID UNEMBOSSED MASTERCARD CARD (NON-US) |
| TBE | MASTERCARD ELECTRONIC BUSINESS IMMEDIATE DEBIT |
| TCB | MASTERCARD BUSINESS CARD-IMMEDIATE DEBIT |
| TCC | MASTERCARD MIXED BIN-IMMEDIATE DEBIT |
| TCE | MASTERCARD ELECTRONIC IMMEDIATE DEBIT |
| TCF | MASTERCARD FLEET CARD IMMEDIATE DEBIT |
| TCG | LD MASTERCARD CARD-IMMEDIATE DEBIT |
| TCO | MASTERCARD (CORPORATE) IMMEDIATE DEBIT |
| TCP | MASTERCARD PURCHASING CARD IMMEDIATE DEBIT |
| TCS | MASTERCARD STANDARD CARD-IMMEDIATE DEBIT |
| TCW | WORLD SIGNIA MASTERCARD CARD-IMMEDIATE DEBIT |
| TEB | MASTERCARD EXECUTIVE BUSINESS CARD IMMEDIATE DEBIT |
| TEC | MASTERCARD ELECTRONIC COMMERCIAL IMMEDIATE DEBIT |
| TEO | MASTERCARD CORPORATE EXECUTIVE IMMEDIATE DEBITCARD |
| TIU | TIU |
| TNF | MASTERCARD PUBLIC SECTOR COMMERCIAL CARD IMMEDIATE DE |
| TNW | MASTERCARD NEW WORLD-IMMEDIATE DEBIT |
| TPB | PREFERRED BUSINESS CARD IMMEDIATE DEBIT |
| TPL | PLATINUM MASTERCARD IMMEDIATE DEBIT |
| TWB | WORLD MASTERCARD BLACK EDITION IMMEDIATE DEBIT |
| WBE | MASTERCARD UNKNOWN PRODUCT |
| WDR | WORLD DEBIT MASTERCARD REWARDS |
| WMR | WORLD MASTERCARD REWARDS |
| CB | Désignation |
|---|---|
| 1 | Carte nationale de retrait |
| 2 | Carte nationale de retrait et de paiement |
| 3 | Carte nationale de paiement |
| 4 | Carte nationale de paiement et de retrait à autorisation systématique |
| 5 | Carte nationale de paiement à autorisation systématique |
| Autre codes produits | Désignation |
|---|---|
| AX | AMERICAN EXPRESS |
| DI | DISCOVER |
| DN | DINERS |
| JC | JCB |
Format
paymentMethodSource
Chemin: transactions.transactionDetails.cardDetails.paymentMethodSource
Permet de caractériser le mode de moyen de paiement utilisé.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| STATUS | DESCRIPTION |
|---|---|
| NEW | Transaction créée à partir d'un nouveau moyen de paiement. |
| TOKEN | Transaction créée à partir d'un moyen de paiement existant. |
Format
legacyTransId
Chemin: transactions.transactionDetails.cardDetails.legacyTransId
Identifiant de la transaction sur 6 caractères.
Format
cardHolderName
Chemin: transactions.transactionDetails.cardDetails.cardHolderName
Nom et prénom du porteur de la carte (recommandé)
Format
cardHolderPan
Chemin: transactions.transactionDetails.cardDetails.cardHolderPan
Numéro masqué de la carte utilisée par l'acheteur au format 123456XXXXXX1234.
Ce champ peut être utilisé par les marchands qui affichent leur propre ticket de paiement.
Si le moyen de paiement utilisé n'est pas une carte, ce champ est retourné à vide.
Format
cardHolderExpiryMonth
Chemin: transactions.transactionDetails.cardDetails.cardHolderExpiryMonth
- Mois d’expiration de la carte affiché sur le ticket de paiement.
- Valorisé à vide si le moyen de paiement utilisé n'est pas une carte.
Format
cardHolderExpiryYear
Chemin: transactions.transactionDetails.cardDetails.cardHolderExpiryYear
- Année d'expiration de la carte affichée sur le ticket de paiement.
- Valorisé à vide si le moyen de paiement utilisé n'est pas une carte.
Format
identityDocumentType
Chemin: transactions.transactionDetails.cardDetails.identityDocumentType
Type de pièce d'identité.
Format
identityDocumentNumber
Chemin: transactions.transactionDetails.cardDetails.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
legacyTransDate
Chemin: transactions.transactionDetails.cardDetails.legacyTransDate
Date et heure de reception de la requête de paiement. Utilisé pour retrouver les transactions id ancien format.
Format
productCategory
Chemin: transactions.transactionDetails.cardDetails.productCategory
Catégorie du produit de la carte.
La valeur est issue des fichiers de plages de BIN.
Valeurs possibles
| Valeur | Description |
|---|---|
| CREDIT | Carte de crédit |
| DEBIT | Carte de débit |
| PREPAID | Carte prépayée |
Format
nature
Chemin: transactions.transactionDetails.cardDetails.nature
Nature de la carte.
Champ vide si non fourni par l'acquéreur.
Valeurs possibles
| Valeur | Description |
|---|---|
| CONSUMER_CARD | Carte personnelle |
| COMMERCIAL_CARD | Carte commerciale |
Format
amount
Chemin: transactions.transactionDetails.cardDetails.authorizationResponse.amount
Montant de l’autorisation.
Format
currency
Chemin: transactions.transactionDetails.cardDetails.authorizationResponse.currency
Code de la devise utilisée lors de la demande d’autorisation.
Format
authorizationDate
Chemin: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationDate
Date et heure de la demande d’autorisation.
Format
authorizationNumber
Chemin: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationNumber
Numéro de la demande d’autorisation.
Format
authorizationResult
Chemin: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationResult
Code retour de la demande d’autorisation.
Voir Liste des codes retour autorisation pour plus de détails.
Format
authorizationMode
Chemin: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationMode
Spécifie de quelle manière est réalisée la demande d’autorisation.
Valeurs possibles
| valeurs | Description |
|---|---|
| MARK | Une pré-autorisation d'un montant nul ou unitaire à été effectuée, voir plus bas. |
| FULL | Autorisation pour le montant total demandée dans la requête. |
Lorsque authorizationMode vaut MARK: Une autorisation de 1 EUR (ou demande de renseignement sur le réseau CB si l'acquéreur le supporte)a été réalisée afin de vérifier la validité de la carte. Ce cas se présente lorsque la date de remise dépasse la période de validité d'une autorisation (7 jours pour VISA / MasterCard / CB / AMEX en France par exemple).
Format
amount
Chemin: transactions.transactionDetails.cardDetails.markAuthorizationResponse.amount
Montant de la pré-autorisation.
Format
currency
Chemin: transactions.transactionDetails.cardDetails.markAuthorizationResponse.currency
Code de la devise utilisée lors de la demande de pré-autorisation.
Format
authorizationDate
Chemin: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationDate
Date et heure de la demande de pré-autorisation.
Format
authorizationNumber
Chemin: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationNumber
Numéro de la demande de pré-autorisation.
Format
authorizationResult
Chemin: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationResult
Code retour de la demande de pré-autorisation.
Format
captureDate
Chemin: transactions.transactionDetails.cardDetails.captureResponse.captureDate
Date et heure de remise.
Format
captureFileNumber
Chemin: transactions.transactionDetails.cardDetails.captureResponse.captureFileNumber
Numéro de remise.
Champ spécifique au moyen de paiement PSE REST.
Format
refundAmount
Chemin: transactions.transactionDetails.cardDetails.captureResponse.refundAmount
Montant remboursé.
Format
refundCurrency
Chemin: transactions.transactionDetails.cardDetails.captureResponse.refundCurrency
Devise du montant remboursé.
Format
effectiveRefundAmount
Chemin: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundAmount
Format
effectiveRefundCurrency
Chemin: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundCurrency
Format
transactionCondition
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.transactionCondition
Statut de l'authentification 3D Secure.
Valeurs possibles
Statut de l'authentification du porteur.
| VALEUR | DESCRIPTION |
|---|---|
| COND_3D_SUCCESS | Succès de l'authentification. Le marchand et le porteur de la carte sont inscrits au programme 3D Secure et le porteur s’est authentifié correctement. |
| COND_3D_FAILURE | Echec de l’authentification. Le marchand et le porteur de la carte sont inscrits au programme 3D Secure mais l’acheteur n’a pas réussi à s’authentifier (mauvais mot de passe). |
| COND_3D_ERROR | Authentification en erreur. Le marchand participe au programme 3D Secure mais le serveur de la plateforme de paiement a rencontré un problème technique durant le processus d’authentification (lors de la vérification de l’inscription de la carte au programme 3D ou de l’authentification du porteur). |
| COND_3D_NOTENROLLED | Porteur non enrôlé. Le marchand participe au programme 3D Secure mais la carte du porteur n’est pas enrôlée. |
| COND_3D_ATTEMPT | Tentative d'authentification. Le marchand et le porteur de la carte sont inscrits au programme 3D Secure mais l’acheteur n’a pas eu à s’authentifier (le serveur de contrôle d’accès de la banque qui a émis la carte n’implémente que la génération d’une preuve de tentative d’authentification). |
| COND_SSL | 3D Secure non applicable. Le marchand n’est pas enrôlé à 3D Secure ou le canal de vente n’est pas couvert par cette garantie. |
Format
enrolled
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.enrolled
Statut enrôlement du porteur.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| VALEUR | DESCRIPTION |
|---|---|
| YES | Porteur enrôlé, authentification 3DS possible. Remarque : Dans le Back Office, la valeur ENROLLED est affichée (onglet 3D Secure du Détails d'une transaction). |
| NO | Porteur non enrôlé. Remarque : Dans le Back Office, la valeur NOT_ENROLLED est affichée (onglet 3D Secure du Détails d'une transaction). |
| UNKNOWN | Impossible de vérifier le statut d’enrôlement. Remarque : Dans le Back Office, la valeur UNAVAILABLE est affichée (onglet 3D Secure du Détails d'une transaction). |
Format
status
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.status
Statut de l'authentification du porteur.
Valeurs possibles
Statut de l'authentification du porteur.
| VALEUR | DESCRIPTION |
|---|---|
| YES | Authentification réussie. Remarque : Dans le Back Office, la valeur SUCCESS est affichée (onglet 3D Secure du Détails d'une transaction). |
| NO | Erreur d’authentification. Remarque : Dans le Back Office, la valeur FAILED est affichée (onglet 3D Secure du Détails d'une transaction). |
| UNKNOWN | Authentification impossible. Remarque : Dans le Back Office, la valeur UNAVAILABLE est affichée (onglet 3D Secure du Détails d'une transaction). |
| ATTEMPT | Essai d’authentification. Remarque : Dans le Back Office, la valeur ATTEMPT est affichée (onglet 3D Secure du Détails d'une transaction). |
Format
eci
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.eci
Indicateur de commerce Electronique.
Valeurs possibles
La valeur eci est fonction du statut de l’authentification 3DS et du type de carte. Les valeurs possibles sont :
| TYPE DE CARTE | STATUS=Y | STATUS=A | STATUS=U | STATUS=N |
|---|---|---|---|---|
| VISA - AMEX | 5 | 6 | 7 | - |
| MasterCard | 02 | 01 | - | - |
Format
xid
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.xid
Identifiant unique de la transaction.
Format
cavvAlgorithm
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavvAlgorithm
Algorithme de vérification de l’authentification du porteur.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| VALEUR | DESCRIPTION |
|---|---|
| HMAC | HMAC |
| CVV | Card Verification Value |
| CVV_ATN | CVV Authentication Tracking Number |
| SPA | MasterCard SPA Algorithm. |
| A | AV-CB |
Format
cavv
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavv
Cardholder Authentication Verification Value.
Format
signValid
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.signValid
Validité de la signature du message PaRes.
Valeurs possibles
Statut de l'authentification du porteur.
| VALEUR | DESCRIPTION |
|---|---|
| nulle | Pas de 3DS. |
| 0 | signature incorrecte. |
| 1 | signature correcte. |
Format
brand
Chemin: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.brand
Marque de la carte.
Format
id
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.id
Identifiant unique de l'authentification, au format UUID.
Format
operationSessionId
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.operationSessionId
Identifiant unique de la session d'authentification.
Format
authenticationDateTime
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.authenticationDateTime
Date et heure de l'authentification.
Format
instructionType
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.instructionType
Type de l'instruction à réaliser.
Format
Valeurs possibles
| valeurs | Description |
|---|---|
| FORM | Instruction de type redirection par formulaire |
name
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.name
Nom de l'instruction
Valeurs possibles
| Valeur | Description |
|---|---|
| CHALLENGE | Instruction Challenge, qui permet l'authentification interactive de l'utilisateur auprès de l'ACS |
| FINGERPRINT | Instruction Fingerprint, qui permet d'identifier l'utilisateur auprès de l'ACS |
Format
_type
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value._type
Type de réponse reçue. L'interprétation du reste de la réponse dépend de cet attribut.
Valeurs possibles
| Valeur | Description |
|---|---|
| AuthenticationInstruction | Réponse de type Instruction |
| AuthenticationResult | Réponse de type Résultat final |
Format
timeout
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.timeout
Temps maximum d'attente de la réponse lors de l'exécution d'une instruction, exprimé en secondes. Au-délà de ce temps, il conviendra de provoquer le retour vers le serveur de la plateforme de paiement pour obtenir le résultat final.
Format
method
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.method
Méthode (verbe) utilisée pour la requête.
Valeurs possibles
| Valeur | Description |
|---|---|
| DELETE | Méthode Delete |
| GET | Méthode Get |
| PATCH | Méthode Patch |
| POST | Méthode Post |
| PUT | Méthode Put |
Format
url
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.url
Url à laquelle soumettre le formulaire http.
Format
body
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.body
Liste des paramètres du corps de la requête, sous forme "nom" : "valeur".
Format
headers
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.headers
Liste des entêtes de la requête http, sous forme de "nom": "valeur"
Format
element
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.element
Type d'élement cible html dans lequel devra être matérialisée l'instruction.
Valeurs possibles
| Valeur | Description |
|---|---|
| IFRAME | iFrame |
Format
height
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.height
Hauteur de la cible html en pixels.
Format
visible
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.visible
Booléen indiquant si la cible html doit être visible ou pas.
Format
width
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.width
Largeur de la cible html en pixels.
Format
showUrl
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.showUrl
Champ technique à usage interne, permettant de d'afficher ou de masquer l'URL de l'ACS.
Format
challengePreference
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.challengePreference
Indique si le marchand demande un challenge ou pas.
Valeurs possibles
| valeurs | Description |
|---|---|
| NO_PREFERENCE | Pas de préférence particulière |
| NO_CHALLENGE_REQUESTED | Le challenge n'est pas explicitement demandé |
| CHALLENGE_REQUESTED | Le challenge est demandé par le marchand |
| CHALLENGE_MANDATED | Le challenge est demandé par le marchand pour des raisons réglementaires. |
| DATA_ONLY | Le marchand demande une authentification sans interaction, prise en charge par le DS au lieu de l'ACS de la banque émettrice. |
| DATA_SHARE_ONLY | Le marchand demande une transaction sans interaction du porteur mais pour laquelle il souhaite partager les données via le processus 3DS avec l'émetteur pour réduire le risque de refus lors de l'autorisation. |
Format
name
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.name
Nom du protocole d'authentification du porteur de carte.
Valeurs possibles
| Valeur | Description |
|---|---|
| THREEDS | Protocole 3D Secure |
Format
simulation
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.simulation
Booléen qui indique si l'authentification doit être réalisée en mode simulation. Si vous valorisez ce champ obligatoire à :
true, vous activez le mode simulation.false, vous n'activez pas le mode simulation.
Ce mode permet de réaliser une intégration marchand sans être en production, ni utiliser de vraies cartes.
Format
network
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.network
Réseau sur lequel le moyen de paiement a été authentifié.
Réseaux supportés actuellement
| Valeur |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| PROTECTBUY |
Format
version
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.version
Version du protocole d'authentification du porteur de carte.
Versions supportées actuellement
| Valeur | Description |
|---|---|
| 2.1.0 | Version 2.1.0 |
| 2.2.0 | Version 2.2.0 |
Format
authenticationType
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.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
commerceIndicator
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.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
status
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.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 | Débrayage de l'authentification demandée |
| REJECTED | Authentification rejetée par l'ACS |
Format
authenticationIdType
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.authenticationIdType
Le type d'authentification qui a eu lieu.
Valeurs possibles
| Valeur | Description |
|---|---|
| dsTransId | Le champ provient du champ dsTransId du protocole 3DS V2 |
Format
value
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.value
Valeur de l'identifiant de la transaction d'authentification connu par le réseau bancaire.
La longueur du champ varie en fonction du protocole d'authentification.
| Protocole | Format / Longueur | Exemple de valeur |
|---|---|---|
| 3DS v2 (dsTransId) | chaine / 32 caractères alphanumériques + 4 tirets | 4317fdc3-ad24-5443-8000-000000000891 |
Format
authenticationValueType
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.authenticationValueType
Type de la valeur d'authentification.
Valeurs possibles
| Valeur | Description |
|---|---|
| AEVV | American Express Verification Value (utilisé par Amex) |
| CAVV | Cardholder Authentication Verification Value (utilisé par VISA) |
| AAV | Accountholder Authentication Value (utilisé par Mastercard) |
Format
value
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.value
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
authenticationType
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.authenticationType
Type de l'extension de résultat.
Format
Valeurs possibles
| valeurs | Description |
|---|---|
| THREEDS_V2 | Extension pour les authentifications 3DS Secure v2 |
acsTransId
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.acsTransId
Identifiant de transaction de l'ACS.
Format
cbScore
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.cbScore
Score CB tel que définit dans l'extension CB du message ARES
Format
algorithm
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.algorithm
Code de l'algorithme utilisé pour générer la Valeur d'Authentification (utilisé lors de l'autorisation)
Valeurs possibles
| Valeur | Description |
|---|---|
| 0 | HMAC |
| 1 | CVV |
| 2 | CVV avec ATN |
| 3 | MasterCard SPA |
Format
code
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.code
Code additionnel informatif sur l'origine du résultat. Ex: DS_TIMEOUT
Format
message
Chemin: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.message
Message additionnel informatif sur l'origine du résultat.
Format
installmentNumber
Chemin: transactions.transactionDetails.cardDetails.installmentNumber
Nombre d'échéances.
Format
sequenceType
Chemin: transactions.transactionDetails.cardDetails.sequenceType
Type de la séquence. Exemple : MULTI_PAYMENT_MEAN pour un paiement complémentaire.
Format
installmentCode
Chemin: transactions.transactionDetails.cardDetails.installmentCode
Code de l'option de paiement utilisée pour le paiement.
Format
subscriptionId
Chemin: transactions.transactionDetails.subscriptionDetails.subscriptionId
Identifiant de l'abonnement.
Format
name
Chemin: transactions.transactionDetails.fraudManagement.riskControl.name
Nom du contrôle mis en place dans le cadre de la gestion de risques.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| VALEUR | DESCRIPTION |
|---|---|
| CARD_FRAUD | Contrôle la présence du numéro de carte de l'acheteur dans la liste grise de cartes. |
| SUSPECT_COUNTRY | Contrôle la présence du pays émetteur de la carte de l'acheteur dans la liste de pays interdits. |
| IP_FRAUD | Contrôle la présence de l'adresse IP de l'acheteur dans la liste grise d'IP. |
| CREDIT_LIMIT | Contrôle la fréquence et les montants d'achat d'un même numéro de carte, ou le montant maximum d'une commande. |
| BIN_FRAUD | Contrôle la présence du code BIN de la carte de l'acheteur dans la liste grise de codes BIN. |
| ECB | Contrôle si la carte de l'acheteur est de type e-carte bleue. |
| COMMERCIAL_CARD | Contrôle si la carte de l'acheteur est une carte commerciale. |
| SYSTEMATIC_AUTO | Contrôle si la carte de l'acheteur est une carte à autorisation systématique. |
| INCONSISTENT_COUNTRIES | Contrôle si le pays de l'adresse IP, le pays émétteur de la carte de paiement, et le pays de l'adresse de l'acheteur sont cohérents entre eux. |
| NON_WARRANTY_PAYMENT | Contrôle le transfert de responsabilité de la transaction. |
| SUSPECT_IP_COUNTRY | Contrôle la présence du pays de l'acheteur, identifié par son adresse IP, dans la liste de pays interdits. |
Format
result
Chemin: transactions.transactionDetails.fraudManagement.riskControl.result
Nom du contrôle mis en place dans le cadre de la gestion de risques.
Valeurs possibles
Résultat du contrôle de risque.
| VALEUR | DESCRIPTION |
|---|---|
| OK | OK |
| WARNING | Contrôle informatif échoué |
| ERROR | Contrôle bloquant échoué |
Format
score
Chemin: transactions.transactionDetails.fraudManagement.riskAnalysis.score
Identifiant de l’analyse chez l’analyseur de risque.
Format
resultCode
Chemin: transactions.transactionDetails.fraudManagement.riskAnalysis.resultCode
Code renvoyé par un analyseur de risque externe.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| STATUS | DESCRIPTION |
|---|---|
| INVALID_CREDENCIAL | Problème de paramétrage du contrat d’analyse de risques. |
| COMUNICATION_PROBLEM | Impossible de communiquer avec l’analyseur de risques. |
| DATA_PROCESSING_PROBLEM | Problème lors du traitement de l’envoi ou de la réponse d’analyse de risques. |
| MISSING_MANDATORY_ORDER_INFO | Des données relatives à la commande sont manquantes. |
| MISSING_MANDATORY_SHIPPING_INFO | Des données relatives à la livraison sont manquantes. |
| MISSING_MANDATORY_SHIPPING_ADDRESS_INFO | Des données relatives à l’adresse de livraison sont manquantes. |
| MISSING_MANDATORY_BILLING_INFO | Des données relatives à la facturation sont manquantes. |
| MISSING_MANDATORY_BILLING_ADDRESS_INFO | Des données relatives à l’adresse de facturation sont manquantes |
| MISSING_MANDATORY_CARD_INFO | Des données concernant le moyen de paiement sont manquantes. |
| MISSING_MANDATORY_CUSTOMER_INFO | Des données concernant l’acheteur sont manquantes. |
| APA | Spécifique ClearSale. La transaction est automatiquement approuvée selon les paramètres définis. |
| APM | Spécifique ClearSale. La transaction est manuellement approuvée par un analyste. |
| RPM | Spécifique ClearSale. La commande est refusée en raison du manque d'informations sur l'acheteur en accord avec la politique appliquée. |
| AMA | Spécifique ClearSale. En attente d'analyse manuelle. La commande est dans une file d'attente pour analyse. |
| ERR | Spécifique ClearSale. Erreur. |
| NVO | Spécifique ClearSale.Nouvelle commande. En attente de traitement et de classification. |
| SUS | Spécifique ClearSale. Commande suspendue manuellement. La commande est suspendue pour suspicion de fraude. |
| CAN | Spécifique ClearSale. Commande annulée. La commande est annulée par l'acheteur. |
| FRD | Spécifique ClearSale. Fraude confirmée avec l'opérateur de la carte de crédit ou du titulaire de la carte. |
| RPA | Spécifique ClearSale. Commande refusée automatiquement. La commande est refusée en application des paramètres de l'analyseur de fraude externe. |
| RPP | Spécifique ClearSale. Commande refusée automatiquement. La commande est refusée en application de la politique client ou ClearSale. |
| 100 | Spécifique CyberSource. La transaction s'est effectuée avec succès. |
| 101 | Spécifique CyberSource. La transaction est refusée. Un ou plusieurs champs sont manquants. |
| 102 | Spécifique CyberSource. La transaction est refusée. Un ou plusieurs champs contient des données invalides. |
| 150 | Spécifique CyberSource. Erreur. |
| 151 | Spécifique CyberSource. Erreur. La requête a été reçue mais le délai a été dépassé. Cette erreur n'inclue pas les dépassements de délais entre le client et le serveur. |
| 152 | Spécifique CyberSource. Erreur. La requête a été reçue mais un service n'a pas terminé à temps. |
| 202 | Spécifique CyberSource. Refusée. Carte expirée. |
| 231 | Spécifique CyberSource. Refusée. Numéro de compte invalide. |
| 234 | Spécifique CyberSource. Refusé. Un problème est survenu avec la configuration CyberSource du marchand. |
| 400 | Spécifique CyberSource. Refusée. Le score de la fraude dépasse le seuil de tolérance. |
| 480 | Spécifique CyberSource. La commande est marquée afin d'être examinée par le Decision Manager. |
| 481 | Spécifique CyberSource. La commande a été rejetée par le Decision Manager. |
| APPROVE | Spécifique Konduto. Konduto recommande d'accepter la transaction. Si aucune règle ne contredit cette recommandation, le statut de la transaction sera AUTHORISED. |
| DECLINE | Spécifique Konduto. Konduto recommande de refuser la transaction. Le statut de la transaction sera REFUSED. |
| REVIEW | Spécifique Konduto. Konduto recommande de vérifier la transaction. En fonction du résultat de l'authentification 3D-Secure, le statut de la transaction sera : |
| AUTHORISED_TO_VALIDATE | si le porteur s'est authentifié avec succès. |
| REFUSED | en cas d'échec d'authentification du porteur. |
Format
status
Chemin: transactions.transactionDetails.fraudManagement.riskAnalysis.status
Code renvoyé par un analyseur de risque externe.
Statut de l'analyse de risque.
Valeurs possibles
Les valeurs possibles sont les suivantes:
| VALEUR | DESCRIPTION |
|---|---|
| P_SEND_OK | Succès."Sent to clearsale and successfully processed". |
| P_TO_SEND | L'envoi est programmé."Transaction analysis is scheduled to be sent to risk analyzer". |
| P_TO_SEND_KO | Erreur de traitement."Problem when tried to send to risk analyzer". |
| P_PENDING_AT_ANALYZER | En cours de traitement par l'analyseur."Analysis result is still being processed by the risk analyzer. We should keep checking/waiting for the analysis result". |
| P_MANUAL | Attente d'envoi manuel."Analysis should be requested through user request (not automatically)" |
| P_SKIPPED | Ecarté."Analysis request discarded by current transaction status/problem". |
| P_SEND_EXPIRED | Expiré.* "Analysis request expired". |
Format
requestId
Chemin: transactions.transactionDetails.fraudManagement.riskAnalysis.requestId
Identifiant de l’analyse chez l’analyseur de risque.
Format
extraInfo
Chemin: transactions.transactionDetails.fraudManagement.riskAnalysis.extraInfo
Spécifique à CyberSource. Codes renvoyés par le DecisionManager.
Format
fingerPrintId
Chemin: transactions.transactionDetails.fraudManagement.riskAnalysis.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
results
Chemin: transactions.transactionDetails.fraudManagement.riskAssessments.results
Liste des actions réalisées sur la transaction, suite au déclenchement des règles de gestion de riques avancée activées sur la boutique.
Les valeurs possibles dépendent des options de la boutiques.
Valeurs possibles
Les valeurs possibles sont les suivantes :
| VALEUR | DESCRIPTION |
|---|---|
| ENABLE_3DS |
|
| DISABLE_3DS |
|
| NO_PREFERENCE |
|
| NO_CHALLENGE_REQUESTED |
|
| CHALLENGE_REQUESTED |
|
| CHALLENGE_MANDATE |
|
| MANUAL_VALIDATION | La transaction est créée en validation manuelle. La remise du paiement est bloquée temporairement pour permettre au marchand de procéder à toutes les vérifications souhaitées. |
| REFUSE | La transaction est refusée. |
| RUN_RISK_ANALYSIS | Appel à un analyseur de risques externe sous condition que le marchand possède un contrat. Se référer à la description de l'objet TransactionDetails.FraudManagement.RiskAnalysis pour identifier la liste des valeurs possibles et leur description. |
| INFORM | Une alerte est remontée. Le marchand est averti qu’un risque est identifié. Le marchand est informé via une ou plusieurs des règles du centre de notification (URL de notification, e-mail ou SMS ). |
Format
taxRate
Chemin: transactions.transactionDetails.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
taxAmount
Chemin: transactions.transactionDetails.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
preTaxAmount
Chemin: transactions.transactionDetails.preTaxAmount
Permet de définir le montant hors taxe de l’ensemble de la commande.
La valeur doit être exprimée dans la plus petite unité monétaire de la devise.
Format
externalTransactionId
Chemin: transactions.transactionDetails.externalTransactionId
Référence externe de la transaction.
Format
dccAmount
Chemin: transactions.transactionDetails.dcc.dccAmount
Montant de la transaction exprimé dans la plus petite unité de la devise définie par dccCurrency (le centime pour l'euro).
Ce champ n'est valorisé que si la carte est éligible au service de conversion dynamique de devise (DCC) et que l'acheteur a choisit de régler dans la devise de sa carte.
Le taux de conversion est retourné dans le champ dccChangeRate.
Format
dccCurrency
Chemin: transactions.transactionDetails.dcc.dccCurrency
Code numérique selon la norme ISO 4217 de la devise choisie par l'acheteur lorsque que la carte est éligible au service de conversion dynamique de devise (DCC).
Ce champ n'est valorisé que si la carte est éligible au service de conversion dynamique de devise (DCC) et que l'acheteur a choisit de régler dans la devise de sa carte.
Le taux de conversion est retourné dans le champ dccChangeRate.
Format
dccChangeRate
Chemin: transactions.transactionDetails.dcc.dccChangeRate
Taux de change utilisé pour calculer le montant réél du paiement.
Format
dccMarkup
Chemin: transactions.transactionDetails.dcc.dccMarkup
Indique le pourcentage (ou taux) de marge commerciale sur le montant total.
Ce champ n'est valorisé que si la carte est éligible au service de conversion dynamique de devise (DCC) et que l'acheteur a choisit de régler dans la devise de sa carte.
Exemple : "3.5" pour un taux de marge de 3.5%.
Format
dccRateDate
Chemin: transactions.transactionDetails.dcc.dccRateDate
Date et heure UTC de l'obtention du taux de conversion auprès du service de conversion dynamique de devise (DCC).
Ce champ n'est valorisé que si la carte est éligible au service de conversion dynamique de devise (DCC) et que l'acheteur a choisit de régler dans la devise de sa carte.
Le taux de conversion est retourné dans le champ dccChangeRate.
Format
paymentReference
Chemin: transactions.transactionDetails.acquirerDetails.paymentReference
Référence du paiement apparaissant sur le coupon de paiement.
Utilisé notamment pour le moyen de paiement Multibanco.
Format
serviceSupplier
Chemin: transactions.transactionDetails.acquirerDetails.serviceSupplier
Identifiant de l'entité pour laquelle le paiement est réalisé.
Utilisé notamment pour le moyen de paiement Multibanco.
Format
nsu
Chemin: transactions.transactionDetails.nsu
Numéro de séquence unique (Amérique Latine).
Format
tid
Chemin: transactions.transactionDetails.tid
Terminal ID. Identifiant du point de vente défini sur le contrat d'acceptation.
Ce champ est utilisé uniquement en Colombie afin de choisir entre REDEBAN et CREDIBANCO.
Format
acquirerNetwork
Chemin: transactions.transactionDetails.acquirerNetwork
Code du réseau acquéreur.
Valeurs possibles :
| Code Réseau | Libellé |
|---|---|
| ACCORD | Carte enseigne Accord |
| ACCORD_SANDBOX | Carte enseigne Accord - Mode sandbox |
| ALIPAY_PLUS | Alipay + |
| ALMA | Alma |
| AMEXGLOBAL | American Express International |
| APPLE PAY | Apple Pay |
| AURORE | Cetelem - Cartes de crédit Aurore et Cpay |
| CB | Carte Bancaire |
| COFIDIS | Cofidis |
| CONECS | Conecs |
| EDENRED | Edenred Belgique |
| FLOA | FLOA |
| FRANFINANCE | Franfinance |
| FRANFINANCE_SB | Franfinance - Mode sandbox |
| FULLCB | Cetelem - 3 ou 4 fois Carte Bancaire |
| GATECONEX | Elavon Europe |
| GICC_DINERS | Diners via Concardis, SIX ou VR Pay |
| GICC_MAESTRO | Maestro via Concardis, SIX ou VR Pay |
| GICC_MASTERCARD | Mastercard via Concardis, SIX ou VR Pay |
| GICC_VISA | Visa via Concardis, SIX ou VR Pay |
| GOOGLEPAY | Google Pay |
| JCB | JCB France et Polynésie Française |
| PPRO | PPRO |
| MULTIBANCO | MB Referência |
| MULTIBANCO | MB Way |
| PAYCONIQ | |
| PAYDIREKT_V2 | PayDirekt |
| PAYPAL | PayPal |
| PAYPAL_SB | PayPal - Mode sandbox |
| PLANET_DCC | Planet Payment |
| POSTFINANCEV2 | PostFinance |
| SAMSUNG_PAY | Samsung Pay |
| SEPA | SEPA DIRECT DEBIT |
| BHIM-UPI | BHIM-UPI |
| WECHAT_PAY | WeChat Pay |
Format
taxRefundAmount
Chemin: transactions.transactionDetails.taxRefundAmount
Utilisé en Uruguay, ce champ correspond au montant du crédit d'impôt accordé au marchand pour la transaction. La valeur est exprimée dans la plus petite unité monétaire (le centime pour l'euro).
Exemple: 30050 pour 300,50 EUR.
Format
occurrenceType
Chemin: transactions.transactionDetails.occurrenceType
Permet d'identifier si la transaction fait partie d'une série de paiements (abonnement ou paiement en N fois).
Utile pour identifier de manière précise le premier paiement d'une série.
Avec l'application du Soft Decline, la plateforme de paiement réalise automatiquement une nouvelle tentative de paiement avec authentification 3D Secure quand cela est possible. Cela modifie le numéro de séquence du paiement. Le champ sequenceNumber ne permet plus d'identifier facilement le premier paiement d'une série.
Valeurs possibles
| Valeur | Description |
|---|---|
| RECURRENT_INITIAL | Premier paiement d'une série. |
| RECURRENT_INTERMEDIAIRE | Énième paiement d'une série. |
| RECURRENT_FINAL | Dernier paiement d'une série. |
| UNITAIRE | Paiement unitaire (paiement comptant). |
Format
archivalReferenceId
Chemin: transactions.transactionDetails.archivalReferenceId
Référence générée par la plateforme de paiement et transmise à l'acquéreur pour le traitement des remises et le rapprochement des transactions.
Valorisé uniquement pour les paiements CB, AMEX et PAYPAL.
Format
serverDate
Date de génération de la réponse. Permet de mesurer le décalage éventuel entre les serveurs du marchand et du service de paiement.