CustomerWallet response
Object containing information about a buyer wallet. It contains the list of payment methods registered for the buyer reference.
Response reference
customerReference
Format
cancellationDate
Path: tokens.cancellationDate
Date of token cancellation.
Format
tokens.creationDate
Date and time of token creation.
Format
paymentMethodToken
Path: tokens.paymentMethodToken
Token associated with a payment method.
Format
paymentMethodType
Path: tokens.paymentMethodType
Payment method type. Example: PAYCONIQ
Format
tokens.status
Format
Possible values
. The possible values are:
| value | Description | |
|---|---|---|
| ACTIVE | The payment method can be used for a payment (default value) | |
| EXPIRED | The payment method has expired | |
| The payment method is logically removed (canceled) | ||
| all | All statuses combined |
reference
Path: tokens.customer.reference
Buyer ID on the merchant side.
Format
Path: tokens.customer.email
Buyer's e-mail address.
- Email structure specifications: RFC-2822
Format
address
Path: tokens.customer.billingDetails.address
Billing address.
Warning: the characters > and < are not authorized.
Format
address2
Path: tokens.customer.billingDetails.address2
Second line of the billing address.
Warning: the characters > and < are not authorized.
Format
category
Path: tokens.customer.billingDetails.category
Buyer type.
Format
Possible values
| Values | Description |
|---|---|
| PRIVATE | Individual buyer type. |
| COMPANY | Company buyer type. |
cellPhoneNumber
Path: tokens.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: tokens.customer.billingDetails.city
City of the billing address.
Format
country
Path: tokens.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: tokens.customer.billingDetails.district
District of the billing address.
Format
firstName
Path: tokens.customer.billingDetails.firstName
Buyer's first name.
Format
identityCode
Path: tokens.customer.billingDetails.identityCode
National identifier. Allows to identify each citizen within a country.
Format
identityType
Path: tokens.customer.billingDetails.identityType
ID type.
Format
language
Path: tokens.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: tokens.customer.billingDetails.lastName
Buyer's last name.
Format
legalName
Path: tokens.customer.billingDetails.legalName
Legal name.
Format
phoneNumber
Path: tokens.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: tokens.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: tokens.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: tokens.customer.billingDetails.title
Buyer's title.
Examples:
- Mr
- Ms.
- Mrs
Format
zipCode
Path: tokens.customer.billingDetails.zipCode
Zip code of the billing address.
Format
address
Path: tokens.customer.shippingDetails.address
Shipping address.
Warning: the characters > and < are not authorized.
Format
address2
Path: tokens.customer.shippingDetails.address2
Second line of the shipping address.
Warning: the characters > and < are not authorized.
Format
category
Path: tokens.customer.shippingDetails.category
Buyer type.
Format
Possible values
| Values | Description |
|---|---|
| PRIVATE | Individual buyer type. |
| COMPANY | Company buyer type. |
city
Path: tokens.customer.shippingDetails.city
Shipping city.
Format
country
Path: tokens.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: tokens.customer.shippingDetails.deliveryCompanyName
Name of the delivery company.
Format
district
Path: tokens.customer.shippingDetails.district
District of the billing address.
Format
firstName
Path: tokens.customer.shippingDetails.firstName
First name of the recipient.
Format
identityCode
Path: tokens.customer.shippingDetails.identityCode
National identifier. Allows to identify each citizen within a country.
Format
lastName
Path: tokens.customer.shippingDetails.lastName
Buyer's last name.
Format
legalName
Path: tokens.customer.shippingDetails.legalName
Legal name in case of shipping to a company.
Format
phoneNumber
Path: tokens.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: tokens.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: tokens.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: tokens.customer.shippingDetails.state
Region of the billing address.
Format
streetNumber
Path: tokens.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: tokens.customer.shippingDetails.zipCode
Zip code of the billing address.
Format
ipAddress
Path: tokens.customer.extraDetails.ipAddress
Buyer's IP address.
Format
fingerPrintId
Path: tokens.customer.extraDetails.fingerPrintId
Format
browserUserAgent
Path: tokens.customer.extraDetails.browserUserAgent
1. "User-Agent" header of buyer's browser (HTTP/1.1 - RFC. 2616).
Format
browserAccept
Path: tokens.customer.extraDetails.browserAccept
1. "Accept" header of buyer's browser (HTTP/1.1 - RFC. 2616).
Format
insuranceAmount
Path: tokens.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: tokens.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: tokens.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: tokens.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: tokens.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: tokens.customer.shoppingCart.cartItemInfo.productLabel
Product name.
Format
productQty
Path: tokens.customer.shoppingCart.cartItemInfo.productQty
Product quantity.
Format
productRef
Path: tokens.customer.shoppingCart.cartItemInfo.productRef
Product reference.
Format
productType
Path: tokens.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: tokens.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
country
Path: tokens.tokenDetails.country
Country code of the card.
Format
effectiveBrand
Path: tokens.tokenDetails.effectiveBrand
Card brand.
| Payment method | Card type (effectiveBrand) |
|---|---|
| Carte enseigne Accord | ACCORD_STORE |
| Carte enseigne Accord - Mode sandbox | ACCORD_STORE_SB |
| Alipay | ALIPAY |
| 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 |
| 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 |
| Giropay | GIROPAY |
| Paiement par Wallet Google Pay | GOOGLEPAY |
| 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 |
| Multibanco | 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 |
| Prélèvement Bancaire SEPA DIRECT DEBIT | SDD |
| Titre-Restaurant Dématérialisé Sodexo | SODEXO |
| Sofort Banking | SOFORT_BANKING |
| Union Pay | UNION_PAY |
| BHIM-UPI | BHIM-UPI |
| Visa | VISA |
| Visa Electron | VISA_ELECTRON |
| Vpay | VPAY |
Format
effectiveProductCode
Path: tokens.tokenDetails.effectiveProductCode
Product code of the card used for the payment.
| Visa | Designation |
|---|---|
| A | |
| B | |
| C | |
| D | |
| E | |
| F | |
| G | |
| Enhanced Business Visa | |
| H | |
| I | |
| Ultra High Net Worth Visa | |
| J | |
| K | |
| L | |
| N | |
| TBA | |
| P | |
| Q | |
| R | |
| S | |
| T | |
| U | |
| V | |
| W | |
| X | |
| Y | |
| Z |
| 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 |
| 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
issuerCode
Path: tokens.tokenDetails.issuerCode
Code associated with the issuing bank.
Format
issuerName
Path: tokens.tokenDetails.issuerName
Name of the bank associated with the issuing bank.
Format
expiryMonth
Path: tokens.tokenDetails.expiryMonth
Expiration month in a two-digit format. Example: "09" for September.
Format
expiryYear
Path: tokens.tokenDetails.expiryYear
Expiration year in a two-digit format. Example: "25" for 2025.
Format
mid
Path: tokens.tokenDetails.mid
Merchant ID number. If this field is populated, make sure you use the appropriate MID depending on the card scheme.
Format
pan
Path: tokens.tokenDetails.pan
Truncated card number.
Format
paymentSource
Path: tokens.tokenDetails.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". |
amount
Path: tokens.tokenDetails.authorizationResponse.amount
Authorization amount.
Format
currency
Path: tokens.tokenDetails.authorizationResponse.currency
Code of the currency used during the authorization request.
Format
authorizationDate
Path: tokens.tokenDetails.authorizationResponse.authorizationDate
Date and time of the authorization request.
Format
authorizationNumber
Path: tokens.tokenDetails.authorizationResponse.authorizationNumber
Number of the authorization request.
Format
authorizationResult
Path: tokens.tokenDetails.authorizationResponse.authorizationResult
Return code of the authorization request.
See the List of authorization return codes for more information.
Format
authorizationMode
Path: tokens.tokenDetails.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
id
Path: tokens.tokenDetails.authenticationResponse.id
Unique identifier of the authentication, in UUID format.
Format
operationSessionId
Path: tokens.tokenDetails.authenticationResponse.operationSessionId
Unique identifier for the authentication session.
Format
instructionType
Path: tokens.tokenDetails.authenticationResponse.value.instructionType
Type of instruction to carry out.
Format
Possible values
| Values | Description |
|---|---|
| FORM | Form with redirect type instruction. |
name
Path: tokens.tokenDetails.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: tokens.tokenDetails.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: tokens.tokenDetails.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: tokens.tokenDetails.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: tokens.tokenDetails.authenticationResponse.value.http.url
URL to which the HTTP form must be submitted.
Format
body
Path: tokens.tokenDetails.authenticationResponse.value.http.body
List of request body parameters, presented as “name”: “value”.
Format
headers
Path: tokens.tokenDetails.authenticationResponse.value.http.headers
List of HTTP request headers, presented as “name”: “value”.
Format
element
Path: tokens.tokenDetails.authenticationResponse.value.target.element
Type of the target HTML element which contains the instruction.
Possible values
| value | Description |
|---|---|
| IFRAME |
Format
height
Path: tokens.tokenDetails.authenticationResponse.value.target.height
Height of the HTML target in pixels.
Format
visible
Path: tokens.tokenDetails.authenticationResponse.value.target.visible
Boolean indicating whether or not the HTML target must be visible.
Format
width
Path: tokens.tokenDetails.authenticationResponse.value.target.width
Width of the HTML target in pixels.
Format
showUrl
Path: tokens.tokenDetails.authenticationResponse.value.target.showUrl
Technical field for internal use that allows to show or hide the URL of the ACS.
Format
challengePreference
Path: tokens.tokenDetails.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: tokens.tokenDetails.authenticationResponse.protocol.name
Name of the protocol used by the cardholder authentication services.
Possible values
| value | Description |
|---|---|
| THREEDS | 3D Secure protocol |
Format
simulation
Path: tokens.tokenDetails.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: tokens.tokenDetails.authenticationResponse.protocol.network
Network where the payment method was authenticated.
Currently supported networks
| value |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| PROTECTBUY |
Format
version
Path: tokens.tokenDetails.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: tokens.tokenDetails.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: tokens.tokenDetails.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 |
|---|---|
| Not authenticated | |
| Authenticated |
Format
status
Path: tokens.tokenDetails.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: tokens.tokenDetails.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: tokens.tokenDetails.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) | string / 32 alphanumeric characters + 4 dashes | 4317fdc3-ad24-5443-8000-000000000891 |
Format
authenticationValueType
Path: tokens.tokenDetails.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: tokens.tokenDetails.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: tokens.tokenDetails.authenticationResponse.value.extension.authenticationType
Type of result extension.
Format
Possible values
| Values | Description |
|---|---|
| THREEDS_V2 | Extension for 3DS Secure v2 authentications |
acsTransId
Path: tokens.tokenDetails.authenticationResponse.value.extension.acsTransId
ACS transaction ID. This field is only relevant to the CB network. See: Integration Guide
Format
cbScore
Path: tokens.tokenDetails.authenticationResponse.value.extension.cbScore
CB score as defined in the CB extension of the ARES message.
Format
algorithm
Path: tokens.tokenDetails.authenticationResponse.value.extension.algorithm
Code of the algorithm used for generating the Authentication Value (used during the authorization).
Possible values
| value | Description |
|---|---|
| 0 | |
| 1 | |
| 2 | CVV with ATN |
| 3 | MasterCard SPA |
Format
code
Path: tokens.tokenDetails.authenticationResponse.value.reason.code
Additional code explaining the result. E.g.: DS_TIMEOUT.
Format
message
Path: tokens.tokenDetails.authenticationResponse.value.reason.message
Additional message explaining the result.