Payment response
Payment is an object that describes the payment result. It is returned by the Charge/CreatePayment REST Web Service and by the IPN.
The Payment object can contain several transactions.
Structure of the Payment object
The structure of the Payment object is as follows:
Usually the transactions list only contains one transaction. But in case of split payment (the order was paid using several payment methods), several transactions can be created. This is why you should always use the orderStatus and orderCycle fields for checking the order status.
Response reference
orderStatus
Consolidated status of the transactions contained in the order.
Description
An order can contain several transactions. OrderStatus contains the statuses of all the transactions linked to the order.
For more information, go to: Transaction lifecycle.
Possible values
. The possible values are:
| STATUS | Description |
|---|---|
| PAID | The order is paid. |
| UNPAID | The order is not paid. |
| RUNNING | The order is in progress. |
| PARTIALLY_PAID | The order is partially paid. |
| ABANDONED | The order has been abandoned |
Format
orderCycle
Defined if the order is open ( OPEN , payment is authorized), or closed ( CLOSED , it can no longer be modified).
orderCycle takes the CLOSED value if it can no longer be modified:
- When the order is paid in full.
- When all authorized payment attempts have been exhausted.
Otherwise, orderCycle takes the OPEN value.
Possible values
. The possible values are:
| STATUS | Description |
|---|---|
| OPEN | The order is in progress. You must keep the cart as other payment attempts may occur. |
| CLOSED | The order is either fully paid, or the last attempt was rejected (in which case you need to generate a new formToken ). |
Format
OPEN use cases
By default, a Buyer has 4 attempts to pay for their order. Until all these attempts have been made, orderCycle is set to OPEN.
An order can also be paid from multiple transactions, or with multiple payment methods. Until the entire order is paid, orderCycle is set to OPEN.
If the associated transaction requires manual validation, orderCycle is set to OPEN.
CLOSED use cases
If the entire order is paid, orderCycle will be set to CLOSED.
When the order expires, orderCycle is set to CLOSED.
If all authorized payment attempts have failed (4 by default), orderCycle is set to CLOSED.
If the transaction is initially created with manual validation, orderCycle will be set to CLOSED when the transaction is either validated or canceled.
shopId
Shop ID.
Format
orderEffectiveAmount
Path: orderDetails.orderEffectiveAmount
Initial transaction amount in case of currency conversion.
Format
orderDetails.mode
Allows to define the mode in which the order was created.
Possible values
. The possible values are:
| STATUS | Description |
|---|---|
| TEST | For a test order. |
| PRODUCTION | For the actual order. |
Format
orderCurrency
Path: orderDetails.orderCurrency
Order currency code, in the 4217 alpha-3 format.
Eg: "EUR" for the euro.
Format
orderDetails.orderId
Order reference defined by the Merchant.Does not support UTF-8 characters.
Format
orderTotalAmount
Path: orderDetails.orderTotalAmount
Total amount of the order expressed in the smallest monetary unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
customer.reference
Buyer ID on the merchant side.
Format
customer.email
Buyer's e-mail address.
- Email structure specifications: RFC-2822
Format
address
Path: customer.billingDetails.address
Billing address.
Warning: the characters > and < are not authorized.
Format
address2
Path: customer.billingDetails.address2
Second line of the billing address.
Warning: the characters > and < are not authorized.
Format
category
Path: customer.billingDetails.category
Buyer type.
Format
Possible values
| Values | Description |
|---|---|
| PRIVATE | Individual buyer type. |
| COMPANY | Company buyer type. |
cellPhoneNumber
Path: customer.billingDetails.cellPhoneNumber
Buyer's cell phone number.
Accepts all formats:
Examples:
- 0623456789
- +33623456789
- 0033623456789
- (+34) 824 65 43 21
- 87 77 12 34
Format
city
Path: customer.billingDetails.city
City of the billing address.
Format
country
Path: customer.billingDetails.country
Buyer's country (in uppercase, in accordance with the ISO 3166-1 alpha-2 country codes).
Format
Possible values
Examples of possible values:
| Country | Code |
|---|---|
| AUSTRIA | AT |
| BRAZIL | BR |
| CORSICA | FR |
| IVORY COAST | CI |
| FRANCE | FR |
| GUADELOUPE | GP |
| INDIA | IN |
| MARTINIQUE | MQ |
| NEW CALEDONIA | NC |
| ST-PIERRE-ET-MIQUELON | PM |
| FRENCH POLYNESIA | PF |
district
Path: customer.billingDetails.district
District of the billing address.
Format
firstName
Path: customer.billingDetails.firstName
Buyer's first name.
Format
identityCode
Path: customer.billingDetails.identityCode
National identifier. Allows to identify each citizen within a country.
Format
identityType
Path: customer.billingDetails.identityType
ID type.
Format
language
Path: customer.billingDetails.language
Buyer's language code, according to ISO 639-1.
Specify the language in which payment confirmation e-mails are sent.
Format
Possible values
Examples of possible values:
| Language | Code |
|---|---|
| German (Germany) | DE |
| English (United Kingdom) | EN |
| English (United States) | EN |
| Chinese (Traditional) | ZH |
| Spanish (Spain) | ES |
| Spanish (Chile) | ES |
| French (France) | FR |
| Italian (Italy) | IT |
| Japanese (Japan) | JP |
| Dutch (the Netherlands) | NL |
| Polish (Poland) | PL |
| Portuguese (Brazil) | PT |
| Portuguese (Portugal) | PT |
| Russian (Russia) | RU |
lastName
Path: customer.billingDetails.lastName
Buyer's last name.
Format
legalName
Path: customer.billingDetails.legalName
Legal name.
Format
phoneNumber
Path: customer.billingDetails.phoneNumber
Buyer's phone number.
Accepts all formats:
Examples:
- 0123456789
- +33123456789
- 0033123456789
- (00.571) 638.14.00
- 40 41 42 42
Format
state
Path: customer.billingDetails.state
Region (state) of the billing address. It is recommended, but not mandatory, to pass the value in ISO-3166-2.
Format
streetNumber
Path: customer.billingDetails.streetNumber
Street number of the billing address.
Accepted characters:
- Alphabetical characters (from "A" to "Z" and from "a" to "z")
- Space
Format
title
Path: customer.billingDetails.title
Buyer's title.
Examples:
- Mr
- Ms.
- Mrs
Format
zipCode
Path: customer.billingDetails.zipCode
Zip code of the billing address.
Format
address
Path: customer.shippingDetails.address
Shipping address.
Warning: the characters > and < are not authorized.
Format
address2
Path: customer.shippingDetails.address2
Second line of the shipping address.
Warning: the characters > and < are not authorized.
Format
category
Path: customer.shippingDetails.category
Buyer type.
Format
Possible values
| Values | Description |
|---|---|
| PRIVATE | Individual buyer type. |
| COMPANY | Company buyer type. |
city
Path: customer.shippingDetails.city
Shipping city.
Format
country
Path: customer.shippingDetails.country
Shipping country (in uppercase, in accordance with the ISO 3166-1 alpha-2 country codes).
Format
Possible values
Examples of possible values:
| Country | Code |
|---|---|
| AUSTRIA | AT |
| BRAZIL | BR |
| CORSICA | FR |
| IVORY COAST | CI |
| FRANCE | FR |
| GUADELOUPE | GP |
| INDIA | IN |
| MARTINIQUE | MQ |
| NEW CALEDONIA | NC |
| ST-PIERRE-ET-MIQUELON | PM |
| FRENCH POLYNESIA | PF |
deliveryCompanyName
Path: customer.shippingDetails.deliveryCompanyName
Name of the delivery company.
Format
district
Path: customer.shippingDetails.district
District of the billing address.
Format
firstName
Path: customer.shippingDetails.firstName
First name of the recipient.
Format
identityCode
Path: customer.shippingDetails.identityCode
National identifier. Allows to identify each citizen within a country.
Format
lastName
Path: customer.shippingDetails.lastName
Buyer's last name.
Format
legalName
Path: customer.shippingDetails.legalName
Legal name in case of shipping to a company.
Format
phoneNumber
Path: customer.shippingDetails.phoneNumber
Buyer's phone number.
Accepts all formats:
Examples:
- 0123456789
- +33123456789
- 0033123456789
- (00.571) 638.14.00
- 40 41 42 42
Format
shippingMethod
Path: customer.shippingDetails.shippingMethod
Shipping mode.
Format
Possible values
| value | Description |
|---|---|
| RECLAIM_IN_SHOP | Item pickup at the shop. |
| RELAY_POINT | Use of a third-party pickup network (Kiala, Alveol, etc.). |
| RECLAIM_IN_STATION | Pickup at an airport, a train station or a travel agency. |
| PACKAGE_DELIVERY_COMPANY | Shipping by the transporter (Colissimo, UPS, etc.). |
| ETICKET | Issue of an electronic ticket, online download of the product. |
| CARD_HOLDER_ADDRESS | Delivery to the buyer. Reserved for future use. |
| VERIFIED_ADDRESS | Delivery to a verified address.Reserved for future use. |
| NOT_VERIFIED_ADDRESS | Delivery to a non-verified address.Reserved for future use. |
| SHIP_TO_STORE | In-store pickup.Reserved for future use. |
| DIGITAL_GOOD | Digital delivery.Reserved for future use. |
| ETRAVEL_OR_ETICKET | E-ticket.Reserved for future use. |
| OTHER | Other: Reserved for future use. |
| PICKUP_POINT | Pickup point delivery.Reserved for future use. |
| AUTOMATED_PICKUP_POINT | Pickup at an automatic pickup point.Reserved for future use. |
shippingSpeed
Path: customer.shippingDetails.shippingSpeed
Shipping delay.
Format
Possible values
Examples of possible values:
| value | Description |
|---|---|
| STANDARD | Standard shipping. |
| EXPRESS | Express shipping (in less than 24h). |
| PRIORITY | Priority shipping (Click & Collect). |
state
Path: customer.shippingDetails.state
Region of the billing address.
Format
streetNumber
Path: customer.shippingDetails.streetNumber
Street number of the delivery address.
Accepted characters:
- Alphabetical characters (from "A" to "Z" and from "a" to "z")
- Space
Format
zipCode
Path: customer.shippingDetails.zipCode
Zip code of the billing address.
Format
ipAddress
Path: customer.extraDetails.ipAddress
Buyer's IP address.
Format
fingerPrintId
Path: customer.extraDetails.fingerPrintId
Format
browserUserAgent
Path: customer.extraDetails.browserUserAgent
1. "User-Agent" header of buyer's browser (HTTP/1.1 - RFC. 2616).
Format
browserAccept
Path: customer.extraDetails.browserAccept
1. "Accept" header of buyer's browser (HTTP/1.1 - RFC. 2616).
Format
insuranceAmount
Path: customer.shoppingCart.insuranceAmount
Insurance amount for the entire order, expressed in the smallest monetary unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
shippingAmount
Path: customer.shoppingCart.shippingAmount
Amount of delivery fees for the entire order, expressed in its smallest monetary unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
taxAmount
Path: customer.shoppingCart.taxAmount
Amount of taxes for the entire order expressed in the smallest monetary unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
cartItemInfo
Path: customer.shoppingCart.cartItemInfo
cardItemInfo is a list that contains Customer/ShoppingCartItemInfo objects.
It allows you to describe each item in the cart.
Format
productAmount
Path: customer.shoppingCart.cartItemInfo.productAmount
Amount of the product expressed in the smallest currency unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
productLabel
Path: customer.shoppingCart.cartItemInfo.productLabel
Product name.
Format
productQty
Path: customer.shoppingCart.cartItemInfo.productQty
Product quantity.
Format
productRef
Path: customer.shoppingCart.cartItemInfo.productRef
Product reference.
Format
productType
Path: customer.shoppingCart.cartItemInfo.productType
Product type.
Possible values
| value | Description |
|---|---|
| FOOD_AND_GROCERY | Food and grocery |
| AUTOMOTIVE | Cars / Moto |
| ENTERTAINMENT | Entertainment / Culture |
| HOME_AND_GARDEN | Home and gardening |
| HOME_APPLIANCE | Household appliances |
| AUCTION_AND_GROUP_BUYING | Auctions and group purchasing |
| FLOWERS_AND_GIFTS | Flowers and presents |
| COMPUTER_AND_SOFTWARE | Computers and software |
| HEALTH_AND_BEAUTY | Health and beauty |
| SERVICE_FOR_INDIVIDUAL | Services for individuals |
| SERVICE_FOR_BUSINESS | Services for companies |
| SPORTS | Sports |
| CLOTHING_AND_ACCESSORIES | Clothes and accessories |
| TRAVEL | Travel |
| HOME_AUDIO_PHOTO_VIDEO | Sound, image and video |
| TELEPHONY | Telephony |
Format
productVat
Path: customer.shoppingCart.cartItemInfo.productVat
Product type.
Tax fee amount (expressed in the smallest currency unit).
Possible values
| value | Description |
|---|---|
| integer | Transaction amount. Its value must be a positive integer (e.g.: 1234 for 12.34 EUR). |
| Decimal number, lower than 100 | Percentage applied to the amount. Examples: 20.0 or 19.6532 |
To display a percentage applied to the payment amount for the product in question, the value should have maximum 4 digits after the decimal point. The decimal separator is mandatory for displaying a percentage. The decimal separator is represented by the "." symbol.
Format
companyType
Path: subMerchantDetails.companyType
Company type of the sub-merchant.Transmitted by the payment facilitator.
Different rules may apply depending on the acquirer. This field is often used for specifying the type of Legal Number of the buyer.
Format
legalNumber
Path: subMerchantDetails.legalNumber
Legal number of sub-merchant according to field companyType . Transmitted by the payment facilitator.
Format
name
Path: subMerchantDetails.name
Business name of the sub-merchant.Transmitted by the payment facilitator.
Format
url
Path: subMerchantDetails.url
URL of the sub-merchant.Transmitted by the payment facilitator.
Format
phoneNumber
Path: subMerchantDetails.phoneNumber
Telephone number of the sub-merchant.Transmitted by the payment facilitator.
Format
address1
Path: subMerchantDetails.address1
Address of the sub-merchant.Transmitted by the payment facilitator.
Format
address2
Path: subMerchantDetails.address2
Addition of the sub-merchant's address. Transmitted by the payment facilitator.
Format
zip
Path: subMerchantDetails.zip
Zip code of the sub-merchant.Transmitted by the payment facilitator.
Format
city
Path: subMerchantDetails.city
City of the sub-merchant.Transmitted by the payment facilitator.
Format
country
Path: subMerchantDetails.country
Country code of the sub-merchant address (ISO 3166 alpha-2 standard). Transmitted by the payment facilitator.
Format
mcc
Path: subMerchantDetails.mcc
MCC code of the sub-merchant.Transmitted by the payment facilitator.
Format
mid
Path: subMerchantDetails.mid
Contract number (MID) of the sub-merchant.Transmitted by the payment facilitator.
Format
softDescriptor
Path: subMerchantDetails.softDescriptor
Label (Soft-descriptor) of the sub-merchant that appears on the buyer's bank statement. Transmitted by the payment facilitator.
Format
state
Path: subMerchantDetails.state
Region of the sub-merchant's address. Transmitted by the payment facilitator.
Format
facilitatorId
Path: subMerchantDetails.facilitatorId
Payment Facilitator ID. Transmitted by the payment facilitator.
Format
transactions.amount
Payment amount in its smallest currency unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
creationDate
Path: transactions.creationDate
Date and time when the transaction was registered.
Format
currency
Path: transactions.currency
Payment currency. Alphabetic code in uppercase according to alpha-3 (ISO 4217).
Eg: "EUR" for the euro.
Format
Possible values
. The possible values are:
| Currency | ISO 4217 ENCODING | Fractional unit |
|---|---|---|
| Australian dollar (036) | AUD | 2 |
| Brazilian real (986) | BRL | 2 |
| Canadian dollar (124) | CAD | 2 |
| Swiss franc (756) | CHF | 2 |
| Czech koruna (203) | CZK | 2 |
| Danish crown (208) | DKK | 2 |
| Euro (978) | EUR | 2 |
| Pound Sterling (826) | GBP | 2 |
| Hong Kong dollar (344) | HKD | 2 |
| Indian rupee (356) | INR | 2 |
| Indonesian rupiah (360) | IDR | 2 |
| Japanese yen (392) | JPY | 0 |
| South Korean won (410) | KRW | 0 |
| Kuwaiti dinar (414) | KWD | 3 |
| Mexican peso (484) | MXN | 2 |
| Malaysian ringgit (458) | MYR | 2 |
| Norwegian crown (578) | NOK | 2 |
| Polish zloty (985) | PLN | 2 |
| Leu Roumain (946) | RON | 2 |
| Russian ruble (643) | RUB | 2 |
| Singapore dollar (702) | SGD | 2 |
| Swedish krona (752) | SEK | 2 |
| Thai baht (764) | THB | 2 |
| Turkish lira (949) | TRY | 2 |
| New Taiwan dollar (901) | TWD | 2 |
| US dollar (840) | USD | 2 |
| CFA Franc (952) | XOF | 0 |
detailedErrorCode
Path: transactions.detailedErrorCode
Detailed unfiltered and unmodified error code returned by the Acquirer.
See the List of authorization return codes for more information.
Format
detailedErrorMessage
Path: transactions.detailedErrorMessage
Detailed unfiltered error message returned by the acquirer or the payment application.
Contains contextual information to help understand the error.
This field may be set to null when errorCode equals ACQ_001.
See the detailedErrorCode field description to see the reason of the authorization refusal.
Format
detailedStatus
Path: transactions.detailedStatus
The detailedStatus parameter provides detailed information on the payment status. Each of the statuses is specific to the used payment method.
Possible values
. The possible values are:
| detailedStatus | Description |
|---|---|
| ACCEPTED | Status of a transaction of type VERIFICATION whose authorization or request for information has been accepted. This status cannot change. Transactions with the status "ACCEPTED" are never put back in the bank. A transaction of type VERIFICATION is created when an alias is updated or created without payment. |
| AUTHORISED | The amount is authorized and will be captured automatically. |
| AUTHORISED_TO_VALIDATE | The transaction, created in manual validation, is authorized. The merchant must manually validate the transaction in order for it to be submitted to the bank. The transaction can be validated as long as the expiration date of the authorization request has not passed. If the expiration date has passed then the payment will be set to EXPIRED. Expired status is final. |
| CANCELLED | The transaction has been canceled. |
| CAPTURED | The transaction amount has been captured. |
| CAPTURE_FAILED | Capture failed. Please contact Support. |
| EXPIRED | The expiration date of the authorization request has been reached and the merchant has not validated the transaction. The cardholder will not be charged. |
| INITIAL | This status is temporary. It is returned when no response is received from the acquirer, or when the delay of the response from the acquirer has exceeded the payment session on the payment gateway. |
| PRE_AUTHORISED | Status of a transaction of type PRE_AUTHORISED whose authorization has been accepted. This status cannot change. Transactions with the status "PRE_AUTHORISED" are never put back in the bank. |
| REFUSED | The transaction has been rejected. |
| UNDER_VERIFICATION | Checks in progress by the purchaser. This status is not final. |
| WAITING_AUTHORISATION | The capture delay is longer than the authorization validity period. |
| WAITING_AUTHORISATION_TO_VALIDATE | The payment method has been verified but the transaction has not yet been authorized because the remittance time is longer than the validity of the authorization. The authorization request will be triggered automatically on D-1 before the remittance date and manual intervention will be required to confirm the authorization. There is no guarantee that the authorization request will be accepted. |
| WAITING_FOR_PAYMENT | Transaction awaiting payment. This status is not final. |
| ERROR | An unexpected error has occurred. |
For more information on the transaction lifecycle, go to: Transaction lifecycle.
Format
For more information on the transaction lifecycle, go to: Transaction lifecycle.
Format
effectiveStrongAuthentication
Path: transactions.effectiveStrongAuthentication
Indicates whether the cardholder successfully authenticated during the payment.
Possible values
. The possible values are:
| value | Description |
|---|---|
| ENABLED | The cardholder has successfully authenticated him or herself. |
| DISABLED | The payment is not subject to cardholder authentication or cardholder authentication has failed. |
Format
errorCode
Path: transactions.errorCode
Error code. See Error codes for more information.
Format
errorMessage
Path: transactions.errorMessage
Error message. See Error codes for more information.
Format
metadata
Path: transactions.metadata
Custom values linked to the transaction, in JSON format.
Example of a call
For example, to pass a custom value, add the following to your query:
{
"metadata": {
"MyValueKey": "1234"
}
}This value will be returned in the newly created transaction object.
You can also use the metadata “ orderInfo1 ”, “ orderInfo2 ” and “ orderInfo3 ” to send complementary information about the order.
This data can be found later in the Extra tab of the transaction details via your
Format
operationType
Path: transactions.operationType
Type of operation.
Possible values
. The possible values are:
| value | Description |
|---|---|
| DEBIT | Debit operation. |
| CREDIT | Refund operation. |
| VERIFICATION | Payment method verification operation. |
Format
transactions.uuid
Unique transaction ID generated by the payment gateway.
Format
paymentMethodToken
Path: transactions.paymentMethodToken
Token associated with a payment method.
Format
paymentMethodType
Path: transactions.paymentMethodType
Payment method type Example: PAYCONIQ
Format
shopId
Shop ID.
Format
transactions.status
Simplified transaction status. It is the same for all payment methods. It allows you to implement a generic code compatible with all payment methods.
Each payment method also has dedicated statuses. See the detailedStatus property for more information.
Possible values
. The possible values are:
| STATUS | Description |
|---|---|
| PAID | The transaction is paid. |
| UNPAID | The transaction is not paid. |
| RUNNING | The transaction is in progress. |
| PARTIALLY_PAID | The transaction is partially paid. |
For more information on the transaction lifecycle, go to: Transaction lifecycle.
Format
liabilityShift
Path: transactions.transactionDetails.liabilityShift
Specified if the payment is guaranteed.
Possible values
. The possible values are:
| Values | Description |
|---|---|
| YES | The payment is guaranteed. |
| NO | The payment is not guaranteed. |
| nulle | The payment is not guaranteed. |
Format
mid
Path: transactions.transactionDetails.mid
Merchant ID number. If this field is populated, make sure you use the appropriate MID depending on the card scheme.
Format
effectiveAmount
Path: transactions.transactionDetails.effectiveAmount
Initial transaction amount in case of currency conversion.
Format
sequenceNumber
Path: transactions.transactionDetails.sequenceNumber
Transaction sequence number.
Format
effectiveCurrency
Path: transactions.transactionDetails.effectiveCurrency
Initial transaction currency in case of currency conversion.
Format
creationContext
Path: transactions.transactionDetails.creationContext
Specified the process that initiated the transaction.
Possible values
. The possible values are:
| Values | Description |
|---|---|
| CHARGE | For a debit request. |
| REFUND | For a credit request. |
Format
parentTransactionUuid
Path: transactions.transactionDetails.parentTransactionUuid
UUID of the transaction source.
Format
paymentSource
Path: transactions.transactionDetails.cardDetails.paymentSource
Payment source.
Format
Possible values
. The possible values are:
| value | Description |
|---|---|
| EC | E-Commerce: the data of the means of payment are entered by the buyer. This value allows a strong authentication during the payment. |
| MOTO | MAIL OR TELEPHONE ORDER: entry by an operator.The payment information is sent by mail or e-mail. Requires a VAD contract. |
| CC | Call Center: payment made through a call center. Requires a VAD contract. |
| OTHER | Other sales channel.Returned output value for payments made via the |
| Absent ou null | The default value is "EC". |
manualValidation
Path: transactions.transactionDetails.cardDetails.manualValidation
Transaction validation mode.
Format
Possible values
. The possible values are:
| value | Description |
|---|---|
| NO | Automatic validation by the payment gateway. |
| YES | Manual validation by the Merchant. |
| null | Default configuration of the selected shop (configurable in the |
expectedCaptureDate
Path: transactions.transactionDetails.cardDetails.expectedCaptureDate
Date of capture in the bank expressed in ISO 8601 format defined by W3C.
Format
effectiveBrand
Path: transactions.transactionDetails.cardDetails.effectiveBrand
Card brand.
| Payment method | Card type (effectiveBrand) |
|---|---|
| Carte enseigne Accord | ACCORD_STORE |
| Carte enseigne Accord - Mode sandbox | ACCORD_STORE_SB |
| 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 |
| 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 |
| Titre-Restaurant Dématérialisé Conecs | CONECS |
| Chèque-Vacances Connect | CVCO |
| Diners | DINERS |
| e-carte bleue | E-CARTEBLEUE |
| 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 |
| iDeal Internet Banking | IDEAL |
| Carte Cadeau Illicado | ILLICADO |
| Carte Cadeau Illicado - Mode sandbox | ILLICADO_SB |
| Virement SEPA | IP_WIRE |
| JCB | JCB |
| Maestro | MAESTRO |
| Mastercard | MASTERCARD |
| Paiement 3x 4x Oney | ONEY_3X_4X |
| Cartes Enseignes partenaires d'Oney | ONEY_ENSEIGNE |
| PAYPAL | PayPal |
| PAYPAL_BNPL | PayPal Pay Later |
| PAYPAL_SB | PayPal - Mode sandbox |
| PAYPAL_BNPL_SB | PayPal Pay Later- Mode sandbox |
| Prélèvement Bancaire SEPA DIRECT DEBIT | SDD |
| Titre-Restaurant Dématérialisé Sodexo | SODEXO |
| Visa | VISA |
| Visa Electron | VISA_ELECTRON |
| Vpay | VPAY |
Format
pan
Path: transactions.transactionDetails.cardDetails.pan
Truncated card number.
Format
expiryMonth
Path: transactions.transactionDetails.cardDetails.expiryMonth
Expiration month in a two-digit format. Example: "09" for September.
Format
expiryYear
Path: transactions.transactionDetails.cardDetails.expiryYear
Expiration year in a two-digit format. Example: "25" for 2025.
Format
country
Path: transactions.transactionDetails.cardDetails.country
Country code of the card.
Format
issuerCode
Path: transactions.transactionDetails.cardDetails.issuerCode
Code associated with the issuing bank.
Format
issuerName
Path: transactions.transactionDetails.cardDetails.issuerName
Name of the bank associated with the issuing bank.
Format
effectiveProductCode
Path: transactions.transactionDetails.cardDetails.effectiveProductCode
Product code of the card used for the payment.
| VISA | Designation |
|---|---|
| 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 | Designation |
|---|---|
| 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 |
| Ms | 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 | Designation |
|---|---|
| 1 | National debit card |
| 2 | National cash withdrawal and payment card |
| 3 | National payment card |
| 4 | National payment and cash withdrawal card requiring systematic authorization |
| 5 | National payment card requiring systematic authorization |
| Other product codes | Designation |
|---|---|
| AX | AMERICAN EXPRESS |
| DI | DISCOVER |
| DN | DINERS |
| JC | JCB |
Format
paymentMethodSource
Path: transactions.transactionDetails.cardDetails.paymentMethodSource
Allows to define the mode of the used payment method.
Possible values
. The possible values are:
| STATUS | Description |
|---|---|
| NEW | Transaction created using a new payment method. |
| TOKEN | Transaction created using an existing payment method. |
Format
legacyTransId
Path: transactions.transactionDetails.cardDetails.legacyTransId
6 character long transaction identifier.
Format
cardHolderName
Path: transactions.transactionDetails.cardDetails.cardHolderName
Cardholder's first and last names.
Format
identityDocumentType
Path: transactions.transactionDetails.cardDetails.identityDocumentType
ID type.
Format
identityDocumentNumber
Path: transactions.transactionDetails.cardDetails.identityDocumentNumber
Buyer's ID number.
The format depends on the ID type: between 7 and 13 characters, digits, letters and/or dots.
In Latin America, this parameter may be mandatory for some buyers.
Format
legacyTransDate
Path: transactions.transactionDetails.cardDetails.legacyTransDate
Date and time of payment request reception. Used for identifying transactions IDs in old format.
Format
productCategory
Path: transactions.transactionDetails.cardDetails.productCategory
Card product category.
The value is taken from the BIN range files.
Possible values
| value | Description |
|---|---|
| CREDIT | Credit card |
| DEBIT | Debit card |
| PREPAID | Prepaid card |
Format
nature
Path: transactions.transactionDetails.cardDetails.nature
Card Nature.
Empty field if not provided by acquirer.
Possible values
| value | Description |
|---|---|
| CONSUMER_CARD | Personal card |
| COMMERCIAL_CARD | Commercial card |
Format
amount
Path: transactions.transactionDetails.cardDetails.authorizationResponse.amount
Authorization amount.
Format
currency
Path: transactions.transactionDetails.cardDetails.authorizationResponse.currency
Code of the currency used during the authorization request.
Format
authorizationDate
Path: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationDate
Date and time of the authorization request.
Format
authorizationNumber
Path: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationNumber
Number of the authorization request.
Format
authorizationResult
Path: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationResult
Return code of the authorization request.
See the List of authorization return codes for more information.
Format
authorizationMode
Path: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationMode
Specifies the mode of the authorization request.
Possible values
| Values | Description |
|---|---|
| MARK | A pre-authorization of a null or unitary amount has been made, see below. |
| FULL | An authorization of the total amount has been requested. |
When authorizationMode is MARK : An authorization of 1 EUR (or request for information on the CB network if the acquirer supports it)has been performed in order to check the card's validity. This case occurs when the remittance date exceeds the validity period of an authorization (7 days for VISA / MasterCard / CB / AMEX in France for example).
Format
amount
Path: transactions.transactionDetails.cardDetails.markAuthorizationResponse.amount
Pre-authorization amount.
Format
currency
Path: transactions.transactionDetails.cardDetails.markAuthorizationResponse.currency
Code of the currency used during the pre-authorization request.
Format
authorizationDate
Path: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationDate
Date and time of the pre-authorization request.
Format
authorizationNumber
Path: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationNumber
Number of the pre-authorization request.
Format
authorizationResult
Path: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationResult
Return code of the pre-authorization request.
Format
captureDate
Path: transactions.transactionDetails.cardDetails.captureResponse.captureDate
Capture date and time.
Format
captureFileNumber
Path: transactions.transactionDetails.cardDetails.captureResponse.captureFileNumber
Capture number.
Format
refundAmount
Path: transactions.transactionDetails.cardDetails.captureResponse.refundAmount
Refunded amount.
Format
refundCurrency
Path: transactions.transactionDetails.cardDetails.captureResponse.refundCurrency
Currency of the refunded amount.
Format
effectiveRefundAmount
Path: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundAmount
Format
effectiveRefundCurrency
Path: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundCurrency
Format
transactionCondition
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.transactionCondition
Authentication status of 3D Secure.
Possible values
Authentication status of the cardholder.
| value | Description |
|---|---|
| COND_3D_SUCCESS | Authentication success. The Merchant and the cardholder are registered in the 3D Secure program and the buyer has correctly authenticated. |
| COND_3D_FAILURE | Authentication failure. The Merchant and the cardholder are registered in the 3D Secure program but the Buyer did not manage to authenticate (wrong password). |
| COND_3D_ERROR | Authentication error. The Merchant participates in the 3D Secure program but the payment gateway server has encountered a technical issue during the authentication process (while checking whether the card is registered in the 3D program or whether the cardholder is authenticated). |
| COND_3D_NOTENROLLED | Cardholder not enrolled. The Merchant participates in the 3D Secure program but the cardholder's card is not enrolled. |
| COND_3D_ATTEMPT | Authentication attempt. The Merchant and the cardholder are registered in the 3D Secure program but the buyer did not need to authenticate (the access control server of the bank that issued the card only implements the generation of proof of authentication attempt). |
| COND_SSL | 3D Secure not applicable. The Merchant is not enrolled in 3D Secure or the sales channel is not covered by this guarantee. |
Format
enrolled
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.enrolled
Cardholder's enrollment status.
Possible values
. The possible values are:
| value | Description |
|---|---|
| YES | Cardholder enrolled, 3DS authentication possible. Note: in the Back Office, the ENROLLED value is displayed (3D Secure tab in Transaction details). |
| NO | Cardholder not enrolled. Note: in the Back Office, the NOT_ENROLLED value is displayed (3D Secure tab in Transaction details). |
| UNKNOWN | Unable to verify the cardholder's enrollment status. Note: in the Back Office, the UNAVAILABLE value is displayed (3D Secure tab in Transaction details). |
Format
status
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.status
Authentication status of the cardholder.
Possible values
Authentication status of the cardholder.
| value | Description |
|---|---|
| YES | Successful authentication. Note: in the Back Office, the SUCCESS value is displayed (3D Secure tab in Transaction details). |
| NO | Authentication error. Note: in the Back Office, the FAILED value is displayed (3D Secure tab in Transaction details). |
| UNKNOWN | Authentication impossible. Note: in the Back Office, the UNAVAILABLE value is displayed (3D Secure tab in Transaction details). |
| ATTEMPT | Authentication attempt Note: in the Back Office, the ATTEMPT value is displayed (3D Secure tab in Transaction details). |
Format
eci
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.eci
E-commerce index.
Possible values
The value depends on the 3DS authentication status and the card type. The possible values are:
| CARD TYPE | STATUS=Y | STATUS=A | STATUS=U | STATUS=N |
|---|---|---|---|---|
| VISA - AMEX | 5 | 6 | 7 | - |
| MasterCard | 02 | 01 | - | - |
Format
xid
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.xid
Unique transaction ID.
Format
cavvAlgorithm
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavvAlgorithm
Algorithm for checking the authentication status of the cardholder.
Possible values
. The possible values are:
| value | Description |
|---|---|
| HMAC | HMAC |
| CVV | Card Verification Value |
| CVV_ATN | CVV Authentication Tracking Number |
| SPA | MasterCard SPA Algorithm. |
| A | AV-CB |
Format
cavv
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavv
Cardholder Authentication Verification Value.
Format
signValid
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.signValid
Validity of the PARes message signature.
Possible values
Authentication status of the cardholder.
| value | Description |
|---|---|
| nulle | 3DS unavailable. |
| 0 | Incorrect signature. |
| 1 | Correct signature. |
Format
brand
Path: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.brand
Card brand.
Format
id
Path: transactions.transactionDetails.cardDetails.authenticationResponse.id
Unique identifier of the authentication, in UUID format.
Format
operationSessionId
Path: transactions.transactionDetails.cardDetails.authenticationResponse.operationSessionId
Unique identifier for the authentication session.
Format
instructionType
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.instructionType
Type of instruction to carry out.
Format
Possible values
| Values | Description |
|---|---|
| FORM | Form with redirect type instruction. |
name
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.name
Instruction name.
Possible values
| value | Description |
|---|---|
| CHALLENGE | Challenge Instruction that allows interactive user authentication via the ACS. |
| FINGERPRINT | Fingerprint Instruction that allows to identify the user via the ACS. |
Format
_type
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value._type
Type of received response. The interpretation of the rest of the response depends on this attribute.
Possible values
| value | Description |
|---|---|
| AuthenticationInstruction | Instruction type response. |
| AuthenticationResult | Final result type response. |
Format
timeout
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.timeout
Maximum response delay when executing an instruction, expressed in seconds. Beyond this delay, it is necessary to initiate the return to the payment gateway server in order to obtain the final result.
Format
method
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.method
Method (verb) used for the request.
Possible values
| value | Description |
|---|---|
| DELETE | Delete method |
| GET | Get method |
| PATCH | Patch method |
| POST | Post method |
| PUT | Put method |
Format
url
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.url
URL to which the HTTP form must be submitted.
Format
body
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.body
List of request body parameters, presented as “name”: “value”.
Format
headers
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.headers
List of HTTP request headers, presented as “name”: “value”.
Format
element
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.element
Type of the target HTML element which contains the instruction.
Possible values
| value | Description |
|---|---|
| IFRAME | iFrame |
Format
height
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.height
Height of the HTML target in pixels.
Format
visible
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.visible
Boolean indicating whether or not the HTML target must be visible.
Format
width
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.width
Width of the HTML target in pixels.
Format
showUrl
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.showUrl
Technical field for internal use that allows to show or hide the URL of the ACS.
Format
challengePreference
Path: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.challengePreference
Indicates whether or not the merchant has requested a challenge.
Possible values
| Values | Description |
|---|---|
| NO_PREFERENCE | No particular preference. |
| NO_CHALLENGE_REQUESTED | Challenge is not explicitly requested. |
| CHALLENGE_REQUESTED | Challenge is requested by the Merchant. |
Format
name
Path: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.name
Name of the protocol used by the cardholder authentication services.
Possible values
| value | Description |
|---|---|
| THREEDS | 3D Secure protocol |
Format
simulation
Path: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.simulation
Boolean that indicates if the authentication must be done in simulation mode. If you set this mandatory field to:
true, you activate the simulation mode.false, you do not enable the simulation mode.
This mode allows you to perform a merchant integration without being in production mode, and without using real cards.
Format
network
Path: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.network
Network where the payment method was authenticated.
Currently supported networks
| value |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| PROTECTBUY |
Format
version
Path: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.version
Version of the protocol used by the cardholder authentication services.
Currently supported versions
| value | Description |
|---|---|
| 1.0.2 | Version 1.0.2 |
| 2.1.0 | Version 2.1.0 |
| 2.2.0 | Version 2.2.0 |
Format
authenticationType
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationType
Type of authentication that has been applied.
Possible values
| value | Description |
|---|---|
| FRICTIONLESS | Authentication in Frictionless mode, i.e. transparent for the Buyer. |
| CHALLENGE | Authentication with a Challenge, the Buyer had to explicitly authenticate him/herself via the ACS. |
| DATA_ONLY | Authentication processed by the DS without client interaction |
Format
commerceIndicator
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.commerceIndicator
Commerce Indicator, or ECI (Electronic Commerce Indicator) for the 3DS protocol. Indicator returned by the ACS to report the results of cardholder’s authentication attempt.
In case of authentication without payment (e.g. in case of card registration) MasterCard can return the following 2 values:
| value | Description |
|---|---|
| N0 | Not authenticated |
| N2 | Authenticated |
Format
status
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.status
Authentication status, i.e. the positive/negative outcome of the authentication.
Possible values
| value | Description |
|---|---|
| ATTEMPT | Proof of authentication attempt when authentication is not available. |
| ENROLLED_UNAVAILABLE | Unable to assess the enrollment status. |
| FAILED | Authentication error |
| NOT_ENROLLED | Card not enrolled. |
| SUCCESS | Successful authentication. |
| UNAVAILABLE | The authentication could not be completed (technical error, etc.). |
| DISABLED | Authentication disabling requested. |
| REJECTED | Authentication rejected by the ACS. |
Format
authenticationIdType
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.authenticationIdType
Type of authentication that has been applied.
Possible values
| value | Description |
|---|---|
| dsTransId | The field originates from the dsTransId field of the v2 3DS protocol. |
Format
value
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.value
Value of the authentication transaction identifier known to the banking network.
The length of the field varies depending on the authentication protocol.
| PROTOCOL | Format / Length | value Example: |
|---|---|---|
| 3DS v2 (dsTransId) | chaine / 32 caractères alphanumériques + 4 tirets | 4317fdc3-ad24-5443-8000-000000000891 |
Format
authenticationValueType
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.authenticationValueType
Type of authentication value.
Possible values
| value | Description |
|---|---|
| AEVV | American Express Verification Value (used by Amex). |
| CAVV | Cardholder Authentication Verification Value (used by VISA). |
| AAV | Accountholder Authentication Value (used by Mastercard). |
Format
value
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.value
Final authentication value (depending on the DS this value can be called CAVV, AEVV or AAV). Character string encoded in base64 with a size of 28 characters.
Format
authenticationType
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.authenticationType
Type of result extension.
Format
Possible values
| Values | Description |
|---|---|
| THREEDS_V2 | Extension for 3DS Secure v2 authentications |
acsTransId
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.acsTransId
Identifiant de transaction de l'ACS. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration
Format
cbScore
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.cbScore
CB score as defined in the CB extension of the ARES message.
Format
algorithm
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.extension.algorithm
Code of the algorithm used for generating the Authentication Value (used during the authorization).
Possible values
| value | Description |
|---|---|
| 0 | HMAC |
| 1 | CVV |
| 2 | CVV with ATN |
| 3 | MasterCard SPA |
Format
code
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.code
Additional code explaining the result. E.g.: DS_TIMEOUT.
Format
message
Path: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.message
Additional message explaining the result.
Format
installmentNumber
Path: transactions.transactionDetails.cardDetails.installmentNumber
Number of installments.
Format
installmentCode
Path: transactions.transactionDetails.cardDetails.installmentCode
Code of the payment option used for the payment.
Format
subscriptionId
Path: transactions.transactionDetails.subscriptionDetails.subscriptionId
Recurring payment identifier.
Format
name
Path: transactions.transactionDetails.fraudManagement.riskControl.name
Name of the control implemented for risk assessment.
Possible values
. The possible values are:
| value | Description |
|---|---|
| CARD_FRAUD | Checks whether the cardholder's card number is on the card greylist. |
| SUSPECT_COUNTRY | Checks whether the cardholder's card number is on the list of forbidden countries. |
| IP_FRAUD | Checks whether the cardholder's IP address is on the IP greylist. |
| CREDIT_LIMIT | Checks the purchase frequency and amounts for the same card number, or the maximum amount of an order. |
| BIN_FRAUD | Checks whether the BIN code of the card is on the BIN code greylist. |
| ECB | Checks whether the Buyer's card belongs to the "e-carte bleue" type. |
| COMMERCIAL_CARD | Checks whether the Buyer's card is a commercial credit card. |
| SYSTEMATIC_AUTO | Checks whether the Buyer's card is a MAESTRO or VISA ELECTRON credit card. |
| INCONSISTENT_COUNTRIES | Checks whether the country of the IP address, the country of the payment card and the Buyer's country of residence match. |
| NON_WARRANTY_PAYMENT | Checks the liability shift of the transaction. |
| SUSPECT_IP_COUNTRY | Checks whether the cardholder's country, identified by the IP address, is on the list of forbidden countries. |
Format
result
Path: transactions.transactionDetails.fraudManagement.riskControl.result
Name of the control implemented for risk assessment.
Possible values
Result of the risk assessment.
| value | Description |
|---|---|
| OK | OK |
| WARNING | Informational control failed. |
| ERROR | Blocking control failed. |
Format
score
Path: transactions.transactionDetails.fraudManagement.riskAnalysis.score
Analysis identifier on the risk analyzer side.
Format
resultCode
Path: transactions.transactionDetails.fraudManagement.riskAnalysis.resultCode
Code returned by an external risk analyzer.
Possible values
. The possible values are:
| STATUS | Description |
|---|---|
| INVALID_CREDENCIAL | Configuration problem of the risk management contract. |
| COMUNICATION_PROBLEM | Impossible to connect to the risk analyzer. |
| DATA_PROCESSING_PROBLEM | Problem occurred when processing the data being transmitted or the response of the risk management system. |
| MISSING_MANDATORY_ORDER_INFO | Order details are missing. |
| MISSING_MANDATORY_SHIPPING_INFO | Shipping details are missing. |
| MISSING_MANDATORY_SHIPPING_ADDRESS_INFO | Shipping address details are missing. |
| MISSING_MANDATORY_BILLING_INFO | Billing details are missing. |
| MISSING_MANDATORY_BILLING_ADDRESS_INFO | Billing address details are missing. |
| MISSING_MANDATORY_CARD_INFO | Payment method details are missing. |
| MISSING_MANDATORY_CUSTOMER_INFO | Buyer details are missing. |
| APA | Specific to ClearSale. The transaction is automatically approved according to the defined parameters. |
| APM | Specific to ClearSale. The transaction is manually approved by an analyst. |
| RPM | Specific to ClearSale. The order is rejected due to missing buyer details in accordance with the implemented policy. |
| AMA | Specific to ClearSale. Waiting for manual analysis. The order is waiting to be analyzed. |
| ERR | Specific to ClearSale. Error. |
| NVO | Specific to ClearSale. New order. Waiting to be processed and classified. |
| SUS | Specific to ClearSale. Order manually suspended. The order is suspended for suspected fraud. |
| CAN | Specific to ClearSale. Order is canceled. The order has been canceled by the buyer. |
| FRD | Specific to ClearSale. Fraud confirmed by the credit card operator or the cardholder. |
| RPA | Specific to ClearSale. Order automatically declined. The order has been automatically declined in accordance with the parameters of the external risk analyzer. |
| RPP | Specific to ClearSale. Order automatically declined. The order is reproved based on the customer or ClearSale policy. |
| 100 | Specific to CyberSource. Transaction successfully completed. |
| 101 | Specific to CyberSource. Transaction is declined. One or more parameters are missing. |
| 102 | Specific to CyberSource. Transaction is declined. One or more parameters have invalid data. |
| 150 | Specific to CyberSource. Error. |
| 151 | Specific to CyberSource. Error. The request was received but the time limit has been exceeded. This error does not include the timeouts between the client and the server. |
| 152 | Specific to CyberSource. Error. The request was received but a service did not finish an operation in time. |
| 202 | Specific to CyberSource. Declined. Card expired. |
| 231 | Specific to CyberSource. Declined. Invalid account number. |
| 234 | Specific to CyberSource. Declined. A problem occurred with the merchant CyberSource configuration. |
| 400 | Specific to CyberSource. Declined. The score of the fraud exceeds the tolerance. |
| 480 | Specific to CyberSource. The order is marked and needs to be reviewed by the Decision Manager. |
| 481 | Specific to CyberSource. The order has been rejected by the Decision Manager. |
| APPROVE | Specific to Konduto. Konduto recommends to accept the transaction. If no rules contradict this recommendation, the transaction status will be AUTHORISED. |
| DECLINE | Specific to Konduto. Konduto recommends to decline the transaction. The transaction status will be REFUSED. |
| REVIEW | Specific to Konduto. Konduto recommends to check the transaction. Depending on the result of the 3D Secure authentication, the transaction status will be: |
| AUTHORISED_TO_VALIDATE | If the cardholder has successfully authenticated. |
| REFUSED | In case of authentication failure of the cardholder. |
Format
status
Path: transactions.transactionDetails.fraudManagement.riskAnalysis.status
Code returned by an external risk analyzer.
Risk analysis status.
Possible values
. The possible values are:
| value | Description |
|---|---|
| P_SEND_OK | Success. "Sent to clearsale and successfully processed". |
| P_TO_SEND | The transaction analysis is scheduled to be sent. “Transaction analysis is scheduled to be sent to risk analyzer”. |
| P_TO_SEND_KO | Processing error. "Problem when tried to send to risk analyzer.". |
| P_PENDING_AT_ANALYZER | The analysis result is being processed by the risk analyzer. “Analysis result is still being processed by the risk analyzer. We should keep checking/waiting for the analysis result”. |
| P_MANUAL | Waiting for manually sending the analysis. “Analysis should be requested through user request (not automatically)”. |
| P_SKIPPED | Discarded. "Analysis request discarded by current transaction status/problem". |
| P_SEND_EXPIRED | Expired.* "Analysis request expired". |
Format
requestId
Path: transactions.transactionDetails.fraudManagement.riskAnalysis.requestId
Analysis identifier on the risk analyzer side.
Format
extraInfo
Path: transactions.transactionDetails.fraudManagement.riskAnalysis.extraInfo
Specific to CyberSource. Codes returned by the DecisionManager.
Format
fingerPrintId
Path: transactions.transactionDetails.fraudManagement.riskAnalysis.fingerPrintId
This field is used by merchants who implement the risk analyzer in their payment page. Allows you to send the session ID (or fingerPrint Id) to the payment platform to finalize the risk analysis.
The supported analyzers are:
- NOTO
- Cybersource
- MonitorPlus
- ClearSale
Can contain uppercase and lowercase characters, numbers or hyphens ([A-Z] [a-z], 0-9, _, -).
Format
results
Path: transactions.transactionDetails.fraudManagement.riskAssessments.results
List of actions made with the transaction, following the activation of the advanced risk assessment enabled on the shop.
The possible values depend on the shop's options.
Possible values
. The possible values are:
| value | Description |
|---|---|
| ENABLE_3DS |
|
| DISABLE_3DS |
|
| NO_PREFERENCE |
|
| NO_CHALLENGE_REQUESTED |
|
| CHALLENGE_REQUESTED |
|
| CHALLENGE_MANDATE |
|
| MANUAL_VALIDATION | The transaction is created in manual validation. The payment capture is temporarily blocked to allow the Merchant perform all the desired verifications. |
| REFUSE | Transaction is declined. |
| RUN_RISK_ANALYSIS | Call for an external risk analyzer if the merchant has a contract. See the description of the TransactionDetails.FraudManagement.RiskAnalysis object to identify the list of possible values and their description. |
| INFORM | A warning message appears. The Merchant is notified that a potential problem has been identified. The Merchant is informed via one or several notification center rules (IPN, e-mail or SMS). |
Format
taxRate
Path: transactions.transactionDetails.taxRate
Used by some payment methods in Latin America. Allows you to transmit the tax rate applied to the entire order. The value must be the percentage to apply (21 for 21%).
Format
taxAmount
Path: transactions.transactionDetails.taxAmount
Amount of taxes for the entire order expressed in the smallest monetary unit (cent for euro).
Example: 30050 for EUR 300.50.
Format
preTaxAmount
Path: transactions.transactionDetails.preTaxAmount
Allows to define the pre-tax amount of the whole order.
The value must be specified in the smallest currency unit.
Format
externalTransactionId
Path: transactions.transactionDetails.externalTransactionId
External transaction reference.
Format
dccAmount
Path: transactions.transactionDetails.dcc.dccAmount
Transaction amount expressed in the smallest currency unit defined by dccCurrency (cent for euro).
This field is populated only if the card is eligible for the dynamic currency conversion (DCC) service and if the buyer has chosen to pay in the currency of their card.
The conversion rate is returned in the dccChangeRate field.
Format
dccCurrency
Path: transactions.transactionDetails.dcc.dccCurrency
Numeric code in accordance with the ISO 4217 standard of the currency chosen by the Buyer if the card is eligible for the Dynamic Currency Conversion (DCC) service.
This field is populated only if the card is eligible for the dynamic currency conversion (DCC) service and if the buyer has chosen to pay in the currency of their card.
The conversion rate is returned in the dccChangeRate field.
Format
dccChangeRate
Path: transactions.transactionDetails.dcc.dccChangeRate
Exchange rate used to calculate the effective payment amount.
Format
dccMarkup
Path: transactions.transactionDetails.dcc.dccMarkup
Indicates the percentage (or rate) of sales margin on the total amount.
This field is populated only if the card is eligible for the dynamic currency conversion (DCC) service and if the buyer has chosen to pay in the currency of their card.
E.g.: "3,5" for a margin rate of 3,5%.
Format
dccRateDate
Path: transactions.transactionDetails.dcc.dccRateDate
Date and time, in UTC format, when the conversion rate was received from the dynamic currency conversion (DCC) service.
This field is populated only if the card is eligible for the dynamic currency conversion (DCC) service and if the buyer has chosen to pay in the currency of their card.
The conversion rate is returned in the dccChangeRate field.
Format
paymentReference
Path: transactions.transactionDetails.acquirerDetails.paymentReference
Payment reference that appears on the payment receipt.
Used in particular for the Multibanco payment method.
Format
serviceSupplier
Path: transactions.transactionDetails.acquirerDetails.serviceSupplier
Identifier of the entity for which the payment is made.
Used in particular for the Multibanco payment method.
Format
nsu
Path: transactions.transactionDetails.nsu
Unique sequence number (Latin America).
Format
tid
Path: transactions.transactionDetails.tid
Terminal ID. Point of sale identifier defined on the acceptance contract.
This field is only used in Colombia for choosing between REDEBAN and CREDIBANCO.
Format
acquirerNetwork
Path: transactions.transactionDetails.acquirerNetwork
Acquirer network code.
Possible values:
| Network code | label |
|---|---|
| ACCORD | Accord brand card |
| ACCORD_SANDBOX | Accord brand card - Sandbox mode |
| ALMA | ALMA |
| AMEXGLOBAL | American Express International |
| APPLE PAY | Apple Pay |
| AURORE | Cetelem - Aurore and Cpay credit cards |
| CB | Carte Bancaire |
| CONECS | Conecs |
| CVCONNECT | Chèque-Vacances ANCV Connect |
| FRANFINANCE | Franfinance |
| FRANFINANCE_SB | Franfinance - Sandbox mode |
| FULLCB | Cetelem - 3 or 4 fois Card Payment |
| GATECONEX | Elavon Europe |
| IDEAL | iDeal |
| JCB | JCB France and French Polynesia |
| ONEY_API | 3x 4x Oney Payment |
| ONEY_API | Payment 10x 12x Oney |
| ONEY_API | Oney Pay Later payment |
| ONEY_API_SANDBOX | Oney 3x 4x payment - Sandbox mode |
| ONEY_API_SANDBOX | Oney 10x 12x payment - Sandbox mode |
| ONEY_API_SANDBOX | Payment Oney Pay Later- Sandbox mode |
| PAYPAL | PayPal |
| PAYPAL_BNPL | PayPal Pay Later |
| PAYPAL_SB | PayPal - Sandbox mode |
| PAYPAL_BNPL_SB | PayPal Pay Later- Mode sandbox |
| SEPA | SEPA DIRECT DEBIT |
Format
taxRefundAmount
Path: transactions.transactionDetails.taxRefundAmount
Used in Uruguay, this field corresponds to the amount of tax credit granted to the merchant for the transaction. The value is expressed in the smallest monetary unit (the cent for the euro).
Example: 30050 for EUR 300.50.
Format
occurrenceType
Path: transactions.transactionDetails.occurrenceType
Allows to identify if the transaction is part of a series of payments (subscription or payment in installments).
Useful for accurately identifying the first payment in a series.
With the Soft Decline, the payment platform automatically performs a new payment attempt with 3D Secure authentication when possible. This changes the sequence number of the payment. The sequenceNumber field can no longer be used to easily identify the first payment in a series.
Possible values
| value | Description |
|---|---|
| RECURRENT_INITIAL | First payment of a series. |
| RECURRENT_INTERMEDIAIRE | The umpteenth payment in a series. |
| RECURRENT_FINAL | Last payment of a series. |
| UNITAIRE | Single payment (instant payment). |
Format
archivalReferenceId
Path: transactions.transactionDetails.archivalReferenceId
Reference generated by the payment gateway and sent to the acquirer for capture processing and transaction reconciliation.
Populated only for CB, AMEX and PAYPAL payments.
Format
serverDate
Date of response generation.Allows you to measure the possible time lag between the merchant's and the payment service's servers.