paymentWebInit
To search in the page use Ctrl+F on your keyboard
Initialize a payment request with “Sogenactif Paypage”
Recommended interfaceVersion:
- POST : HP_3.4
- JSON/SOAP : IR_WS_3.4
Endpoints
-
- PROD
-
https://payment-webinit.sogenactif.com/rs-services/v2/paymentInit
- method
- POST
-
- SIMU
-
https://payment-webinit.simu.sogenactif.com/rs-services/v2/paymentInit
- method
- POST
-
- PROD
-
https://payment-webinit.sogenactif.com/paymentInit
- method
- POST
-
- SIMU
-
https://payment-webinit.simu.sogenactif.com/paymentInit
- method
- POST
-
- PROD
-
https://payment-webinit.sogenactif.com/services/v2/paymentInit
- method
- POST
-
- SIMU
-
https://payment-webinit.simu.sogenactif.com/services/v2/paymentInit
- method
- POST
Request
Required
-
amount
- presence
- Required
- Interface version
- 2.0
Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.
-
currencyCode
- presence
- Required
- Interface version
- 2.0
Currency code for the transaction. This code is ISO 4217 compatible.
List of values
032
- Argentinean Peso
036
- Australian Dollar
048
- Bahrain Dinar
116
- Cambodian Riel
124
- Canadian Dollar
144
- Sri Lanka Rupee
156
- China Yuan Renminbi
191
- Croatia Kuna
203
- Czech Republic Koruna
208
- Danes crown
344
- Hong Kong dollar
348
- Hungary Forint
352
- Iceland Rupee
356
- Indian rupee
376
- Israel Shekel
392
- Japanese Yen
410
- South Korean Won
414
- Kuwait Dinar
458
- Malaysia Ringgit
480
- Mauritius Rupee
484
- Mexican Peso
524
- Nepal Rupee
554
- New Zealand Dollar
578
- Norwegian crown
634
- Qatar Riyal
643
- Russia Ruble
682
- Saudi Arabia Riyal
702
- Singapore Dollar
710
- South Africa Rand
752
- Swedish crown
756
- Swiss Franc
764
- Thailand Baht
784
- United Arab Emirates Dirham
788
- Tunisia Dinar
826
- Pound
840
- American Dollar
901
- Taiwan Dollar
941
- Serbian Dinar
946
- Roumania New Leu
949
- New Turkish Lira
952
- CFA Franc
953
- CFP Franc
975
- Bulgaria Lev
978
- Euro
980
- Ukraine Hryvnia
985
- Poland Zloty
986
- Brazilian Real
-
interfaceVersion
- presence
- Required
- Interface version
- 2.0
Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).
Please refer to the function page for the value to use. Use the latest interface version number.
List of values
IR_WS_
- Sogenactif Paypage and Sogenactif Office Serveur (SOAP/JSON) interface.
HP_x.x
- Sogenactif Paypage and Sogenactif Walletpage (POST) interface.
-
keyVersion
- presence
- Required
- Interface version
- 2.0
Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).
-
merchantId
- presence
- Required
- Interface version
- 2.0
Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
-
normalReturnUrl
- presence
- Required
- Interface version
- 2.0
Merchant’s URL for the return to the shop.
-
orderChannel
- presence
- Required
- Interface version
- 2.0
Order channel used (Internet, Telephone, Post, Fax etc), Internet is the default value.Use of this field should be reconciled with the conditions defined in the acquirer contract.
List of values
FAX
- Fax order channel Acquiring contract: MOTO
INAPP
- Order from a service inside an application (eg mobile) Acquiring contract: INTERNET
INTERNET
- Internet order channel Acquiring contract: INTERNET
IVR
- IVR order channel Acquiring contract: MOTO
MAIL_ORDER
- Mail order channel Acquiring contract: MOTO
MINITEL
- Obsolete
MOTO
- Mail order or Telephone order channel without distinction (deprecated, use MAIL_ORDER or TELEPHONE_ORDER) Acquiring contract: MOTO
PROXI_ATTENDED
- Obsolete
PROXI_SEMIATTENDED
- Obsolete
PROXI_UNATTENDED
- Obsolete
TELEPHONE_ORDER
- Telephone order channel Acquiring contract: MOTO
-
seal
- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Conditional
-
paymentPattern
- presence
- Conditional
- Interface version
- 2.0
Type of payment (per operation, 1st recurring payment etc).
List of values
INSTALMENT
- transactionInitiator : CIT, MIT Payment by instalment
MULTIPLE_1
- transactionInitiator : CIT First payment for a purchase dispatched in several shipments
MULTIPLE_N
- transactionInitiator : MIT Nth payment for a purchase dispatched in several shipments
ONE_SHOT
- transactionInitiator : CIT One shot payment (default value)
RECURRING_1
- transactionInitiator : CIT Subscription payment first
RECURRING_N
- transactionInitiator : MIT Abonnement Nème paiement
Optional
-
authenticationData
- presence
- Optional
- Interface version
- 2.0
Contains the information on the cardholder’s authentication.
Contains
-
authentAmount
- presence
- Optional
- Interface version
- 2.37
Authentication amount.
-
cardAuthPolicy
- presence
- Optional
- Interface version
- 2.0
Authentication policy for card.
Contains
-
checkAVS
- presence
- Optional
- Interface version
- 2.0
Indicator (true/false) to execute the AVS check. By default, the control is deactivated.true: to execute the AVS check.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
ignoreAddressCheckResult
- presence
- Optional
- Interface version
- 2.0
Indicator to ignore the ADDRESS check result.- true: to ignore,- false: to not ignore (by default).
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
ignoreCSCCheckResult
- presence
- Optional
- Interface version
- 2.0
Indicator to ignore the CSC check result.- true: to ignore,- false: to not ignore (by default).
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
ignorePostcodeCheckResult
- presence
- Optional
- Interface version
- 2.0
Indicator to ignore the POSTCODE check result.- true: to ignore,- false: to not ignore (by default).
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
issuerWalletAuthPolicy
- presence
- Optional
- Interface version
- 2.0
Authentication policy for wallet.
Contains
-
checkCSC
- presence
- Optional
- Interface version
- 2.0
FORCE/BYPASS. Indicator to execute the CSC check for issuer wallet payment means (used by V.me). For V.me, by default, CSC check is deactivated.
-
check3DS
- presence
- Optional
- Interface version
- 2.0
FORCE/BYPASS. Indicator to execute the 3-D Secure check for issuer wallet payment means (used by V.me and MasterPass). For V.me, by default, 3-D Secure check is deactivated. For masterPass, 3-D Secure check is activated
-
automaticResponseUrl
- presence
- Optional
- Interface version
- 2.0
URL provided by the merchant and used by the payment server to automatically notify the merchant of the result of the transaction online.
-
billingAddress
- presence
- Optional
- Interface version
- 2.0
Contains the billing address information for the buyer.
Contains
-
addressAdditional3
- presence
- Optional
- Interface version
- 2.0
Addition 3 to the address.
-
addressAdditional1
- presence
- Optional
- Interface version
- 2.0
Addition 1 to the address.
-
addressAdditional2
- presence
- Optional
- Interface version
- 2.0
Addition 2 to the address.
-
businessName
- presence
- Optional
- Interface version
- 2.17
Business name.
-
city
- presence
- Optional
- Interface version
- 2.0
City of the address.
-
company
- presence
- Optional
- Interface version
- 2.0
Company for the address.
-
country
- presence
- Optional
- Interface version
- 2.0
Country code for the address.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
postBox
- presence
- Optional
- Interface version
- 2.0
Post box for the address.
-
state
- presence
- Optional
- Interface version
- 2.0
Address state/department. To be completed in accordance with ISO 3166-2. The first two letters designate the country and the letters following the hyphen designate the subdivision, e.g. FR-ARA for the French region Auvergne-Rhône-Alpes.
-
street
- presence
- Optional
- Interface version
- 2.0
Name of the street of the address.
-
streetNumber
- presence
- Optional
- Interface version
- 2.0
Number of the street of the address.
-
zipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the address.
-
billingContact
- presence
- Optional
- Interface version
- 2.0
Contains the billing contact’s information.
Contains
-
email
- presence
- Optional
- Interface version
- 2.0
Contact’s email address.
-
firstname
- presence
- Optional
- Interface version
- 2.0
First name of the contact.
-
gender
- presence
- Optional
- Interface version
- 2.0
Gender of the contact, male (=M) or female (=F).
-
initials
- presence
- Optional
- Interface version
- 2.11
contact initals
-
lastname
- presence
- Optional
- Interface version
- 2.0
Last name of the contact.
-
legalId
- presence
- Optional
- Interface version
- 2.17
Legal business identifier (SIRET in France). This field is applicable for merchant or customer (please see fields Contact).
-
mobile
- presence
- Optional
- Interface version
- 2.0
Mobile phone number for the contact.
-
phone
- presence
- Optional
- Interface version
- 2.0
Telephone number for the contact.
-
positionOccupied
- presence
- Optional
- Interface version
- 2.17
Position occupied.
-
title
- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone
- presence
- Optional
- Interface version
- 2.21
Holder’s business phone number.
-
billingFirstDate
- presence
- Optional
- Interface version
- 2.0
First successful billing date for the customer address. For example, the merchant gives this information to allow the certification of an electronic signature.
-
bypassDcc
- presence
- Optional
- Interface version
- 2.0
Indicator used by the merchant to bypass the dcc procedure.
List of values
N
- Propose the DCC service
Y
- Bypass the DCC service
-
bypassReceiptPage
- presence
- Optional
- Interface version
- 2.0
Flag indicating that Sogenactif must not issue the ticket receipt. This action is at charge of the trader. At the end of the payment, the customer is directly redirected to the response url from the shop (normalReturnUrl).
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
captureDay
- presence
- Optional
- Interface version
- 2.0
Deadline for settlement.
-
captureMode
- presence
- Optional
- Interface version
- 2.0
Payment collection method for the transaction.
List of values
AUTHOR_CAPTURE
- Cancellation mode: automatic authorisation and payment collection (default value)
AUTHOR_NOCAPTURE
- Value only for response purpose
IMMEDIATE
- Immediate mode: online payment collection at the time of the authorisation request (available for a restricted list of payment methods)
VALIDATION
- Validation mode: payment collection following validation of the merchant
-
customer3DSTransactionDate
- presence
- Optional
- Interface version
- 2.0
Date of a 3D Secure transaction successfuly realised for the customer. For example, the merchant gives this information to allow the certification of an electronic signature.
-
customerAccountHistoric
- presence
- Optional
- Interface version
- 2.21
Contains information from the customer’s account at the merchant (date of creation, number of transactions in the last 24h, …).
Contains
-
addPaymentMeanDate
- presence
- Optional
- Interface version
- 2.27
Enrollment date of the means of payment in the customer account on the merchant site.
-
creationDate
- presence
- Optional
- Interface version
- 2.21
Creation date.With the container customerAccount, it is the date of creation of the customer account at the merchant which makes it possible to calculate the seniority of the account.
-
changeDate
- presence
- Optional
- Interface version
- 2.27
Date of the last change made on the customer account at the merchant. For example : changing billing address, delivery address or adding a new payment method.
-
customerAccountId
- presence
- Optional
- Interface version
- 2.27
Additional information about the account optionally provided by the 3-D Secure Requestor.
-
firstPurchaseDate
- presence
- Optional
- Interface version
- 2.24
Date of the first purchase in the shop.
-
lastPurchaseDate
- presence
- Optional
- Interface version
- 2.24
Date of the last known purchase in the shop.
-
numberOfAttemptsAddCard24Hours
- presence
- Optional
- Interface version
- 2.21
Number of distinct cards used by the merchant’s account in the last 24 hours.
-
numberOfPurchase
- presence
- Optional
- Interface version
- 2.26
Total number of purchases made with a single client account on the merchant website.
-
numberOfPurchase180Days
- presence
- Optional
- Interface version
- 2.21
Number of purchases made on the customer’s account via the merchant site over the last six months (last 180 days).
-
numberOfScoringCancelledPurchase
- presence
- Optional
- Interface version
- 3.2
Total number of purchases (made with a single client account on the merchant website) cancelled due to merchant scoring.
-
numberOfTransaction24Hours
- presence
- Optional
- Interface version
- 2.21
Number of abandoned or successful transactions in the last 24 hours on the customer account.
-
numberOfTransactionYear
- presence
- Optional
- Interface version
- 2.27
Number of accepted or abandoned transactions in the last year on the merchant’s customer account.
-
numberOfUncancelledPurchase
- presence
- Optional
- Interface version
- 3.2
Total number of purchases (made with a single client account on the merchant website) not cancelled by the client themselves.
-
passwordChangeDate
- presence
- Optional
- Interface version
- 2.27
Date of last change of password of the customer account at the merchant.
-
suspiciousActivityIndicator
- presence
- Optional
- Interface version
- 2.21
Specifies whether a suspicious activity is detected on customer account in the merchant’s website.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
customerAddress
- presence
- Optional
- Interface version
- 2.0
Contains the customer’s address information.
Contains
-
addressAdditional3
- presence
- Optional
- Interface version
- 2.0
Addition 3 to the address.
-
businessName
- presence
- Optional
- Interface version
- 2.17
Business name.
-
country
- presence
- Optional
- Interface version
- 2.0
Country code for the address.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
city
- presence
- Optional
- Interface version
- 2.0
City of the address.
-
company
- presence
- Optional
- Interface version
- 2.0
Company for the address.
-
addressAdditional1
- presence
- Optional
- Interface version
- 2.0
Addition 1 to the address.
-
addressAdditional2
- presence
- Optional
- Interface version
- 2.0
Addition 2 to the address.
-
postBox
- presence
- Optional
- Interface version
- 2.0
Post box for the address.
-
state
- presence
- Optional
- Interface version
- 2.0
Address state/department. To be completed in accordance with ISO 3166-2. The first two letters designate the country and the letters following the hyphen designate the subdivision, e.g. FR-ARA for the French region Auvergne-Rhône-Alpes.
-
street
- presence
- Optional
- Interface version
- 2.0
Name of the street of the address.
-
streetNumber
- presence
- Optional
- Interface version
- 2.0
Number of the street of the address.
-
zipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the address.
-
customerBillingNb
- presence
- Optional
- Interface version
- 2.0
Number of billing realised for the customer address. For example, the merchant gives this information to allow the certification of an electronic signature.
-
customerContact
- presence
- Optional
- Interface version
- 2.0
Contains the customer’s information.
Contains
-
email
- presence
- Optional
- Interface version
- 2.0
Contact’s email address.
-
firstname
- presence
- Optional
- Interface version
- 2.0
First name of the contact.
-
gender
- presence
- Optional
- Interface version
- 2.0
Gender of the contact, male (=M) or female (=F).
-
initials
- presence
- Optional
- Interface version
- 2.11
contact initals
-
lastname
- presence
- Optional
- Interface version
- 2.0
Last name of the contact.
-
legalId
- presence
- Optional
- Interface version
- 2.17
Legal business identifier (SIRET in France). This field is applicable for merchant or customer (please see fields Contact).
-
mobile
- presence
- Optional
- Interface version
- 2.0
Mobile phone number for the contact.
-
phone
- presence
- Optional
- Interface version
- 2.0
Telephone number for the contact.
-
positionOccupied
- presence
- Optional
- Interface version
- 2.17
Position occupied.
-
title
- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone
- presence
- Optional
- Interface version
- 2.21
Holder’s business phone number.
-
customerData
- presence
- Optional
- Interface version
- 2.0
Contains the customer’s information.
Contains
-
birthCity
- presence
- Optional
- Interface version
- 2.0
Birthplace.
-
birthCountry
- presence
- Optional
- Interface version
- 2.0
Country of birth.
-
birthZipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the birth.
-
birthDate
- presence
- Optional
- Interface version
- 2.0
Date of birth.
-
loyaltyIndicator
- presence
- Optional
- Interface version
- 3.2
Specifies whether the client is a regular client.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
maidenName
- presence
- Optional
- Interface version
- 2.18
Maiden name.
-
nationalityCountry
- presence
- Optional
- Interface version
- 2.0
Country of nationality.
-
newPassword
- presence
- Optional
- Interface version
- 2.0
Customer’s new password.
-
password
- presence
- Optional
- Interface version
- 2.0
Password.
-
customerDeliverySuccessFlag
- presence
- Optional
- Interface version
- 2.0
Successful delivery flag for the customer. For example, the merchant gives this information to allow the certification of an electronic signature.
List of values
N
- No successful delivery for the customer
Y
- At least one successful delivery has been realised for the customer
-
customerEmail
- presence
- Optional
- Interface version
- 2.0
Depreciated, replaced by “email” in the container customerContact.
-
customerId
- presence
- Optional
- Interface version
- 2.0
Customer identifier
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
-
customerIpAddress
- presence
- Optional
- Interface version
- 2.0
Buyer’s IP address.
-
customerLanguage
- presence
- Optional
- Interface version
- 2.0
Language of the user, used on the payment pages.
List of values
It
- Italian
Ja
- Japanese
cs
- Czech
da
- Danish
de
- German
el
- Greek
en
- English
es
- Spanish
et
- Estonian
fi
- Finnish
fr
- French
hu
- Hungarian
ko
- Korean
lt
- Lithuanian
lv
- Latvian
nl
- Dutch
no
- Norwegian
pl
- Polish
pt
- Portuguese
ro
- Romanian
ru
- Russian
sk
- Slovak
sl
- Slovene
sv
- Swedish
tr
- Turkish
uk
- Ukrainian
zh
- Chinese
-
customerPhoneValidationMethod
- presence
- Optional
- Interface version
- 2.0
Method used to validate the customer phone number. For example, the merchant gives this information to allow the certification of an electronic signature.
List of values
OUTGOING_CALL
- Phone number validated by a call (outgoing call)
TELCO_DIRECTORY
- Phone number validated by a directory (telephone directory)
-
customerRegistrationDateOnline
- presence
- Optional
- Interface version
- 2.0
Online registration date of the customer. For example, the merchant gives this information to allow the certification of an electronic signature.
-
customerRegistrationDateProxi
- presence
- Optional
- Interface version
- 2.0
On site (Point Of Sale) registration date of the customer. For example, the merchant gives this information to allow the certification of an electronic signature.
-
customerTimestampIpaddress
- presence
- Optional
- Interface version
- 2.26
Date and hour at which the customer visited your web site.
-
deliveryAddress
- presence
- Optional
- Interface version
- 2.0
Contains the delivery address information.
Contains
-
addressAdditional3
- presence
- Optional
- Interface version
- 2.0
Addition 3 to the address.
-
businessName
- presence
- Optional
- Interface version
- 2.17
Business name.
-
country
- presence
- Optional
- Interface version
- 2.0
Country code for the address.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
city
- presence
- Optional
- Interface version
- 2.0
City of the address.
-
company
- presence
- Optional
- Interface version
- 2.0
Company for the address.
-
addressAdditional1
- presence
- Optional
- Interface version
- 2.0
Addition 1 to the address.
-
addressAdditional2
- presence
- Optional
- Interface version
- 2.0
Addition 2 to the address.
-
postBox
- presence
- Optional
- Interface version
- 2.0
Post box for the address.
-
state
- presence
- Optional
- Interface version
- 2.0
Address state/department. To be completed in accordance with ISO 3166-2. The first two letters designate the country and the letters following the hyphen designate the subdivision, e.g. FR-ARA for the French region Auvergne-Rhône-Alpes.
-
street
- presence
- Optional
- Interface version
- 2.0
Name of the street of the address.
-
streetNumber
- presence
- Optional
- Interface version
- 2.0
Number of the street of the address.
-
zipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the address.
-
deliveryContact
- presence
- Optional
- Interface version
- 2.0
Contains the delivery contact’s information.
Contains
-
email
- presence
- Optional
- Interface version
- 2.0
Contact’s email address.
-
firstname
- presence
- Optional
- Interface version
- 2.0
First name of the contact.
-
gender
- presence
- Optional
- Interface version
- 2.0
Gender of the contact, male (=M) or female (=F).
-
initials
- presence
- Optional
- Interface version
- 2.11
contact initals
-
lastname
- presence
- Optional
- Interface version
- 2.0
Last name of the contact.
-
legalId
- presence
- Optional
- Interface version
- 2.17
Legal business identifier (SIRET in France). This field is applicable for merchant or customer (please see fields Contact).
-
mobile
- presence
- Optional
- Interface version
- 2.0
Mobile phone number for the contact.
-
phone
- presence
- Optional
- Interface version
- 2.0
Telephone number for the contact.
-
positionOccupied
- presence
- Optional
- Interface version
- 2.17
Position occupied.
-
title
- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone
- presence
- Optional
- Interface version
- 2.21
Holder’s business phone number.
-
deliveryData
- presence
- Optional
- Interface version
- 2.6
Contains the delivery information.
Contains
-
deliveryAddressCreationDate
- presence
- Optional
- Interface version
- 2.21
The date on which the last delivery address used by the merchant’s account was reported in the transaction.
-
deliveryChargeAmount
- presence
- Optional
- Interface version
- 2.6
Total shipping costs for the order.
-
deliveryAddressStatus
- presence
- Optional
- Interface version
- 2.26
Status of the delivery address.For example: confirmed, unconfirmed.
-
deliveryMethod
- presence
- Optional
- Interface version
- 2.6
Method chosen for delivery (standard, priority, …).
-
deliveryMode
- presence
- Optional
- Interface version
- 2.6
Mode of the delivery (Post Office, in a participating store, …).
List of values
BILLING_ADDRESS
DIGITAL_GOODS
EVENT_TICKETS
OTHER
OTHER_ADDRESS
SHIP_TO_STORE
VERIFIED_ADDRESS
-
deliveryOperator
- presence
- Optional
- Interface version
- 2.6
Name of the carrier ensuring the delivery.
-
electronicDeliveryIndicator
- presence
- Optional
- Interface version
- 2.21
Specifies whether the delivery is in an electronic mode.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
estimatedDeliveryDate
- presence
- Optional
- Interface version
- 2.6
Estimated delivery date by the merchant.
-
estimatedDeliveryDelay
- presence
- Optional
- Interface version
- 2.6
Estimated delivery delay (in days) by the merchant.
-
deliveryFirstDate
- presence
- Optional
- Interface version
- 2.0
First successful delivery date at the customer address. For example, the merchant gives this information to allow the certification of an electronic signature.
-
evidenceAcquisitionDate
- presence
- Optional
- Interface version
- 2.0
Date when the customer has provided the proof to the merchant. For example, the merchant gives this information to allow the certification of an electronic signature.
-
evidenceNumber
- presence
- Optional
- Interface version
- 2.0
Number of the proof provided by the customer. For example, the merchant gives this information to allow the certification of an electronic signature.
-
evidenceType
- presence
- Optional
- Interface version
- 2.0
Type of proof provided by the customer. For example, the merchant gives this information to allow the certification of an electronic signature.
List of values
DRIVING_LICENCE
- Driving license
NATIONAL_ID_CARD
- Identity card
PASSPORT
- Passport
-
fraudData
- presence
- Optional
- Interface version
- 2.0
Contains the transaction’s antifraud rules parameters, allowing the merchant to dynamically customise the rules registered in the merchant configuration.
Contains
-
allowedIpCountryList
- presence
- Optional
- Interface version
- 2.0
List of buyer IP country codes allowed to make a paymentISO 3166 list of country codes.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
deniedIpCountryList
- presence
- Optional
- Interface version
- 2.0
List of buyer IP country codes not authorised to make a paymentISO 3166 list of country codes.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
bypass3DS
- presence
- Optional
- Interface version
- 2.0
Indicator used by the merchant to bypass the 3-D Secure procedure.
List of values
ALL
- Bypass the 3DS procedure (for CB, VISA, MASTERCARD payments)
MERCHANT_WALLET
- Bypass the 3DS procedure during “OneClick” payment for CB, VISA, MASTERCARD payments
WIP_BANCONTACT
- Bypass the 3DS procedure during “OneClick” payment for BANCONTACT payment
-
bypassCtrlList
- presence
- Optional
- Interface version
- 2.0
List of antifraud rules provided by the merchant to bypass current transaction rules.
List of values
3DSStatus
- Disable the 3-D Secure authentication rule
All
- Disable all rules
BlackBic
- Disable the BIC blacklist rule
BlackBinCard
- Disable the BIN range blacklist rule
BlackCard
- Disable the Card number blacklist rule
BlackCustomerId
- Disable the Customer ID blacklist rule
BlackCustomerName
- Disable the Customer name blacklist rule
BlackEmail
- Disable the E-mail address blackslit rule
BlackIban
- Disable the IBAN blacklist rule
BlackIp
- Disable the IP address blacklist rule
BlackMandate
- Disable the Mandate blacklist rule
BlackPhoneNumber
- Disable the Phone number blacklist rule
BlackPostalCode
- Disable the Postal code blacklist rule
CBScheme
- Disable the CB scheme card rule
CapCollarAmount
- Disable the Amount range rule
CardCountry
- Disable the Card country rule
CommercialCard
- Disable the Commercial card (and card country) rule
ECard
- Disable the Virtual card rule
EmailSyntax
- Disable the E-mail address syntax rule
ExpiryDate
- Disable the Card expiry date rule
FreeEmail
- Disable the Free e-mail address rule
GreyBic
- Disable the BIC greylist rule
GreyBinCard
- Disable the BIN range greylist rule
GreyCard
- Disable the Card number greylist rule
GreyCustomerId
- Disable the Customer ID greylist rule
GreyCustomerName
- Disable the Customer name greylist rule
GreyEmail
- Disable the E-mail address greylist rule
GreyIban
- Disable the IBAN greylist rule
GreyIp
- Disable the IP address greylist rule
GreyMandate
- Disable the Mandate greylist rule
GreyPhoneNumber
- Disable the Phone number greylist rule
GreyPostalCode
- Disable the postal code greylist rule
HotList
- Disable the Lost and stolen card rule
IbanCountry
- Disable the IBAN country rule
IpCountry
- Disable the IP address country rule
IpReputations
- Disable the IP address reputation rule
MaxCardPerCustomerId
- Disable the Number of cards per customer rule
MaxCardPerIp
- Disable the Number of cards per IP address rule
MaxCustidPerIban
- Disable the Number of customers per IBAN rule
MaxCustomerIdPerCard
- Disable the Number of customers per card rule
MaxIbanPerCustid
- Disable the Number of IBAN per customer rule
MaxIbanPerIp
- Disable the Number of IBAN per IP address rule
MaxIpPerIban
- Disable the Number of IP address per IBAN rule
MaxMandatePerIp
- Disable the Number of mandates per IP address rule
MaxQuantityPerProduct
- Disable the Product quantity rule
PrepaidCardForbidden
- Disable the prepaid card rule
RiskyProductList
- Disable the Risky product list rule
RiskyProductQuantity
- Disable the Risky product quantity rule
RiskyProductRatio
- Disable the Risky product ratio rule
SimilarityBillingCardCountry
- Disable the Delivery and card country rule
SimilarityDeliveryBillingCountry
- Disable the Delivery and billing country rule
SimilarityDeliveryBillingPostalCode
- Disable the delivery and billing postal code rule
SimilarityDeliveryCardCountry
- Disable the Delivery and card country rule
SimilarityDeliveryIbanCountry
- Disable the Delivery and IBAN country rule
SimilarityIpCardCountry
- Disable the IP and card country rule
SimilarityIpIbanCountry
- Disable the IBAN country rule
SimilarityPhoneIbanCountry
- Disable the Phone and IBAN country rule
SystematicAuthorizationCard
- Disable the Systematic authorisation card rule
VelocityCard
- Disable the Card velocity rule
VelocityCustomerId
- Disable the Customer ID velocity rule
VelocityIban
- Disable the IBAN velocity rule
VelocityIp
- Disable the IP address velocity rule
VelocityMandate
- Disable the Mandate velocity rule
WhiteBic
- Disable the BIC whitelist rule
WhiteBinCard
- Disable the BIN range whitelist rule
WhiteCard
- Disable the Card number whitelist rule
WhiteCustomerId
- Disable the Customer ID whitelist rule
WhiteCustomerName
- Disable the Customer name whitelist rule
WhiteEmail
- Disable the E-mail address whitelist rule
WhiteIban
- Disable the IBAN whitelist rule
WhiteIp
- Disable the IP address whitelist rule
WhiteMandate
- Disable the Mandate whitelist rule
WhitePhoneNumber
- Disable the Phone number whitelist rule
WhitePostalCode
- Disable the Postal code whitelist rule
-
allowedCardArea
- presence
- Optional
- Interface version
- 2.0
List identifier of card countries allowed to make a payment. Countries are grouped by geographical area.
List of values
EEA
- Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
EFTA
- Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
FRJEL
- List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
UEUR
- The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
ZEURO
- Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
-
allowedIpArea
- presence
- Optional
- Interface version
- 2.0
List identifier of IP countries allowed to make a payment.
List of values
EEA
- Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
EFTA
- Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
FRJEL
- List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
UEUR
- The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
ZEURO
- Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
-
deniedCardArea
- presence
- Optional
- Interface version
- 2.0
Identifier of a predefined list of card countries refused by the merchant.
List of values
EEA
- Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
EFTA
- Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
FRJEL
- List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
UEUR
- The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
ZEURO
- Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
-
deniedCardCountryList
- presence
- Optional
- Interface version
- 2.0
List of country codes for cards not authorised to make a payment
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
challengeMode3DS
- presence
- Optional
- Interface version
- 2.21
Holder authentication level requested.
List of values
CHALLENGE
- The merchant desired authentication challenge mode is to have a client authentication. In other words, it is a “challenge” request
CHALLENGE_MANDATE
- The merchant need is to apply the regulatory mode to have a strong customer authentication (for example for the first payment of payment schedule)
NO_CHALLENGE
- The merchant desired authentication challenge mode is to have no customer authentication. In other words, it is a “challenge” request
NO_CHALLENGE_DTA
- The merchant does not want customer authentication in a Direct to Authorize kinematics
NO_CHALLENGE_TRA_ACQ
- The merchant desired no authentication of the cardholder by invoking the TRA acquirer exemption. It’s a request for “Frictionless”.
NO_CHALLENGE_TRA_ACQ_DTA
- The merchant wishes to bypass cardholder authentication by invoking the Acquirer TRA exemption. This is a Direct to Authorize request.
NO_PREFERENCE
- The merchant has no desired authentication challenge mode
-
allowedCardCountryList
- presence
- Optional
- Interface version
- 2.0
List of card country codes allowed to make a payment. ISO 3166 list of country codes.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
addressDeliveryBillingMatchIndicator
- presence
- Optional
- Interface version
- 2.21
Specifies whether the delivery and the billing addresses are the same.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
deniedIpArea
- presence
- Optional
- Interface version
- 2.0
Name of a pre-established list of buyer IP country codes not authorised to make a payment.
List of values
EEA
- Member States in the European Economic Area: AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROM, SVK, SVN, SWE
EFTA
- Member States in the free trade zone (European Free Trade Association): ISL, LIE, NOR, CHE
FRJEL
- List of countries authorised for French online games: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, MLT, NLD, NOR, POL, PRT, ROM, HUN, IRL, ISL, ITA, LTU, LUX, LVA, SVK, SVN, SWE
UEUR
- The Member States in the European Union: AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROM, SVK, SVN, SWE
ZEURO
- Member States in the Eurozone (EMU: Economic and Monetary Union): AUT, BEL, CYP, DEU, ESP, EST, FIN, FRA, GRC, IRL, ITA, LTU, LUX, LVA, MLT, NLD, PRT, SVK, SVN
-
bypassInfoList
- presence
- Optional
- Interface version
- 2.0
List of information provided by the merchant to bypass fraud information.
List of values
Card
- Bypass informations about card
IpCountry
- Bypass all information
-
merchantAuthentScoreValue
- presence
- Optional
- Interface version
- 2.39
Transaction score calculated by the merchant and sent to the Directory Server. Functionality supported by Carte Bancaire only.
-
merchantCustomerAuthentData
- presence
- Optional
- Interface version
- 2.27
Future Use.Additional data provided by the merchant. The information provided depends on the authentication method used.
-
merchantCustomerAuthentDateTime
- presence
- Optional
- Interface version
- 2.27
Date and time in UTC of the cardholder authentication.
-
merchantCustomerAuthentMethod
- presence
- Optional
- Interface version
- 2.23
Authentication method used by the merchant to authenticate the buyer on the point of sale before making the payment.
List of values
FEDERATEDID
- Customer authentication by the merchant using an identifier federated (facebook, …) (e.g. Facebook)
FIDO
- Customer authentication by the merchant with FIDO (Fast IDentity Online) system
ISSUERID
- Customer authentication by the merchant using information of the issuer’s payment mean
NOAUTHENT
- No authentication of the customer by the merchant
OWNCREDENTIAL
- Customer authentication by the merchant using his own system
THIRDPARTY
- Customer authentication by the merchant using a third system
-
nameDeliveryCustomerMatchIndicator
- presence
- Optional
- Interface version
- 2.21
Specifies whether the customer and the delivery names are the same.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
productAvailabilityDate
- presence
- Optional
- Interface version
- 2.27
Availability date of the purchased product.
-
productAvailabilityIndicator
- presence
- Optional
- Interface version
- 2.21
Availability of the goods.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
reorderProductIndicator
- presence
- Optional
- Interface version
- 2.21
Specifies whether the product has been yet ordered.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
riskManagementDynamicSettingList
- presence
- Optional
- Interface version
- 2.0
List of parameters of th setting information related to the antifraud rules to be dynamically overwritten.
Contains
-
riskManagementDynamicSetting
- presence
- Optional
- Interface version
- 2.0
Parameters of the Setting information related to the antifraud rule to be dynamically overwritten.
Contains
-
riskManagementDynamicParam
- presence
- Optional
- Interface version
- 2.0
Parameter regarding the antifraud rule that is to be dynamically overwritten.
List of values
AllowedBillingCardCountryCombiList
- Deprecated value. For the “Billing and card country” rule, the parameter contains the list of the combinations of allowed billing country and card country to overwrite.
AllowedCardCountryList
- Deprecated value. For the “Card country” rule, the parameter contains the list of allowed card countries to overwrite.
AllowedCommercialCardCountryList
- Deprecated value. For “Commercial card (and card country)” rule, the parameter contains the list of allowed commercial card countries to overwrite.
AllowedDeliveryCardCountryCombiList
- Deprecated value. For the “Delivery and card country” rule, the parameter contains the list of the combinations of allowed delivery country and card country to overwrite.
AllowedIpCardCountryCombiList
- Deprecated value. For the “IP and card country” rule, the parameter contains the list of the combinations of allowed card country and IP address country to overwrite.
AllowedIpCountryList
- Deprecated value. For the “IP address country” rule, the parameter contains the list of allowed IP address countries to overwrite.
DeniedBillingCardCountryCombiList
- Deprecated value. For the “Billing and card country” rule, the parameter contains the list of the combinations of denied billing country and card country to overwrite.
DeniedCardCountryList
- Deprecated value. For the “Card country” rule, the parameter contains the list of denied card countries to overwrite.
DeniedCommercialCardCountryList
- Deprecated value. For “Commercial card (and card country)” rule, the parameter contains the list of denied commercial card countries to overwrite.
DeniedDeliveryCardCountryCombiList
- Deprecated value. For the “Delivery and card country” rule, the parameter contains the list of the combinations of denied delivery country and card country to overwrite.
DeniedIpCardCountryCombiList
- Deprecated value. For the “IP and card country” rule, the parameter contains the list of the combinations of denied card country and IP address country to overwrite.
DeniedIpCountryList
- Deprecated value. For the “IP address country” rule, the parameter contains the list of denied IP address countries to overwrite.
NDeniedBillingCardCountryCombiList
- Denied card and billing country combinations list
NDeniedCardCountryList
- Denied card country list
NDeniedCommercialCardCountryList
- Denied corprate card country list
NDeniedDeliveryCardCountryCombiList
- Denied card and delivery country combinations list
NDeniedDeliveryIbanCountryCombiList
- Denied IBAN and delivery country combinations list
NDeniedExceptBillingCardCountryCombiList
- Denied card and billing country combinations except…
NDeniedExceptCardCountryList
- Denied card countries except…
NDeniedExceptCommercialCardCountryList
- Denied corprate card countries except…
NDeniedExceptDeliveryCardCountryCombiList
- Denied card and delivery country combinations except…
NDeniedExceptDeliveryIbanCountryCombiList
- Denied IBAN and delivery country combinations except…
NDeniedExceptIbanCountryList
- Denied IBAN countries except…
NDeniedExceptIpCardCountryCombiList
- Denied card and IP address country combinations except…
NDeniedExceptIpCountryList
- Denied IP address countries except…
NDeniedExceptIpIbanCountryCombiList
- Denied IBAN and IP address country combinations except…
NDeniedExceptPhoneIbanCountryCombiList
- Denied phone number and delivery country combinations except…
NDeniedIbanCountryList
- Denied IBAN country list
NDeniedIpCardCountryCombiList
- Denied card and IP address country combinations list
NDeniedIpCountryList
- Denied IP address country list
NDeniedIpIbanCountryCombiList
- Denied IBAN and IP address country combinations list
NDeniedPhoneIbanCountryCombiList
- Denied phone number and delivery country combinations list
PAllowedBillingCardCountryCombiList
- Encouraged card and billing country combinations list
PAllowedCardCountryList
- Encouraged card country list
PAllowedCommercialCardCountryList
- Encouraged corprate card country list
PAllowedDeliveryCardCountryCombiList
- Encouraged card and delivery country combinations list
PAllowedDeliveryIbanCountryCombiList
- Encouraged IBAN and delivery country combinations list
PAllowedEncouragedIbanCountryList
- Encouraged IBAN country list
PAllowedExceptBillingCardCountryCombiList
- Encouraged card and billing country combinations except…
PAllowedExceptCardCountryList
- Encouraged card countries except…
PAllowedExceptCommercialCardCountryList
- Encouraged corprate card countries except…
PAllowedExceptDeliveryCardCountryCombiList
- Encouraged card and delivery country combinations except…
PAllowedExceptDeliveryIbanCountryCombiList
- Encouraged IBAN and delivery country combinations except…
PAllowedExceptIpCardCountryCombiList
- Encouraged card and IP address country combinations except…
PAllowedExceptIpCountryList
- Encouraged IP address countries except…
PAllowedExceptIpIbanCountryCombiList
- Encouraged IBAN and IP address country combinations except…
PAllowedExceptPhoneIbanCountryCombiList
- Encouraged phone number and delivery country combinations except…
PAllowedIbanCountryList
- Encouraged IBAN countries except…
PAllowedIpCardCountryCombiList
- Encouraged card and IP address country combinations list
PAllowedIpCountryList
- Encouraged IP address country list
PAllowedIpIbanCountryCombiList
- Encouraged IBAN and IP address country combinations list
PAllowedPhoneIbanCountryCombiList
- Encouraged phone number and delivery country combinations list
-
riskManagementDynamicValue
- presence
- Optional
- Interface version
- 2.0
New parameter value regarding to the antifraud rule to be dynamically overwritten.
-
hashAlgorithm1
- presence
- Optional
- Interface version
- 2.0
Cryptographic function used to calculate the hashPan.
List of values
SHA-1
- SHA_1 cryptographic function structure (SHA: secure hash algorithm)
SHA-256
- SHA_256 cryptographic function structure (SHA: secure hash algorithm)
SHA-512
- SHA_512 cryptographic function structure (SHA: secure hash algorithm)
-
hashAlgorithm2
- presence
- Optional
- Interface version
- 2.0
Please see “hashAlgorithm1”.
List of values
SHA-1
SHA-256
SHA-512
-
hashSalt1
- presence
- Optional
- Interface version
- 2.0
Random value (called a seed) provided by the merchant to calculate the hashPan.
-
hashSalt2
- presence
- Optional
- Interface version
- 2.0
Please see “hashSalt1”.
-
holderAdditionalReference
- presence
- Optional
- Interface version
- 2.9
Additional reference of the holder that is communicated to the acquirer system or the issuer system in order to make some additional dedicated checks.
-
holderAddress
- presence
- Optional
- Interface version
- 2.0
Contains the payment mean holder’s address information.
Contains
-
addressAdditional3
- presence
- Optional
- Interface version
- 2.0
Addition 3 to the address.
-
businessName
- presence
- Optional
- Interface version
- 2.17
Business name.
-
country
- presence
- Optional
- Interface version
- 2.0
Country code for the address.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
city
- presence
- Optional
- Interface version
- 2.0
City of the address.
-
company
- presence
- Optional
- Interface version
- 2.0
Company for the address.
-
addressAdditional1
- presence
- Optional
- Interface version
- 2.0
Addition 1 to the address.
-
addressAdditional2
- presence
- Optional
- Interface version
- 2.0
Addition 2 to the address.
-
postBox
- presence
- Optional
- Interface version
- 2.0
Post box for the address.
-
state
- presence
- Optional
- Interface version
- 2.0
Address state/department. To be completed in accordance with ISO 3166-2. The first two letters designate the country and the letters following the hyphen designate the subdivision, e.g. FR-ARA for the French region Auvergne-Rhône-Alpes.
-
street
- presence
- Optional
- Interface version
- 2.0
Name of the street of the address.
-
streetNumber
- presence
- Optional
- Interface version
- 2.0
Number of the street of the address.
-
zipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the address.
-
holderContact
- presence
- Optional
- Interface version
- 2.0
Contains contact details of the payment mean holder.
Contains
-
email
- presence
- Optional
- Interface version
- 2.0
Contact’s email address.
-
firstname
- presence
- Optional
- Interface version
- 2.0
First name of the contact.
-
gender
- presence
- Optional
- Interface version
- 2.0
Gender of the contact, male (=M) or female (=F).
-
initials
- presence
- Optional
- Interface version
- 2.11
contact initals
-
lastname
- presence
- Optional
- Interface version
- 2.0
Last name of the contact.
-
legalId
- presence
- Optional
- Interface version
- 2.17
Legal business identifier (SIRET in France). This field is applicable for merchant or customer (please see fields Contact).
-
mobile
- presence
- Optional
- Interface version
- 2.0
Mobile phone number for the contact.
-
phone
- presence
- Optional
- Interface version
- 2.0
Telephone number for the contact.
-
positionOccupied
- presence
- Optional
- Interface version
- 2.17
Position occupied.
-
title
- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone
- presence
- Optional
- Interface version
- 2.21
Holder’s business phone number.
-
holderData
- presence
- Optional
- Interface version
- 2.6
Contains the payment mean holder’s information.
Contains
-
birthCity
- presence
- Optional
- Interface version
- 2.0
Birthplace.
-
birthCountry
- presence
- Optional
- Interface version
- 2.0
Country of birth.
-
birthZipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the birth.
-
birthDate
- presence
- Optional
- Interface version
- 2.0
Date of birth.
-
loyaltyIndicator
- presence
- Optional
- Interface version
- 3.2
Specifies whether the client is a regular client.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
maidenName
- presence
- Optional
- Interface version
- 2.18
Maiden name.
-
nationalityCountry
- presence
- Optional
- Interface version
- 2.0
Country of nationality.
-
newPassword
- presence
- Optional
- Interface version
- 2.0
Customer’s new password.
-
password
- presence
- Optional
- Interface version
- 2.0
Password.
-
instalmentData
- presence
- Optional
- Interface version
- 2.0
Contains the information making it possible to make a payment in instalments.
Contains
-
datesList
- presence
- Optional
- Interface version
- 2.0
List of the dates of occurrences for payment in instalments.
-
amountsList
- presence
- Optional
- Interface version
- 2.0
List of amounts for the occurrences for payment in instalments.The amount is transmitted in the smallest currency unit:For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.
-
number
- presence
- Optional
- Interface version
- 2.0
Number of occurrences for payment in instalments.
-
s10TransactionIdsList
- presence
- Optional
- Interface version
- 2.7
List of alternative identifiers for the transaction of occurrences for payment in instalments, to be compliant with Sogenactif 1.0.As part of payment in several times, it is the list of due dates of the payment in instalments.
-
transactionReferencesList
- presence
- Optional
- Interface version
- 2.0
List of references for the transaction of occurrences for payment in instalments.
-
interfaceVersionAutomaticResponse
- presence
- Optional
- Interface version
- 3.0
Automatic response version.
- Version syntax for Sogenactif Paypage with prefix AR_HP_ or AR_JS and version 2.x or 2x (example AR_HP_2.45 or AR_HP_245) or 3.x or 3x (example AR_JS_3.0 or AR_JS_30)
- Version syntax for Sogenactif Walletpage with prefix ARWI_HP or ARWI_JS and version 2.x or 2x (example ARWI_HP_2.4 or ARWI_HP_24) or 3.x or 3x (example ARWI_JS_3.0 or ARWI_JS_30).
-
interfaceVersionNormalResponse
- presence
- Optional
- Interface version
- 3.0
Manual response version.
- Version syntax for Sogenactif Paypage with prefix MR_HP_ or MR_JS and version 2.x or 2x (example MR_HP_2.45 or MR_HP_245) or 3.x or 3x (example MR_JS_3.0 or MR_JS_30)
- Version syntax for Sogenactif Walletpage with prefix MRWI_HP or MRWI_JS and version 2.x or 2x (example MRWI_HP_2.4 or MRWI_HP_24) or 3.x or 3x (example MRWI_JS_3.0 or MRWI_JS_30).
-
intermediateServiceProviderId
- presence
- Optional
- Interface version
- 2.10
Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
-
invoiceReference
- presence
- Optional
- Interface version
- 2.0
Invoice reference.
-
mandateId
- presence
- Optional
- Interface version
- 2.0
Mandate number.
-
merchantLocationId
- presence
- Optional
- Interface version
- 2.49
Merchant data identifying the location of his shop.
-
merchantName
- presence
- Optional
- Interface version
- 2.23
Merchant name (equivalent to the Merchant name registered during the Shop enrollment).If indicated in the payment request, allows to change the name displayed on the 3-D Secure authentication page.
-
merchantSessionId
- presence
- Optional
- Interface version
- 2.0
Merchant’s session number. Allows consolidation between requests and responses.
-
merchantTransactionDateTime
- presence
- Optional
- Interface version
- 2.0
Date and time of the transaction, set by the merchant at the merchant’s local time (in the merchant’s time zone)
-
merchantUrl
- presence
- Optional
- Interface version
- 2.29
Merchant web site URL.
-
merchantWalletId
- presence
- Optional
- Interface version
- 2.0
Customer’s Wallet identifier.
-
orderContext
- presence
- Optional
- Interface version
- 2.16
Contains specific information regarding the order context
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
Contains
-
customerBrowserType
- presence
- Optional
- Interface version
- 2.16
Browser type used by the customer. Example: Mozilla, AOL Explorer 9.5, MSN IE 9, MSN IE 10, MSN IE 11, etc …
-
customerANI
- presence
- Optional
- Interface version
- 2.16
Phone number that customer used to checkout captured automatically by the merchant.
-
customerANIInformationIdentifier
- presence
- Optional
- Interface version
- 2.16
Telephone company provided ANI Information Identifier associated with customerANI and it indicates call type. For example: cellular (61-63), payphone (27), toll free (24, 25), etc.
-
merchantOrderSpecificDataList
- presence
- Optional
- Interface version
- 2.38
List of merchantOrderSpecificData objects. This list is limited to 20 items.
Contains
-
merchantOrderSpecificData
- presence
- Optional
- Interface version
- 2.38
Contains the specific information of an order which can be transmitted to the acquirer according to the means of payment.
Contains
-
merchantOrderSpecificDataReference
- presence
- Optional
- Interface version
- 2.38
Reference of the specific order data (the accepted values depend on the means of payment).
-
merchantOrderSpecificDataType
- presence
- Optional
- Interface version
- 2.38
Type of the specific order data (the accepted values depend on the means of payment).
-
merchantOrderSpecificDataValue
- presence
- Optional
- Interface version
- 2.38
Value of the specific order data.
-
customerHostName
- presence
- Optional
- Interface version
- 2.16
Name of server to which customer is connected. Example: PHX.QW.AOL.COM.
-
orderId
- presence
- Optional
- Interface version
- 2.0
Order number associated with the payment transaction.
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
-
paymentMeanBrandList
- presence
- Optional
- Interface version
- 2.0
List of payment methods accepted for a transaction. If this field is not filled out, the Sogenactif server recovers the list of payment methods available for the configuration of the shop.
List of values
1EUROCOM
- Cofidis Pay 5x10x20x paymentMeanBrandType: ONLINE_CREDIT
3XCBCOFINOGA
- Deprecated. Cofinoga 3xCB paymentMeanBrandType: CARD
ACCEPTGIRO
- AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
ACCORD_3X
- Facily Pay 3 X payment paymentMeanBrandType: ONLINE_CREDIT
ACCORD_4X
- Facily Pay 4 X payment paymentMeanBrandType: ONLINE_CREDIT
AIRPLUS
- Airplus card paymentMeanBrandType: CARD
AIRPLUS_LOGEE
- Airplus logee card paymentMeanBrandType: CARD
AMEX
- American Express card paymentMeanBrandType: CARD
AMEX_LOGEE
- American Express logee card paymentMeanBrandType: CARD
APPLEPAY
- Apple Pay paymentMeanBrandType : CARD
AURORE
- CPAY card paymentMeanBrandType : CARD
BCACB_3X
- Floa Bank CB 3 X payment paymentMeanBrandType: ONLINE_CREDIT
BCACB_4X
- Floa Bank CB 4 X payment paymentMeanBrandType: ONLINE_CREDIT
BCACUP
- CUP card issued by Floa Bank paymentMeanBrandType: CARD
BCMC
- Bancontact paymentMeanBrandType: CARD
CACF_3X
- CACF 3 X payment paymentMeanBrandType: ONLINE_CREDIT
CACF_4X
- CACF 4 X payment paymentMeanBrandType: ONLINE_CREDIT
CADHOC
- Cadhoc paymentMeanBrandType: CARD
CADOCARTE
- Cado Carte paymentMeanBrandType: CARD
CB
- Carte Bancaire paymentMeanBrandType: CARD
CETELEM_3X
- Cetelem 3xCB paymentMeanBrandType: ONLINE_CREDIT
CETELEM_4X
- Cetelem 4xCB paymentMeanBrandType: ONLINE_CREDIT
COFIDIS_3X
- Cofidis 3xCB paymentMeanBrandType: ONLINE_CREDIT
COFIDIS_4X
- Cofidis 4xCB paymentMeanBrandType: ONLINE_CREDIT
CONECS
- Titres Restaurants Dématérialisés Conecs paymentMeanBrandType: VOUCHER
CUP
- China UnionPay card paymentMeanBrandType: CARD
CVA
- Visa Aurore card paymentMeanBrandType: CARD
CVCO
- Chèque-Vacances Connect paymentMeanBrandType: VOUCHER
DINERS
- Diners club international card paymentMeanBrandType: CARD
FRANFINANCE_3X
- Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
FRANFINANCE_4X
- Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
GIROPAY
- Giropay paymentMeanBrandType: CREDIT_TRANSFER
GOOGLEPAY
- Google Pay paymentMeanBrandType : CARD
ILLICADO
- Illicado paymentMeanBrandType: CARD
INCASSO
- Incasso paymentMeanBrandType: DIRECT_DEBIT
INGHOMEPAY
- PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER
JCB
- Japan Credit Bureau card paymentMeanBrandType: CARD
LEPOTCOMMUN
- Le Pot Commun paymentMeanBrandType: CARD
LYDIA
- Lydia paymentMeanBrandType: PROVIDER
MAESTRO
- Carte Maestro (Mastercard) paymentMeanBrandType: CARD
MASTERCARD
- Mastercard card paymentMeanBrandType: CARD
MASTERPASS
- Deprecated - MasterPass electronic wallet paymentMeanBrandType: WALLET
ONEY34X
- Oney Paiement 3 or 4 X payment paymentMeanBrandType: ONLINE_CREDIT
PAYLIB
- Paylib electronic wallet paymentMeanBrandType: WALLET
PAYPAL
- Paypal paymentMeanBrandType: WALLET
PAYTRAIL
- Paytrail paymentMeanBrandType: CREDIT_TRANSFER
PAY_BY_BANK
- SEPA credit transfer paymentMeanBrandType: CREDIT_TRANSFER
SAMSUNGPAY
- Samsung Pay paymentMeanBrandType : CARD
SEPA_DIRECT_DEBIT
- SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT
SOFINCO
- Sofinco card paymentMeanBrandType: CARD
UNKNOWN
- Unknown
VISA
- Visa card paymentMeanBrandType: CARD
VISACHECKOUT
- Deprecated - Visa Checkout electronic wallet paymentMeanBrandType: WALLET
VISA_ELECTRON
- Visa Electron card paymentMeanBrandType: CARD
VPAY
- VPAY card (Visa) paymentMeanBrandType: CARD
-
paymentMeanData
- presence
- Optional
- Interface version
- 2.0
Contains specific information regarding the payment method used by the buyer.
Contains
-
a2a
- presence
- Optional
- Interface version
- 3.4
Contains specific information for Account 2 Account payment method.
Contains
-
settlementMode
- presence
- Optional
- Interface version
- 3.4
Settlement mode chosen by the buyer. The values of this field should be acquirer’s native codes. Any convertion is done by Sogenactif.
-
bcacb3x
- presence
- Optional
- Interface version
- 2.24
Contains specific information on the CB3X means of payment from Floa Bank.
Contains
-
agencyCode
- presence
- Optional
- Interface version
- 2.24
Identifier of the agency provided by the merchant.
-
challengeMode3DS
- presence
- Optional
- Interface version
- 2.21
Holder authentication level requested.
List of values
CHALLENGE
- The merchant desired authentication challenge mode is to have a client authentication. In other words, it is a “challenge” request
CHALLENGE_MANDATE
- The merchant need is to apply the regulatory mode to have a strong customer authentication (for example for the first payment of payment schedule)
NO_CHALLENGE
- The merchant desired authentication challenge mode is to have no customer authentication. In other words, it is a “challenge” request
NO_CHALLENGE_DTA
- The merchant does not want customer authentication in a Direct to Authorize kinematics
NO_CHALLENGE_TRA_ACQ
- The merchant desired no authentication of the cardholder by invoking the TRA acquirer exemption. It’s a request for “Frictionless”.
NO_CHALLENGE_TRA_ACQ_DTA
- The merchant wishes to bypass cardholder authentication by invoking the Acquirer TRA exemption. This is a Direct to Authorize request.
NO_PREFERENCE
- The merchant has no desired authentication challenge mode
-
numberOfCapturedTransaction
- presence
- Optional
- Interface version
- 2.24
Number of transactions captured over the last period. This period is defined by the acquirer of the means of payment. This data provided by the merchant is used for the 3-D Secure authentication check.
-
numberOfRejectedTransaction
- presence
- Optional
- Interface version
- 2.24
Number of transactions refused over the last period. This period is defined by the acquirer of the means of payment. This data provided by the merchant is used for the 3-D Secure authentication check.
-
franfinance3xcb
- presence
- Optional
- Interface version
- 2.18
Contains the information related to franfinance3xcb.
Contains
-
birthPlaceCode
- presence
- Optional
- Interface version
- 2.18
Place of birth code filled by Franfinance in its own codification.
-
conversionCurrency
- presence
- Optional
- Interface version
- 2.26
Currency requested by the merchant to be displayed on Franfinance pages.
-
convertedAmount
- presence
- Optional
- Interface version
- 2.26
Amount requested by the merchant to be displayed on Franfinance pages.
-
authenticationKey
- presence
- Optional
- Interface version
- 2.18
Authentication data provided by the merchant for Franfinance payment.
-
pageCustomizationCode
- presence
- Optional
- Interface version
- 2.18
Code provided by Franfinance, allowing to customize the screens in the colors of the partner.
-
redirectionTimer
- presence
- Optional
- Interface version
- 2.18
Beyond this period, at the end of the payment process on the Franfinance page, the user will be automatically redirected to the merchant site. It must be less than 300 seconds.seconds.
-
testEnvironment
- presence
- Optional
- Interface version
- 2.18
Choice of the testing environment of Franfinance.
-
franfinance4xcb
- presence
- Optional
- Interface version
- 2.18
Contains the information related to franfinance4xcb.
Contains
-
birthPlaceCode
- presence
- Optional
- Interface version
- 2.18
Place of birth code filled by Franfinance in its own codification.
-
conversionCurrency
- presence
- Optional
- Interface version
- 2.26
Currency requested by the merchant to be displayed on Franfinance pages.
-
convertedAmount
- presence
- Optional
- Interface version
- 2.26
Amount requested by the merchant to be displayed on Franfinance pages.
-
authenticationKey
- presence
- Optional
- Interface version
- 2.18
Authentication data provided by the merchant for Franfinance payment.
-
pageCustomizationCode
- presence
- Optional
- Interface version
- 2.18
Code provided by Franfinance, allowing to customize the screens in the colors of the partner.
-
redirectionTimer
- presence
- Optional
- Interface version
- 2.18
Beyond this period, at the end of the payment process on the Franfinance page, the user will be automatically redirected to the merchant site. It must be less than 300 seconds.seconds.
-
testEnvironment
- presence
- Optional
- Interface version
- 2.18
Choice of the testing environment of Franfinance.
-
bcacb4x
- presence
- Optional
- Interface version
- 2.24
Contains specific information on the CB4X means of payment from Floa Bank.
Contains
-
agencyCode
- presence
- Optional
- Interface version
- 2.24
Identifier of the agency provided by the merchant.
-
challengeMode3DS
- presence
- Optional
- Interface version
- 2.21
Holder authentication level requested.
List of values
CHALLENGE
- The merchant desired authentication challenge mode is to have a client authentication. In other words, it is a “challenge” request
CHALLENGE_MANDATE
- The merchant need is to apply the regulatory mode to have a strong customer authentication (for example for the first payment of payment schedule)
NO_CHALLENGE
- The merchant desired authentication challenge mode is to have no customer authentication. In other words, it is a “challenge” request
NO_CHALLENGE_DTA
- The merchant does not want customer authentication in a Direct to Authorize kinematics
NO_CHALLENGE_TRA_ACQ
- The merchant desired no authentication of the cardholder by invoking the TRA acquirer exemption. It’s a request for “Frictionless”.
NO_CHALLENGE_TRA_ACQ_DTA
- The merchant wishes to bypass cardholder authentication by invoking the Acquirer TRA exemption. This is a Direct to Authorize request.
NO_PREFERENCE
- The merchant has no desired authentication challenge mode
-
numberOfCapturedTransaction
- presence
- Optional
- Interface version
- 2.24
Number of transactions captured over the last period. This period is defined by the acquirer of the means of payment. This data provided by the merchant is used for the 3-D Secure authentication check.
-
numberOfRejectedTransaction
- presence
- Optional
- Interface version
- 2.24
Number of transactions refused over the last period. This period is defined by the acquirer of the means of payment. This data provided by the merchant is used for the 3-D Secure authentication check.
-
passbe
- presence
- Optional
- Interface version
- 2.0
Contains specific information on Passbe payment method (Card PASS in Belgium).
Contains
-
settlementModeList
- presence
- Optional
- Interface version
- 2.0
List of settlement mode allowed by the merchant. The values of this field should be acquirer’s native codes. Any convertion is done by Sogenactif.
-
oneyPaylater
- presence
- Optional
- Interface version
- 2.46
Specific information about the payment means Oney Paylater.
Contains
-
settlementMode
- presence
- Optional
- Interface version
- 3.4
Settlement mode chosen by the buyer. The values of this field should be acquirer’s native codes. Any convertion is done by Sogenactif.
-
cetelem3x
- presence
- Optional
- Interface version
- 2.15
Contains dedicated data of a Cetelem 3xCB payment.
Contains
-
cetelemPrivateData
- presence
- Optional
- Interface version
- 2.15
Specific private data regarding the transaction exchanged between the merchant and Cetelem.
-
cetelemPrivateMerchantData
- presence
- Optional
- Interface version
- 2.15
Specific merchant data provided by the merchant to be sent to Cetelem.
-
cetelem4x
- presence
- Optional
- Interface version
- 2.15
Contains dedicated data of a Cetelem 4xCB payment.
Contains
-
cetelemPrivateData
- presence
- Optional
- Interface version
- 2.15
Specific private data regarding the transaction exchanged between the merchant and Cetelem.
-
cetelemPrivateMerchantData
- presence
- Optional
- Interface version
- 2.15
Specific merchant data provided by the merchant to be sent to Cetelem.
-
cofidis4x
- presence
- Optional
- Interface version
- 2.0
Contains specific information on Cofidis 4xCB payment method.
Contains
-
cofidisDisplayCancelButton
- presence
- Optional
- Interface version
- 2.0
Information displaying a “Cancel” button (or link) on the 3xCB payment pages hosted by Cofidis.
-
cofidisPrivateData
- presence
- Optional
- Interface version
- 2.0
Specific data exchanged between the merchant and Cofidis.
-
preScoreValue
- presence
- Optional
- Interface version
- 2.0
Value of the score Pre-authentication computed by the Fraud engine in Business Score mode.
-
cofidis3x
- presence
- Optional
- Interface version
- 2.0
Contains specific information on Cofidis 3xCB payment method.
Contains
-
basket
- presence
- Optional
- Interface version
- 2.20
Content of the customer’s basket.
-
cofidisDisplayCancelButton
- presence
- Optional
- Interface version
- 2.0
Information displaying a “Cancel” button (or link) on the 3xCB payment pages hosted by Cofidis.
-
cofidisPrivateData
- presence
- Optional
- Interface version
- 2.0
Specific data exchanged between the merchant and Cofidis.
-
preScoreValue
- presence
- Optional
- Interface version
- 2.0
Value of the score Pre-authentication computed by the Fraud engine in Business Score mode.
-
cofinoga3xcb
- presence
- Optional
- Interface version
- 2.0
Depreciated data. Contains specific information on Cofinoga 3xCB payment method.
Contains
-
creditIndicator
- presence
- Optional
- Interface version
- 2.0
Credit indicator specifies the choice of payment by the holder or commercial operation of the acceptor
-
cofinoga
- presence
- Optional
- Interface version
- 2.14
Depreciated data. Contains specific information on Cofinoga payment method.
Contains
-
paymentMeanTradeOptionList
- presence
- Optional
- Interface version
- 2.14
List of trade terms per payment method and trade partner.
Contains
-
paymentMeanTradeOption
- presence
- Optional
- Interface version
- 2.14
Trade terms of the payment method and the trade partner.
Contains
-
paymentMeanTradingName
- presence
- Optional
- Interface version
- 2.14
Trading name of the partner merchant accepting with the payment method. For example, for a privative card, indicates the brand to which the card is “cobranded”.
-
settlementModeList
- presence
- Optional
- Interface version
- 2.0
List of settlement mode allowed by the merchant. The values of this field should be acquirer’s native codes. Any convertion is done by Sogenactif.
-
oney34x
- presence
- Optional
- Interface version
- 2.29
Specific information about the payment means Oney payment in three times or payment in four times.
Contains
-
settlementMode
- presence
- Optional
- Interface version
- 3.4
Settlement mode chosen by the buyer. The values of this field should be acquirer’s native codes. Any convertion is done by Sogenactif.
-
bancontact
- presence
- Optional
- Interface version
- 2.38
Contains specific information on the bancontact payment method.
Contains
-
bancontactMerchantCustomerAuthenticationMethod
- presence
- Optional
- Interface version
- 2.38
Customer authentication method used by the merchant at the point of sale.
-
paypal
- presence
- Optional
- Interface version
- 2.0
Contains specific information on PayPal payment method.
Contains
-
orderDescription
- presence
- Optional
- Interface version
- 2.16
Order description of purchased items.
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
-
dupDesc
- presence
- Optional
- Interface version
- 2.0
Description of the reason for PayPal duplication, possible when dupFlag is set to “true”. Shown to the Internet user on their PayPal account in the transaction details.
-
invoiceId
- presence
- Optional
- Interface version
- 2.0
Order number, same as the orderId but with PayPal, it must be unique. Mandatory in order to use PayPal.
-
addrOverride
- presence
- Optional
- Interface version
- 2.0
Indicator allowing the merchant to display the delivery address on PayPal pages. This indicator allows to override the address present in the PayPal account if necessary.
List of values
NO_DISPLAY
- No address is displayed, the address sent by the merchant is not taken into account by PayPal. It is the default value
NO_OVERRIDE
- PayPal displays the address the Internet user registered with PayPal
OVERRIDE
- PayPal displays the address communicated by the merchant, the address the Internet user registered with PayPal is deleted
-
mobile
- presence
- Optional
- Interface version
- 2.0
Mobile phone number for the contact.
-
dupFlag
- presence
- Optional
- Interface version
- 2.0
Indicator allowing the PayPal transaction to be duplicated. “false” default value (cannot be duplicated).
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
dupCustom
- presence
- Optional
- Interface version
- 2.0
Paypal Field left free for the merchant, taken into account when dupFlag is set to “true”
-
dupType
- presence
- Optional
- Interface version
- 2.0
Paypal Duplication type. This optional information is taken into account when dupFlag is “true”.
List of values
ANY
- Duplication type: several
INSTANTONLY
- Duplication type: one
-
landingPage
- presence
- Optional
- Interface version
- 2.0
Indicator allowing the merchant to hide the subscription form on PayPal pages. “false” is the default value.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
presto
- presence
- Optional
- Interface version
- 2.0
Contains specific information on Presto Plus payment method.
Contains
-
paymentMeanCustomerId
- presence
- Optional
- Interface version
- 2.0
Client’s reference used for the payment method. Currently, this reference is used only for Presto.
-
financialProduct
- presence
- Optional
- Interface version
- 2.0
Financial product chosen by the buyer. To fill with “CLA”.
-
prestoCardType
- presence
- Optional
- Interface version
- 2.0
Card type used for Presto Plus if the buyer has chosen a financial product with opening revolving card account.
-
sdd
- presence
- Optional
- Interface version
- 2.0
Contains specific information on SDD payment method.
Contains
-
mandateAuthentMethod
- presence
- Optional
- Interface version
- 2.0
Type of signature used for the creation of the mandate.
List of values
MAIL_OTP
- Authentication by SMS
SMS_OTP
- Authentication by eMail
-
mandateUsage
- presence
- Optional
- Interface version
- 2.0
Type of mandate used.
List of values
ONE_OFF
- Single use mandate
RECURRENT
- Recurring use mandate
-
mandateCertificationType
- presence
- Optional
- Interface version
- 2.0
Mandate signature certification type.
List of values
E_BASIC
- Electronic signature not certified. If the mandate is an E_BASIC one, the merchant didn’t proof that he has a sufficient knowledge of his client allowing him to be sure that the client is the one that he claims to be when he creates his mandate. The client can oppose the validity of the mandate.
-
unEuroCom
- presence
- Optional
- Interface version
- 2.0
Contains specific information on Cofidis Pay 5x10x20x payment method.
Contains
-
cofidisPrivateData
- presence
- Optional
- Interface version
- 2.0
Specific data exchanged between the merchant and Cofidis.
-
basket
- presence
- Optional
- Interface version
- 2.20
Content of the customer’s basket.
-
preScoreValue
- presence
- Optional
- Interface version
- 2.0
Value of the score Pre-authentication computed by the Fraud engine in Business Score mode.
-
paypageData
- presence
- Optional
- Interface version
- 2.11
Contains the parameters for the payment pages, allowing the merchant to dynamically customise the options on payment pages.
Contains
-
bypassReceiptPage
- presence
- Optional
- Interface version
- 2.0
Flag indicating that Sogenactif must not issue the ticket receipt. This action is at charge of the trader. At the end of the payment, the customer is directly redirected to the response url from the shop (normalReturnUrl).
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
responseEncoding
- presence
- Optional
- Interface version
- 2.19
Encoding type of the response expected by the merchant.
List of values
base64
- Encoding in base64
base64Url
- Encoding in base64 including a list of special characters
-
responseKeyVersion
- presence
- Optional
- Interface version
- 2.0
Identifier of the merchant’s secret key used to calculate the imprint of the response.
-
returnContext
- presence
- Optional
- Interface version
- 2.0
Context of a buyer’’s order.All information transmitted in this field by the merchant during the payment request is sent back in the response without amendment.Attention : the following characters “|”, “«”, “»”, and «”» are not recommended in this field. If they are used, they will be returned as provided but they will be replaced by blanks in the Sogenactif database.
Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data
As a subcontractor, SG processes personal data in accordance with the Data Processing Agreement (DPA), appended to all contracts.
Thus:
- The personal data specified in the DPA must only be transmitted to SG via the fields provided for this purpose (see data dictionary).
- All other personal data not listed in the DPA must not be transmitted to SG.
-
riskManagementCustomData
- presence
- Optional
- Interface version
- 2.9
Merchant privative information transmitted by the a Business Score scoring system. To know the use of this data, please contact your contact at the the Business Score scoring system.
Contains
-
riskManagementCustomSequence
- presence
- Optional
- Interface version
- 2.9
Sequence number of the merchant privative data transmitted to the external scoring manager. To know the use of this data, please contact your contact at the the Business Score scoring system.
-
riskManagementCustomValue
- presence
- Optional
- Interface version
- 2.9
Value of the merchant privative data transmitted to the external scoring manager. To know the use of this data, please contact your contact at the the Business Score scoring system.
-
riskManagementCustomDataList
- presence
- Optional
- Interface version
- 2.9
List of merchant privative information transmitted by the a Business Score scoring system. This list is limited to 25 items.
Contains
-
riskManagementCustomData
- presence
- Optional
- Interface version
- 2.9
Merchant privative information transmitted by the a Business Score scoring system. To know the use of this data, please contact your contact at the the Business Score scoring system.
Contains
-
riskManagementCustomSequence
- presence
- Optional
- Interface version
- 2.9
Sequence number of the merchant privative data transmitted to the external scoring manager. To know the use of this data, please contact your contact at the the Business Score scoring system.
-
riskManagementCustomValue
- presence
- Optional
- Interface version
- 2.9
Value of the merchant privative data transmitted to the external scoring manager. To know the use of this data, please contact your contact at the the Business Score scoring system.
-
s10TransactionReference
- presence
- Optional
- Interface version
- 2.7
Contains the identification of the transaction (to be compliant with Sogenactif 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.
Contains
-
s10TransactionId
- presence
- Optional
- Interface version
- 2.7
- Format
-
N6Any character is accepted
The merchant can choose between transactionId and transactionReference (by default) to identify his transactions.s10TransactionId is an alternative identifier for the transaction to be compliant with Sogenactif 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.
-
s10TransactionIdDate
- presence
- Optional
- Interface version
- 2.7
Date of the transaction (expressed in the Sogenactif server time zone).The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction 1.0.The use of this couple instead of transactionReference depends on an option in the merchant configuration.
-
sealAlgorithm
- presence
- Optional
- Interface version
- 2.10
Algorithm applied to calculate the seal encryption.
List of values
HMAC-SHA-256
- The encryption algorithm applied is HMAC-SHA-256
HMAC-SHA-512
- The encryption algorithm applied is HMAC-SHA-512
SHA-256
- The encryption algorithm applied is SHA-256
-
shoppingCartDetail
- presence
- Optional
- Interface version
- 2.6
Information specific to the basket.
Contains
-
mainProductCategoryList
- presence
- Optional
- Interface version
- 2.24
List of product categories of each level of the product nomenclature used by the merchant. Example: Electrical equipment, household appliances, other electrothermal appliances.
-
giftCardAmount
- presence
- Optional
- Interface version
- 2.27
For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units. Example: gift card amount is USD 123.45. Values accepted:123 0123 00123.
-
giftCardCurrencyCode
- presence
- Optional
- Interface version
- 2.27
For prepaid or gift card purchase, ISO 4217 threedigit currency code of the gift card.
List of values
032
- Argentinean Peso
036
- Australian Dollar
048
- Bahrain Dinar
116
- Cambodian Riel
124
- Canadian Dollar
144
- Sri Lanka Rupee
156
- China Yuan Renminbi
191
- Croatia Kuna
203
- Czech Republic Koruna
208
- Danes crown
344
- Hong Kong dollar
348
- Hungary Forint
352
- Iceland Rupee
356
- Indian rupee
376
- Israel Shekel
392
- Japanese Yen
410
- South Korean Won
414
- Kuwait Dinar
458
- Malaysia Ringgit
480
- Mauritius Rupee
484
- Mexican Peso
524
- Nepal Rupee
554
- New Zealand Dollar
578
- Norwegian crown
634
- Qatar Riyal
643
- Russia Ruble
682
- Saudi Arabia Riyal
702
- Singapore Dollar
710
- South Africa Rand
752
- Swedish crown
756
- Swiss Franc
764
- Thailand Baht
784
- United Arab Emirates Dirham
788
- Tunisia Dinar
826
- Pound
840
- American Dollar
901
- Taiwan Dollar
941
- Serbian Dinar
946
- Roumania New Leu
949
- New Turkish Lira
952
- CFA Franc
953
- CFP Franc
975
- Bulgaria Lev
978
- Euro
980
- Ukraine Hryvnia
985
- Poland Zloty
986
- Brazilian Real
-
discountAmount
- presence
- Optional
- Interface version
- 2.24
Total amount of discounts associated with the order.
-
mainProduct
- presence
- Optional
- Interface version
- 2.6
The most expensive product in the shopping cart.
-
giftCardCount
- presence
- Optional
- Interface version
- 2.27
For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
-
shoppingCartItemList
- presence
- Optional
- Interface version
- 2.6
List of items in the basket. This list is limited to 300 products (maximum number of shoppingCartItem occurrences).
Contains
-
shoppingCartItem
- presence
- Optional
- Interface version
- 2.6
Information specific to an item of the basket.
Contains
-
productName
- presence
- Optional
- Interface version
- 2.6
Name of the ordered product.
-
productUnitTaxAmount
- presence
- Optional
- Interface version
- 2.6
Monetary value of the tax for the product (unit). The amount must be transmitted in the smallest unit of currency.
-
productDescription
- presence
- Optional
- Interface version
- 2.6
Detailed description of the ordered product.
-
productSKU
- presence
- Optional
- Interface version
- 2.6
Merchant’s product identifier code, sent back in the response without modification.
-
productQuantity
- presence
- Optional
- Interface version
- 2.6
Quantity of products in the shopping cart.
-
productTaxRate
- presence
- Optional
- Interface version
- 2.6
Tax rate for the product. For decimal numbers, use a dot instead of a comma (eg. 0.1999).
-
productUnitAmount
- presence
- Optional
- Interface version
- 2.6
Unit amount of the product. The amount must be transmitted in the smallest unit of currency.
-
productCode
- presence
- Optional
- Interface version
- 2.6
Code of the ordered product.
-
productCategory
- presence
- Optional
- Interface version
- 2.6
Category of the ordered product (for example digital).
-
productTaxCategory
- presence
- Optional
- Interface version
- 2.6
Future Use.Tax category for the product (eg. 1:High, 2:Low, …).
-
travelData
- presence
- Optional
- Interface version
- 2.38
Contains specific information regarding the travel.
Contains
-
travelCardPeriod
- presence
- Optional
- Interface version
- 2.38
Duration of the subscription card.
-
journeyDataList
- presence
- Optional
- Interface version
- 2.38
List of container journeyData. This list is limited to 25 items.
Contains
-
journeyData
- presence
- Optional
- Interface version
- 2.38
Contains trip information.
Contains
-
journeyAmount
- presence
- Optional
- Interface version
- 2.41
Journey amount.
-
carrierIdentifier
- presence
- Optional
- Interface version
- 2.38
Identifier of the carrier.
-
classLevel
- presence
- Optional
- Interface version
- 2.38
Class level of the trip.
-
departureDateTime
- presence
- Optional
- Interface version
- 2.38
Departure date of the trip.
-
arrivalLocation
- presence
- Optional
- Interface version
- 2.38
Arrival place of the journey.
-
destinationCountry
- presence
- Optional
- Interface version
- 2.38
Country of destination of the journey.
-
fareBasis
- presence
- Optional
- Interface version
- 2.16
Fare Basis. Example: business class, economy class, …
-
carrierName
- presence
- Optional
- Interface version
- 2.38
The carrier’s name.
-
journeyCancellableIndicator
- presence
- Optional
- Interface version
- 2.38
Trip cancellation / modification option indicator.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
departureLocation
- presence
- Optional
- Interface version
- 2.38
Place of departure of the journey.
-
journeyInsurance
- presence
- Optional
- Interface version
- 2.38
Insurance taken out for the trip.
-
journeyInsuranceIndicator
- presence
- Optional
- Interface version
- 2.38
Trip indicator with insurance.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
journeyModality
- presence
- Optional
- Interface version
- 2.38
Method of borrowing the trip.
List of values
FEE
- Service fee
MULTIPLE
- Multi stop journey
ONEWAY
- One way ticket
OTHER_CANCELLATION
- Cancellation of an additional purchase of a service linked to the journey
PURCHASING
- Additional purchase of a service linked to the journey
RESERVATION
- Journey reservation
ROUTING_INFORMATION
- Information related to the journey steps
TICKET_CANCELLATION
- Ticket cancellation
TWOWAY
- Round journey
-
journeyMode
- presence
- Optional
- Interface version
- 2.38
Mode of transport of the trip.
List of values
AIR
- Airline
CRUISE
- Cruise
RAIL
- Railway
RENTAL
- Car rental
-
journeyNature
- presence
- Optional
- Interface version
- 2.41
Journey nature. Accepted values could depend on acquirer.
-
journeySequence
- presence
- Optional
- Interface version
- 2.38
Trip occurrence number within the trip.
-
journeyStage
- presence
- Optional
- Interface version
- 2.38
Nature of the stage of the trip.
List of values
OUTWARD
- An outward journey
RETURN
- A return journey
TRANSIT
- Stage of the transitory journey
-
luggageSupplementIndicator
- presence
- Optional
- Interface version
- 2.38
Luggage supplement indicator.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
numberOfTickets
- presence
- Optional
- Interface version
- 2.38
Number of tickets.
-
ticketExchangeabilityIndicator
- presence
- Optional
- Interface version
- 2.38
Ticket exchangeability indicator.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
ticketIssueCity
- presence
- Optional
- Interface version
- 2.38
City of issue of the ticket.
-
ticketIssueDate
- presence
- Optional
- Interface version
- 2.38
Issue date of the ticket.
-
ticketIssuerName
- presence
- Optional
- Interface version
- 2.38
Name of the organization issuing the ticket.
-
ticketReference
- presence
- Optional
- Interface version
- 2.38
Ticket reference of the transport ticket.
-
stayDataList
- presence
- Optional
- Interface version
- 2.38
List of accommodations. This list is limited to 25 items.
Contains
-
stayData
- presence
- Optional
- Interface version
- 2.38
Contains accommodation information.
Contains
-
stayCategory
- presence
- Optional
- Interface version
- 2.38
Nature of service for the stay.
List of values
HOTEL
- Hotel
OTHER
- Other
RENTAL
- Rental
TOUR
- Tour operator
-
numberOfNights
- presence
- Optional
- Interface version
- 2.38
Number of nights.
-
stayCompany
- presence
- Optional
- Interface version
- 2.38
Name of the accommodation provider.
-
stayArrivalDateTime
- presence
- Optional
- Interface version
- 2.38
Arrival date of stay.
-
numberOfPeopleStaying
- presence
- Optional
- Interface version
- 2.38
Number of people accommodated.
-
roomServiceLevel
- presence
- Optional
- Interface version
- 2.38
Room service level.
-
stayDepartureDateTime
- presence
- Optional
- Interface version
- 2.38
Departure date of stay.
-
stayInsurance
- presence
- Optional
- Interface version
- 2.38
Insurance taken out for accommodation.
-
stayInsuranceIndicator
- presence
- Optional
- Interface version
- 2.38
Stay indicator with insurance.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
stayLocation
- presence
- Optional
- Interface version
- 2.38
Place of accommodation.
-
stayNumberOfRooms
- presence
- Optional
- Interface version
- 2.38
Number of rooms.
-
stayRentalCarIndicator
- presence
- Optional
- Interface version
- 2.38
Indicator of stay with rental vehicle.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
passportDataList
- presence
- Optional
- Interface version
- 2.38
List of travelers’ passports. This list is limited to 30 items.
Contains
-
passportData
- presence
- Optional
- Interface version
- 2.38
Contains passport information.
Contains
-
passportExpirationDate
- presence
- Optional
- Interface version
- 2.38
Passport expiration date.
-
passportIssueCountry
- presence
- Optional
- Interface version
- 2.38
Country of issue of passport.
-
mainTravelerFirstName
- presence
- Optional
- Interface version
- 2.46
Traveler first name.
-
travelCardType
- presence
- Optional
- Interface version
- 2.38
Subscription card code.
-
bookingData
- presence
- Optional
- Interface version
- 2.41
Contains specific data concerning travel booking.
Contains
-
bookerFirstName
- presence
- Optional
- Interface version
- 2.41
Booker first name.
-
bookerLastName
- presence
- Optional
- Interface version
- 2.41
Booker last name.
-
bookingId
- presence
- Optional
- Interface version
- 2.41
Merchant travel booking identifier.
-
bookingPlatform
- presence
- Optional
- Interface version
- 2.41
Travel booking platform.
-
bookingPlatformOrderId
- presence
- Optional
- Interface version
- 2.41
Travel booking platform order identifier.
-
mainTravelerLastName
- presence
- Optional
- Interface version
- 2.46
Traveler last name.
-
numberOfTravelers
- presence
- Optional
- Interface version
- 2.38
Number of travelers.
-
travelEndDateTime
- presence
- Optional
- Interface version
- 2.38
Travel end date.
-
travelingPayerIndicator
- presence
- Optional
- Interface version
- 2.38
Indicator if the payer is a traveler.
List of values
false
- Boolean indicator is false
true
- Boolean indicator is true
-
travelReason
- presence
- Optional
- Interface version
- 2.38
Purpose of the trip.
-
travelStartDateTime
- presence
- Optional
- Interface version
- 2.38
Start date of the trip.
-
shoppingCartTotalAmount
- presence
- Optional
- Interface version
- 2.6
Total amount of all products in the basket. This amount includes taxes but doesn’t include any charges, fees and discounts.
-
shoppingCartTotalQuantity
- presence
- Optional
- Interface version
- 2.6
Total quantity of all products in the basket.
-
shoppingCartTotalTaxAmount
- presence
- Optional
- Interface version
- 2.6
Total amount of taxes in the basket.
-
statementReference
- presence
- Optional
- Interface version
- 2.0
Reference provided by the merchant which is sent in the payment collection flow. This reference appears on the account statements of the cardholder.
-
subMerchantAddress
- presence
- Optional
- Interface version
- 2.15
Contains address information of a merchant of the Payment Facilitator in the context of Collecting offer or a Marketplace offer.
Contains
-
streetNumber
- presence
- Optional
- Interface version
- 2.0
Number of the street of the address.
-
addressAdditional3
- presence
- Optional
- Interface version
- 2.0
Addition 3 to the address.
-
businessName
- presence
- Optional
- Interface version
- 2.17
Business name.
-
country
- presence
- Optional
- Interface version
- 2.0
Country code for the address.
List of values
ABW
- ARUBA
AFG
- AFGHANISTAN
AGO
- ANGOLA
AIA
- ANGUILLA
ALA
- ÅLAND ISLANDS
ALB
- ALBANIA
AND
- ANDORRA
ARE
- UNITED ARAB EMIRATES
ARG
- ARGENTINA
ARM
- ARMENIA
ASM
- AMERICAN SAMOA
ATA
- ANTARCTICA
ATF
- FRENCH SOUTHERN TERRITORIES
ATG
- ANTIGUA AND BARBUDA
AUS
- AUSTRALIA
AUT
- AUSTRIA
AZE
- AZERBAIJAN
BDI
- BURUNDI
BEL
- BELGIUM
BEN
- BENIN
BES
- BONAIRE, SINT EUSTATIUS AND SABA
BFA
- BURKINA FASO
BGD
- BANGLADESH
BGR
- BULGARIA
BHR
- BAHRAIN
BHS
- BAHAMAS
BIH
- BOSNIA AND HERZEGOVINA
BLM
- SAINT KITTS AND NEVIS
BLR
- BELARUS
BLZ
- BELIZE
BMU
- BERMUDA
BOL
- BOLIVIA, PLURINATIONAL STATE OF
BRA
- BRAZIL
BRB
- BARBADOS
BRN
- BRUNEI DARUSSALAM
BTN
- BHUTAN
BVT
- BOUVET ISLAND
BWA
- BOTSWANA
CAF
- CENTRAL AFRICAN REPUBLIC
CAN
- CANADA
CCK
- COCOS (KEELING) ISLANDS
CHE
- SWITZERLAND
CHL
- CHILE
CHN
- CHINA
CIV
- CÔTE D’IVOIRE
CMR
- CAMEROON
COD
- CONGO, THE DEMOCRATIC REPUBLIC OF THE
COG
- CONGO
COK
- COOK ISLANDS
COL
- COLOMBIA
COM
- COMOROS
CPV
- CAPE VERDE
CRI
- COSTA RICA
CUB
- CUBA
CUW
- CURAÇAO
CXR
- CHRISTMAS ISLAND
CYM
- CAYMAN ISLANDS
CYP
- CYPRUS
CZE
- CZECH REPUBLIC
DEU
- GERMANY
DJI
- DJIBOUTI
DMA
- DOMINICA
DNK
- DENMARK
DOM
- DOMINICAN REPUBLIC
DZA
- ALGERIA
ECU
- ECUADOR
EGY
- EGYPT
ERI
- ERITREA
ESH
- WESTERN SAHARA
ESP
- SPAIN
EST
- ESTONIA
ETH
- ETHIOPIA
FIN
- FINLAND
FJI
- FIJI
FLK
- FALKLAND ISLANDS (MALVINAS)
FRA
- FRANCE
FRO
- FAROE ISLANDS
FSM
- MICRONESIA, FEDERATED STATES OF
GAB
- GABON
GBR
- UNITED KINGDOM
GEO
- GEORGIA
GGY
- GUERNSEY
GHA
- GHANA
GIB
- GIBRALTAR
GIN
- GUINEA
GLP
- GUADELOUPE
GMB
- GAMBIA
GNB
- GUINEA-BISSAU
GNQ
- EQUATORIAL GUINEA
GRC
- GREECE
GRD
- GRENADA
GRL
- GREENLAND
GTM
- GUATEMALA
GUF
- FRENCH GUIANA
GUM
- GUAM
GUY
- GUYANA
HKG
- HONG KONG
HMD
- HEARD ISLAND AND MCDONALD ISLANDS
HND
- HONDURAS
HRV
- CROATIA
HTI
- HAITI
HUN
- HUNGARY
IDN
- INDONESIA
IMN
- ISLE OF MAN
IND
- INDIA
IOT
- BRITISH INDIAN OCEAN TERRITORY
IRL
- IRELAND
IRN
- IRAN, ISLAMIC REPUBLIC OF
IRQ
- IRAQ
ISL
- ICELAND
ISR
- ISRAEL
ITA
- ITALY
JAM
- JAMAICA
JEY
- JERSEY
JOR
- JORDAN
JPN
- JAPAN
KAZ
- KAZAKHSTAN
KEN
- KENYA
KGZ
- KYRGYZSTAN
KHM
- CAMBODIA
KIR
- KIRIBATI
KNA
- SAINT BARTHÉLEMY
KOR
- KOREA, REPUBLIC OF
KWT
- KUWAIT
LAO
- LAO PEOPLE’S DEMOCRATIC REPUBLIC
LBN
- LEBANON
LBR
- LIBERIA
LBY
- LIBYA
LCA
- SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA
LIE
- LIECHTENSTEIN
LKA
- SRI LANKA
LSO
- LESOTHO
LTU
- LITHUANIA
LUX
- LUXEMBOURG
LVA
- LATVIA
MAC
- MACAO
MAF
- SAINT MARTIN (FRENCH PART)
MAR
- MOROCCO
MCO
- MONACO
MDA
- MOLDOVA, REPUBLIC OF
MDG
- MADAGASCAR
MDV
- MALDIVES
MEX
- MEXICO
MHL
- MARSHALL ISLANDS
MKD
- MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF
MLI
- MALI
MLT
- MALTA
MMR
- MYANMAR
MNE
- MONTENEGRO
MNG
- MONGOLIA
MNP
- NORTHERN MARIANA ISLANDS
MOZ
- MOZAMBIQUE
MRT
- MAURITANIA
MSR
- MONTSERRAT
MTQ
- MARTINIQUE
MUS
- MAURITIUS
MWI
- MALAWI
MYS
- MALAYSIA
MYT
- MAYOTTE
NAM
- NAMIBIA
NCL
- NEW CALEDONIA
NER
- NIGER
NFK
- NORFOLK ISLAND
NGA
- NIGERIA
NIC
- NICARAGUA
NIU
- NIUE
NLD
- NETHERLANDS
NOR
- NORWAY
NPL
- NEPAL
NRU
- NAURU
NZL
- NEW ZEALAND
OMN
- OMAN
PAK
- PAKISTAN
PAN
- PANAMA
PCN
- PITCAIRN
PER
- PERU
PHL
- PHILIPPINES
PLW
- PALAU
PNG
- PAPUA NEW GUINEA
POL
- POLAND
PRI
- PUERTO RICO
PRK
- KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF
PRT
- PORTUGAL
PRY
- PARAGUAY
PSE
- PALESTINIAN TERRITORY, OCCUPIED
PYF
- FRENCH POLYNESIA
QAT
- QATAR
REU
- RÉUNION
ROU
- ROMANIA
RUS
- RUSSIAN FEDERATION
RWA
- RWANDA
SAU
- SAUDI ARABIA
SDN
- SUDAN
SEN
- SENEGAL
SGP
- SINGAPORE
SGS
- SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS
SHN
- SAN MARINO
SJM
- SVALBARD AND JAN MAYEN
SLB
- SOLOMON ISLANDS
SLE
- SIERRA LEONE
SLV
- EL SALVADOR
SMR
- SINT MAARTEN (DUTCH PART)
SOM
- SOMALIA
SPM
- HOLY SEE (VATICAN CITY STATE)
SRB
- SERBIA
SSD
- SOUTH SUDAN
STP
- SAO TOME AND PRINCIPE
SUR
- SURINAME
SVK
- SLOVAKIA
SVN
- SLOVENIA
SWE
- SWEDEN
SWZ
- SWAZILAND
SXM
- SAINT PIERRE AND MIQUELON
SYC
- SEYCHELLES
SYR
- SYRIAN ARAB REPUBLIC
TCA
- TURKS AND CAICOS ISLANDS
TCD
- CHAD
TGO
- TOGO
THA
- THAILAND
TJK
- TAJIKISTAN
TKL
- TOKELAU
TKM
- TURKMENISTAN
TLS
- TIMOR-LESTE
TON
- TONGA
TTO
- TRINIDAD AND TOBAGO
TUN
- TUNISIA
TUR
- TURKEY
TUV
- TUVALU
TWN
- TAIWAN, PROVINCE OF CHINA
TZA
- TANZANIA, UNITED REPUBLIC OF
UGA
- UGANDA
UKR
- UKRAINE
UMI
- UNITED STATES MINOR OUTLYING ISLANDS
URY
- URUGUAY
USA
- UNITED STATES
UZB
- UZBEKISTAN
VAT
- SAINT VINCENT AND THE GRENADINES
VCT
- SAINT LUCIA
VEN
- VENEZUELA, BOLIVARIAN REPUBLIC OF
VGB
- VIRGIN ISLANDS, BRITISH
VIR
- VIRGIN ISLANDS, U.S.
VNM
- VIET NAM
VUT
- VANUATU
WLF
- WALLIS AND FUTUNA
WSM
- SAMOA
YEM
- YEMEN
ZAF
- SOUTH AFRICA
ZMB
- ZAMBIA
ZWE
- ZIMBABWE
-
state
- presence
- Optional
- Interface version
- 2.0
Address state/department. To be completed in accordance with ISO 3166-2. The first two letters designate the country and the letters following the hyphen designate the subdivision, e.g. FR-ARA for the French region Auvergne-Rhône-Alpes.
-
postBox
- presence
- Optional
- Interface version
- 2.0
Post box for the address.
-
city
- presence
- Optional
- Interface version
- 2.0
City of the address.
-
company
- presence
- Optional
- Interface version
- 2.0
Company for the address.
-
street
- presence
- Optional
- Interface version
- 2.0
Name of the street of the address.
-
addressAdditional1
- presence
- Optional
- Interface version
- 2.0
Addition 1 to the address.
-
addressAdditional2
- presence
- Optional
- Interface version
- 2.0
Addition 2 to the address.
-
zipCode
- presence
- Optional
- Interface version
- 2.0
Postal code for the address.
-
subMerchantCategoryCode
- presence
- Optional
- Interface version
- 2.15
MCC Code of the vendor at the Payment Facilitator in a context of Collecting offer or a Marketplace offer.
-
subMerchantContractNumber
- presence
- Optional
- Interface version
- 2.20
Merchant contract number of the Payment Facilitator in the context of Collecting offer or a Marketplace offer (only used for Cetelem).
-
subMerchantId
- presence
- Optional
- Interface version
- 2.15
Merchant identifier of the Payment Facilitator in the context of Collecting offer or a Marketplace offer.
-
subMerchantLegalId
- presence
- Optional
- Interface version
- 2.15
Legal identifier of vendor as merchant of the Payment Facilitator, expressed in the legal codification specific to each country.
-
subMerchantName
- presence
- Optional
- Interface version
- 2.20
Name of the merchant of the Payment Facilitator in the context of Collecting offer or a Marketplace offer.
-
subMerchantShortName
- presence
- Optional
- Interface version
- 2.15
Short name of the merchant of the Payment Facilitator in the context of Collecting offer or a Marketplace offer.
-
subMerchantUrl
- presence
- Optional
- Interface version
- 2.41
Url of the submerchant at the payment facilitator.
-
templateName
- presence
- Optional
- Interface version
- 2.0
Name of the file corresponding to the style sheet (name of the zip file) used to personalize the payment pages.
-
transactionActors
- presence
- Optional
- Interface version
- 2.0
Indicates the players in the transaction.
List of values
BTOB
- Business to Business
BTOC
- Business to Consumer
BTOF
- Business to organization / association
-
transactionOrigin
- presence
- Optional
- Interface version
- 2.0
Origin of a transaction (for example: name of the programme), set by the merchant. Exemple: “Website A v1.32”.
-
transactionReference
- presence
- Optional
- Interface version
- 2.0
The merchant can choose of referencing his transactions by a transactionId or a transactionReference.transactionReference uniquely identifies a transaction throughout the life of the shop.
-
travelContext
- presence
- Optional
- Interface version
- 2.16
Contains specific information regarding the travel.
Contains
-
numberOfRoutingCities
- presence
- Optional
- Interface version
- 2.16
Number of routing cities.
-
numberOfAirlineCarriers
- presence
- Optional
- Interface version
- 2.16
Number of airline carriers.
-
airlineCarrierList
- presence
- Optional
- Interface version
- 2.16
Airline carrier list.
-
departureDate
- presence
- Optional
- Interface version
- 2.16
Departure date.
-
destinationAirport
- presence
- Optional
- Interface version
- 2.16
Destination airport.
-
reservationCode
- presence
- Optional
- Interface version
- 2.16
Reservation code.
-
passengerName
- presence
- Optional
- Interface version
- 2.16
Passenger name.
-
routingCityList
- presence
- Optional
- Interface version
- 2.16
Routing city list.
-
fareBasis
- presence
- Optional
- Interface version
- 2.16
Fare Basis. Example: business class, economy class, …
-
originAirport
- presence
- Optional
- Interface version
- 2.16
Origin airport.
-
numberOfPassengers
- presence
- Optional
- Interface version
- 2.16
Number of passengers.
-
valueDate
- presence
- Optional
- Interface version
- 2.0
Payment value date
Request sample
Response
Required
-
seal
- presence
- Required
- Interface version
- 2.0
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
redirectionData
- presence
- Optional
- Interface version
- 2.0
In case of 3-D Secure payment, contains the context of the transaction retrieved from the cardCheckEnrollment method. In case of 3-D Secure server Standalone, it contains the Payer Authentication Request (PAReq) that the merchant must transmit to ACS for 3-D Secure authentication (format: base 64 encoded).In case of external payment provider, contains the context of the transaction sent by the merchant during the transaction initialisation.
-
redirectionStatusCode
- presence
- Optional
- Interface version
- 2.0
Response code returned by Sogenactif when redirecting (e.g. redirecting to the ACS, to Sogenactif server…). Indicates whether redirecting is possible or not.
List of values
00
- In response to paymentWebInit: transaction initialized
- In response to walletCheckEnrollment and cardCheckEnrollment: Carte enrolled
01
- In response to cardCheckEnrollment and walletCheckEnrollment: card non 3-D Secure enrolled
03
- Merchant contract invalid
10
- Undefinied card enrollment (in response to cardCheckEnrollment and walletCheckEnrollment only)
12
- Invalid transaction, check parameters transferred in the request
14
- Invalid payment mean data (ex: PAN)
30
- Format error (Webinit ERROR)
34
- Suspicion of fraud, signature error (Webinit ERROR)
80
- Error during DS interrogation
89
- MPI session expired
91
- Merchant not configured in the 3-D Secire server
94
- In response to paymentWebInit: transaction duplicated. The transactionReference of this transaction has already been used
- In response to cardCheckEnrollment or walletCheckEnrollment: error during the enrollment verification call
99
- Internal error
-
redirectionStatusMessage
- presence
- Optional
- Interface version
- 2.0
Additional information that is returned with redirectionStatusCode.
-
redirectionUrl
- presence
- Optional
- Interface version
- 2.0
In case of an enrollment check, contains the redirection URL to the ACS required for the cardholder authentication. In case of Sogenactif In-App payment, contains the URL of the next request. In case of 3-D Secure Standalone, contains the redirection URL to the ACS required for the cardholder authentication.
-
redirectionVersion
- presence
- Optional
- Interface version
- 2.0
Version of the redirection message.
Response sample
Changelog