walletOrder
To search in the page use Ctrl+F on your keyboard
This function allows to create a payment with a card enrolled in “Sogenactif wallet.”
Recommended interfaceVersion: IR_WS_2.55
Endpoints
-
- PROD
-
https://office-server.sogenactif.com/rs-services/v2/checkout/walletOrder - method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/rs-services/v2/checkout/walletOrder - method
- POST
-
- PROD
-
https://office-server.sogenactif.com/services/v2/checkout?wsdl - method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/services/v2/checkout?wsdl - 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.
-
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.
-
merchantWalletId- presence
- Required
- Interface version
- 2.0
Customer’s Wallet identifier.
-
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
-
paymentMeanId- presence
- Required
- Interface version
- 2.0
Payment mean rank in Sogenactif wallet.
-
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.3
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
-
applePay- presence
- Optional
- Interface version
- 2.31
Contains specific authentication information for ApplePay.
Contains
-
authentAmount- presence
- Optional
- Interface version
- 2.37
Authentication amount.
-
cardAuthPolicy- presence
- Optional
- Interface version
- 2.0
Authentication policy for card.
Contains
-
automaticReverse- presence
- Optional
- Interface version
- 2.0
Systematically reverses and rejects accepted authorisations.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
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
-
holderAuthentProgram- presence
- Optional
- Interface version
- 2.27
Authentication programme
List of values
1EUROCOM- Cofidis Pay 5x10x20x authentication
3DS- 3-D Secure authentication
3DS_V2- 3-D Secure v2 authentication program. This value is accepted for the following versions Since the version 2.24 for Sogenactif Paypage Since the version 2.24 for Sogenactif Office Serveur Since the version 2.5 for Sogenactif In-App
APPLEPAY- Apple Pay authentication
BCMCMOBILE- BCMC authentication
GOOGLEPAY- Google Pay authentication
MASTERPASS- MasterPass authentication
NOT_SPECIFIED- No specified authentication program
NO_AUTHENT- Equivalent to NO_AUTHENT_METHOD it is an alternative value used in the transaction report
NO_AUTHENT_METHOD- no authentication program
PAYLIB- Paylib authentication
SAMSUNGPAY- Samsung Pay authentication
THREE_DS- Equivalent to 3DS it is an alternative value used in the transaction report
-
holderAuthentProvider- presence
- Optional
- Interface version
- 2.35
Specifies the PSP that performed the authentication.
List of values
1- The PSP is Sogenactif
2- Other PSP
-
threeD- presence
- Optional
- Interface version
- 2.0
Contains cardholder’s 3-D Secure authentication information.
Contains
-
securityIndicator- presence
- Optional
- Interface version
- 2.0
Transaction’s security level. This indicator is calculated based on the prior result of the 3-D Secure authentication.
List of values
10- 3DS disengaged holderAuthentProgram: N/A holderAuthentStatus : BYPASS
20- Deprecated value holderAuthentProgram: N/A holderAuthentStatus : N/A
21- Cardholder not enrolled in the 3DS 1.0 program holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
22- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
23- Successful authentication in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
24- Successful authentication in 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
25- Successful authentication in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : SUCCESS
26- Cardholder partially authenticated on ACS 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : ATTEMPT
27- Carrier partially authenticated on ACS 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
28- Cardholder partially authenticated on ACS 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
29- Card range not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
30- Cardholder not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
31- Cardholder authentication failure in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
32- Invalid signature in ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
33- Invalid ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
34- Cardholder authentication failure in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
35- Cardholder authentication failure in 3DS 2.0 in challenge mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
36- 3DS 2.0 authentication failed because no Rreq message received from ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
37- 3DS 2.0 authentication failed because Cres message is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
38- 3DS 2.0 authentication failed because the Cres message contains an error message holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
39- No authentication as requested by the merchant holderAuthentProgram: 3DS_V2 holderAuthentStatus : NO_AUTHENT
41- Error in 3DS 1.0: Session expired holderAuthentProgram: 3DS holderAuthentStatus : ERROR
42- Error in 3DS 2.0: Session expired holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
71- Error in 3DS 2.0: ARes message not received holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
72- Error in 3DS 2.0: ARes message received from DS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
73- Error in 3DS 2.0: RReq message received from ACS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
74- Error in 3DS 2.0: unable to reach the DS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
75- Error in 3DS 2.0: technical problem on the Sips platform holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
76- Error in 3DS 2.0: technical problem on the 3DS Server holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
81- Error in 3DS 1.0: Internal MPI error during the first call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
82- Error in 3DS 1.0: Internal MPI error during the second call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
84- Error in 3DS 1.0: Invalid DS response holderAuthentProgram: 3DS holderAuthentStatus : ERROR
85- Error in 3DS 1.0: technical problem during the first call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
86- Error in 3DS 1.0: technical problem during the second call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
87- Error in 3DS 1.0: the parameters transmitted to the MPI are invalid holderAuthentProgram: 3DS holderAuthentStatus : ERROR
88- Error in 3DS 1.0: Network problem holderAuthentProgram: 3DS holderAuthentStatus : ERROR
90- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : ERROR
92- Problem when verifying carrier enrollment holderAuthentProgram: 3DS holderAuthentStatus : ERROR
93- Problem when authenticating the cardholder on the ACS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
94- Error in 3DS 2.0: technical problem when calling the DS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
95- Error in 3DS 2.0: technical problem during kinematics with ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
-
cavv- presence
- Optional
- Interface version
- 2.31
Cardholder’s authentication verification value communicated in the MPI during 3-D Secure payments.
-
eci- presence
- Optional
- Interface version
- 2.31
Electric commerce indicator communicated in the MPI during 3-D Secure payments.
-
cavvAlgorithm- presence
- Optional
- Interface version
- 2.0
Algorithm indicator used to generate a CAVV communicated in the MPI during 3-D Secure payments.
List of values
0- HMAC
1- CVV
2- CVV ATN
3- Mastercard SPA
-
txStatus- presence
- Optional
- Interface version
- 2.0
Result of the authentication communicated in the MPI during 3-D Secure payments.
List of values
9- CARD_NOT_ENROLLED
A- ATTEMPT
C- CHALLENGE
D- DECOUPLED_AUTHENTICATION
E- AUTHENTICATED_WITHOUT_CRYPTO
I- INFO_ONLY
N- NOT_AUTHENTICATED
R- AUTHENTICATION_REJECTED
U- ERROR
Y- AUTHENTICATED_WITH_CRYPTO
-
xid- presence
- Optional
- Interface version
- 2.0
Unique transaction ID (generated by the MPI) presented in all 3-D Secure messages and communicated in the MPI during 3-D Secure payments.
-
threeDV2- presence
- Optional
- Interface version
- 2.27
Contains cardholder’s 3-D Secure v2 authentication information.
Contains
-
securityIndicator- presence
- Optional
- Interface version
- 2.0
Transaction’s security level. This indicator is calculated based on the prior result of the 3-D Secure authentication.
List of values
10- 3DS disengaged holderAuthentProgram: N/A holderAuthentStatus : BYPASS
20- Deprecated value holderAuthentProgram: N/A holderAuthentStatus : N/A
21- Cardholder not enrolled in the 3DS 1.0 program holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
22- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
23- Successful authentication in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
24- Successful authentication in 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
25- Successful authentication in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : SUCCESS
26- Cardholder partially authenticated on ACS 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : ATTEMPT
27- Carrier partially authenticated on ACS 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
28- Cardholder partially authenticated on ACS 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
29- Card range not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
30- Cardholder not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
31- Cardholder authentication failure in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
32- Invalid signature in ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
33- Invalid ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
34- Cardholder authentication failure in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
35- Cardholder authentication failure in 3DS 2.0 in challenge mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
36- 3DS 2.0 authentication failed because no Rreq message received from ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
37- 3DS 2.0 authentication failed because Cres message is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
38- 3DS 2.0 authentication failed because the Cres message contains an error message holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
39- No authentication as requested by the merchant holderAuthentProgram: 3DS_V2 holderAuthentStatus : NO_AUTHENT
41- Error in 3DS 1.0: Session expired holderAuthentProgram: 3DS holderAuthentStatus : ERROR
42- Error in 3DS 2.0: Session expired holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
71- Error in 3DS 2.0: ARes message not received holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
72- Error in 3DS 2.0: ARes message received from DS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
73- Error in 3DS 2.0: RReq message received from ACS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
74- Error in 3DS 2.0: unable to reach the DS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
75- Error in 3DS 2.0: technical problem on the Sips platform holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
76- Error in 3DS 2.0: technical problem on the 3DS Server holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
81- Error in 3DS 1.0: Internal MPI error during the first call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
82- Error in 3DS 1.0: Internal MPI error during the second call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
84- Error in 3DS 1.0: Invalid DS response holderAuthentProgram: 3DS holderAuthentStatus : ERROR
85- Error in 3DS 1.0: technical problem during the first call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
86- Error in 3DS 1.0: technical problem during the second call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
87- Error in 3DS 1.0: the parameters transmitted to the MPI are invalid holderAuthentProgram: 3DS holderAuthentStatus : ERROR
88- Error in 3DS 1.0: Network problem holderAuthentProgram: 3DS holderAuthentStatus : ERROR
90- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : ERROR
92- Problem when verifying carrier enrollment holderAuthentProgram: 3DS holderAuthentStatus : ERROR
93- Problem when authenticating the cardholder on the ACS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
94- Error in 3DS 2.0: technical problem when calling the DS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
95- Error in 3DS 2.0: technical problem during kinematics with ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
-
authentDateTime- presence
- Optional
- Interface version
- 2.27
UTC date and time of the authentication.
-
authentCancelReason- presence
- Optional
- Interface version
- 2.27
Reason for authentication cancellation.
List of values
01- Cancellation was requested by the cardholder
02- The requestor 3DS cancelled the authentication
03- Abandoned transaction
04- Time out exceeded at ACS: other deadlines
05- Time out exceeded at ACS: first CReq not received by ACS
06- Transaction in error
07- Unknown cancellation reason
-
holderAuthentType- presence
- Optional
- Interface version
- 2.27
Cardholder authentication type applied by the issuer of the card. Field valued in 3-D Secure v2.
List of values
CHALLENGE- Authentication on challenge flow (redirection of authentication pages to cardholder)
FRICTIONLESS- Authentication on frictionless flow
FRICTIONLESS_DELEGATE- Deprecated - Authentication on delegated frictionless flow (DS manage the authentication instead of issuer in case of technical issues
NONE- No authentication could be implemented
-
cavvAlgorithm- presence
- Optional
- Interface version
- 2.0
Algorithm indicator used to generate a CAVV communicated in the MPI during 3-D Secure payments.
List of values
0- HMAC
1- CVV
2- CVV ATN
3- Mastercard SPA
-
authentTransStatusReason- presence
- Optional
- Interface version
- 2.27
Reason accompanying the authentication result communicated in the MPI of a 3D-Secure payment.
-
authentMessageVersion- presence
- Optional
- Interface version
- 2.31
Version of the 3-D Secure protocol used (e.g. 2.1.0).
-
cavv- presence
- Optional
- Interface version
- 2.31
Cardholder’s authentication verification value communicated in the MPI during 3-D Secure payments.
-
authentDsTransId- presence
- Optional
- Interface version
- 2.27
Universal transaction identifier assigned by the DS to uniquely identify a transaction.
-
challengeMode3DS- presence
- Optional
- Interface version
- 2.27
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
-
authentExemptionReasonList- presence
- Optional
- Interface version
- 2.31
List of exemptions fixed by the issuer.
List of values
AUTOMATE_PAYMENT- Automatic payment machines for transport and car park
CORPORATE- Exemption safe procedure and payment protocol for companies
DELEGATED_SCA- Strong authentication implemented by the acceptor (wallet)
LOW_RISK_MERCHANT_CB- Risk analysis in the Low Risk Merchant CB program
LOW_VALUE- Exemption low values
OTHER_EXEMPTION- Other use case exempt from authentication
OUT_OF_SCOPE_RTSRECURRING_FIX- Exemption for recurring transactions of identical amounts and fixed term
TECHNICAL_ERROR- Technical impossibility of implementing authentication
TRA_ACQUIRER- Exemption risk analysis by the acceptor/acquirer
TRA_ISSUER- Exemption risk analysis by the issuer
WHITE_LIST- Exemption trusted beneficiary
-
authentAcsTransId- presence
- Optional
- Interface version
- 2.27
Universal transaction identifier assigned by the ACS to uniquely identify a transaction.
-
authentDsMerchantName- presence
- Optional
- Interface version
- 2.31
Identifier assigned by the Directory Server to uniquely identify the merchant.
-
eci- presence
- Optional
- Interface version
- 2.31
Electric commerce indicator communicated in the MPI during 3-D Secure payments.
-
authentScoreValue- presence
- Optional
- Interface version
- 2.27
Score value provided by the DS (Directory Server) to the ACS (Access Control Server).
-
authentAmount- presence
- Optional
- Interface version
- 2.37
Authentication amount.
-
authentThreedsServerTransId- presence
- Optional
- Interface version
- 2.35
Universal transaction identifier assigned by the 3DS server to uniquely identify a transaction.
-
authentAcsMethod- presence
- Optional
- Interface version
- 2.31
Authentication method that the ACS applied to authenticate the cardholder.
List of values
01- STATIC_PASSCODE
02- SMS_OTP
03- KEY_FOB_OR_EMV_CARD_READER_OTP
04- APP_OTP
05- OTP_OTHER
06- KBA
07- OOB_BIOMETRICS
08- OOB_LOGIN
09- OOB_OTHER
10- OTHER
-
txStatus- presence
- Optional
- Interface version
- 2.0
Result of the authentication communicated in the MPI during 3-D Secure payments.
List of values
9- CARD_NOT_ENROLLED
A- ATTEMPT
C- CHALLENGE
D- DECOUPLED_AUTHENTICATION
E- AUTHENTICATED_WITHOUT_CRYPTO
I- INFO_ONLY
N- NOT_AUTHENTICATED
R- AUTHENTICATION_REJECTED
U- ERROR
Y- AUTHENTICATED_WITH_CRYPTO
-
authenticationResult- presence
- Optional
- Interface version
- 2.36
Contains the result information from the cardholder’s authentification.
Contains
-
applePay- presence
- Optional
- Interface version
- 2.31
Contains specific authentication information for ApplePay.
Contains
-
googlePay- presence
- Optional
- Interface version
- 2.46
Contains specific authentication information for GooglePay.
Contains
-
holderAuthentProgram- presence
- Optional
- Interface version
- 2.27
Authentication programme
List of values
1EUROCOM- Cofidis Pay 5x10x20x authentication
3DS- 3-D Secure authentication
3DS_V2- 3-D Secure v2 authentication program. This value is accepted for the following versions Since the version 2.24 for Sogenactif Paypage Since the version 2.24 for Sogenactif Office Serveur Since the version 2.5 for Sogenactif In-App
APPLEPAY- Apple Pay authentication
BCMCMOBILE- BCMC authentication
GOOGLEPAY- Google Pay authentication
MASTERPASS- MasterPass authentication
NOT_SPECIFIED- No specified authentication program
NO_AUTHENT- Equivalent to NO_AUTHENT_METHOD it is an alternative value used in the transaction report
NO_AUTHENT_METHOD- no authentication program
PAYLIB- Paylib authentication
SAMSUNGPAY- Samsung Pay authentication
THREE_DS- Equivalent to 3DS it is an alternative value used in the transaction report
-
holderAuthentProvider- presence
- Optional
- Interface version
- 2.35
Specifies the PSP that performed the authentication.
List of values
1- The PSP is Sogenactif
2- Other PSP
-
samsungPay- presence
- Optional
- Interface version
- 2.36
Contains the information related to SamsungPay.
Contains
-
threeD- presence
- Optional
- Interface version
- 2.0
Contains cardholder’s 3-D Secure authentication information.
Contains
-
securityIndicator- presence
- Optional
- Interface version
- 2.0
Transaction’s security level. This indicator is calculated based on the prior result of the 3-D Secure authentication.
List of values
10- 3DS disengaged holderAuthentProgram: N/A holderAuthentStatus : BYPASS
20- Deprecated value holderAuthentProgram: N/A holderAuthentStatus : N/A
21- Cardholder not enrolled in the 3DS 1.0 program holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
22- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
23- Successful authentication in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
24- Successful authentication in 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
25- Successful authentication in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : SUCCESS
26- Cardholder partially authenticated on ACS 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : ATTEMPT
27- Carrier partially authenticated on ACS 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
28- Cardholder partially authenticated on ACS 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
29- Card range not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
30- Cardholder not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
31- Cardholder authentication failure in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
32- Invalid signature in ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
33- Invalid ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
34- Cardholder authentication failure in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
35- Cardholder authentication failure in 3DS 2.0 in challenge mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
36- 3DS 2.0 authentication failed because no Rreq message received from ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
37- 3DS 2.0 authentication failed because Cres message is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
38- 3DS 2.0 authentication failed because the Cres message contains an error message holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
39- No authentication as requested by the merchant holderAuthentProgram: 3DS_V2 holderAuthentStatus : NO_AUTHENT
41- Error in 3DS 1.0: Session expired holderAuthentProgram: 3DS holderAuthentStatus : ERROR
42- Error in 3DS 2.0: Session expired holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
71- Error in 3DS 2.0: ARes message not received holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
72- Error in 3DS 2.0: ARes message received from DS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
73- Error in 3DS 2.0: RReq message received from ACS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
74- Error in 3DS 2.0: unable to reach the DS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
75- Error in 3DS 2.0: technical problem on the Sips platform holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
76- Error in 3DS 2.0: technical problem on the 3DS Server holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
81- Error in 3DS 1.0: Internal MPI error during the first call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
82- Error in 3DS 1.0: Internal MPI error during the second call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
84- Error in 3DS 1.0: Invalid DS response holderAuthentProgram: 3DS holderAuthentStatus : ERROR
85- Error in 3DS 1.0: technical problem during the first call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
86- Error in 3DS 1.0: technical problem during the second call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
87- Error in 3DS 1.0: the parameters transmitted to the MPI are invalid holderAuthentProgram: 3DS holderAuthentStatus : ERROR
88- Error in 3DS 1.0: Network problem holderAuthentProgram: 3DS holderAuthentStatus : ERROR
90- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : ERROR
92- Problem when verifying carrier enrollment holderAuthentProgram: 3DS holderAuthentStatus : ERROR
93- Problem when authenticating the cardholder on the ACS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
94- Error in 3DS 2.0: technical problem when calling the DS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
95- Error in 3DS 2.0: technical problem during kinematics with ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
-
cavv- presence
- Optional
- Interface version
- 2.31
Cardholder’s authentication verification value communicated in the MPI during 3-D Secure payments.
-
eci- presence
- Optional
- Interface version
- 2.31
Electric commerce indicator communicated in the MPI during 3-D Secure payments.
-
cavvAlgorithm- presence
- Optional
- Interface version
- 2.0
Algorithm indicator used to generate a CAVV communicated in the MPI during 3-D Secure payments.
List of values
0- HMAC
1- CVV
2- CVV ATN
3- Mastercard SPA
-
txStatus- presence
- Optional
- Interface version
- 2.0
Result of the authentication communicated in the MPI during 3-D Secure payments.
List of values
9- CARD_NOT_ENROLLED
A- ATTEMPT
C- CHALLENGE
D- DECOUPLED_AUTHENTICATION
E- AUTHENTICATED_WITHOUT_CRYPTO
I- INFO_ONLY
N- NOT_AUTHENTICATED
R- AUTHENTICATION_REJECTED
U- ERROR
Y- AUTHENTICATED_WITH_CRYPTO
-
xid- presence
- Optional
- Interface version
- 2.0
Unique transaction ID (generated by the MPI) presented in all 3-D Secure messages and communicated in the MPI during 3-D Secure payments.
-
threeDV2- presence
- Optional
- Interface version
- 2.27
Contains cardholder’s 3-D Secure v2 authentication information.
Contains
-
securityIndicator- presence
- Optional
- Interface version
- 2.0
Transaction’s security level. This indicator is calculated based on the prior result of the 3-D Secure authentication.
List of values
10- 3DS disengaged holderAuthentProgram: N/A holderAuthentStatus : BYPASS
20- Deprecated value holderAuthentProgram: N/A holderAuthentStatus : N/A
21- Cardholder not enrolled in the 3DS 1.0 program holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
22- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : NOT_ENROLLED
23- Successful authentication in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
24- Successful authentication in 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : SUCCESS
25- Successful authentication in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : SUCCESS
26- Cardholder partially authenticated on ACS 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : ATTEMPT
27- Carrier partially authenticated on ACS 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
28- Cardholder partially authenticated on ACS 3DS 2.0 in challenge mode (strong authentication) holderAuthentProgram: 3DS_V2 holderAuthentStatus : ATTEMPT
29- Card range not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
30- Cardholder not enrolled in the 3DS 2.0 program holderAuthentProgram: 3DS_V2 holderAuthentStatus : NOT_ENROLLED
31- Cardholder authentication failure in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
32- Invalid signature in ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
33- Invalid ACS response in 3DS 1.0 holderAuthentProgram: 3DS holderAuthentStatus : FAILURE
34- Cardholder authentication failure in 3DS 2.0 in frictionless mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
35- Cardholder authentication failure in 3DS 2.0 in challenge mode holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
36- 3DS 2.0 authentication failed because no Rreq message received from ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
37- 3DS 2.0 authentication failed because Cres message is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
38- 3DS 2.0 authentication failed because the Cres message contains an error message holderAuthentProgram: 3DS_V2 holderAuthentStatus : FAILURE
39- No authentication as requested by the merchant holderAuthentProgram: 3DS_V2 holderAuthentStatus : NO_AUTHENT
41- Error in 3DS 1.0: Session expired holderAuthentProgram: 3DS holderAuthentStatus : ERROR
42- Error in 3DS 2.0: Session expired holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
71- Error in 3DS 2.0: ARes message not received holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
72- Error in 3DS 2.0: ARes message received from DS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
73- Error in 3DS 2.0: RReq message received from ACS is invalid holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
74- Error in 3DS 2.0: unable to reach the DS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
75- Error in 3DS 2.0: technical problem on the Sips platform holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
76- Error in 3DS 2.0: technical problem on the 3DS Server holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
81- Error in 3DS 1.0: Internal MPI error during the first call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
82- Error in 3DS 1.0: Internal MPI error during the second call holderAuthentProgram: 3DS holderAuthentStatus : ERROR
84- Error in 3DS 1.0: Invalid DS response holderAuthentProgram: 3DS holderAuthentStatus : ERROR
85- Error in 3DS 1.0: technical problem during the first call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
86- Error in 3DS 1.0: technical problem during the second call to MPI holderAuthentProgram: 3DS holderAuthentStatus : ERROR
87- Error in 3DS 1.0: the parameters transmitted to the MPI are invalid holderAuthentProgram: 3DS holderAuthentStatus : ERROR
88- Error in 3DS 1.0: Network problem holderAuthentProgram: 3DS holderAuthentStatus : ERROR
90- Deprecated value holderAuthentProgram: 3DS holderAuthentStatus : ERROR
92- Problem when verifying carrier enrollment holderAuthentProgram: 3DS holderAuthentStatus : ERROR
93- Problem when authenticating the cardholder on the ACS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
94- Error in 3DS 2.0: technical problem when calling the DS holderAuthentProgram: 3DS holderAuthentStatus : ERROR
95- Error in 3DS 2.0: technical problem during kinematics with ACS holderAuthentProgram: 3DS_V2 holderAuthentStatus : ERROR
-
authentDateTime- presence
- Optional
- Interface version
- 2.27
UTC date and time of the authentication.
-
authentCancelReason- presence
- Optional
- Interface version
- 2.27
Reason for authentication cancellation.
List of values
01- Cancellation was requested by the cardholder
02- The requestor 3DS cancelled the authentication
03- Abandoned transaction
04- Time out exceeded at ACS: other deadlines
05- Time out exceeded at ACS: first CReq not received by ACS
06- Transaction in error
07- Unknown cancellation reason
-
holderAuthentType- presence
- Optional
- Interface version
- 2.27
Cardholder authentication type applied by the issuer of the card. Field valued in 3-D Secure v2.
List of values
CHALLENGE- Authentication on challenge flow (redirection of authentication pages to cardholder)
FRICTIONLESS- Authentication on frictionless flow
FRICTIONLESS_DELEGATE- Deprecated - Authentication on delegated frictionless flow (DS manage the authentication instead of issuer in case of technical issues
NONE- No authentication could be implemented
-
cavvAlgorithm- presence
- Optional
- Interface version
- 2.0
Algorithm indicator used to generate a CAVV communicated in the MPI during 3-D Secure payments.
List of values
0- HMAC
1- CVV
2- CVV ATN
3- Mastercard SPA
-
authentTransStatusReason- presence
- Optional
- Interface version
- 2.27
Reason accompanying the authentication result communicated in the MPI of a 3D-Secure payment.
-
authentMessageVersion- presence
- Optional
- Interface version
- 2.31
Version of the 3-D Secure protocol used (e.g. 2.1.0).
-
cavv- presence
- Optional
- Interface version
- 2.31
Cardholder’s authentication verification value communicated in the MPI during 3-D Secure payments.
-
authentDsTransId- presence
- Optional
- Interface version
- 2.27
Universal transaction identifier assigned by the DS to uniquely identify a transaction.
-
challengeMode3DS- presence
- Optional
- Interface version
- 2.27
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
-
authentExemptionReasonList- presence
- Optional
- Interface version
- 2.31
List of exemptions fixed by the issuer.
List of values
AUTOMATE_PAYMENT- Automatic payment machines for transport and car park
CORPORATE- Exemption safe procedure and payment protocol for companies
DELEGATED_SCA- Strong authentication implemented by the acceptor (wallet)
LOW_RISK_MERCHANT_CB- Risk analysis in the Low Risk Merchant CB program
LOW_VALUE- Exemption low values
OTHER_EXEMPTION- Other use case exempt from authentication
OUT_OF_SCOPE_RTSRECURRING_FIX- Exemption for recurring transactions of identical amounts and fixed term
TECHNICAL_ERROR- Technical impossibility of implementing authentication
TRA_ACQUIRER- Exemption risk analysis by the acceptor/acquirer
TRA_ISSUER- Exemption risk analysis by the issuer
WHITE_LIST- Exemption trusted beneficiary
-
authentAcsTransId- presence
- Optional
- Interface version
- 2.27
Universal transaction identifier assigned by the ACS to uniquely identify a transaction.
-
authentDsMerchantName- presence
- Optional
- Interface version
- 2.31
Identifier assigned by the Directory Server to uniquely identify the merchant.
-
eci- presence
- Optional
- Interface version
- 2.31
Electric commerce indicator communicated in the MPI during 3-D Secure payments.
-
authentScoreValue- presence
- Optional
- Interface version
- 2.27
Score value provided by the DS (Directory Server) to the ACS (Access Control Server).
-
authentAmount- presence
- Optional
- Interface version
- 2.37
Authentication amount.
-
authentThreedsServerTransId- presence
- Optional
- Interface version
- 2.35
Universal transaction identifier assigned by the 3DS server to uniquely identify a transaction.
-
authentAcsMethod- presence
- Optional
- Interface version
- 2.31
Authentication method that the ACS applied to authenticate the cardholder.
List of values
01- STATIC_PASSCODE
02- SMS_OTP
03- KEY_FOB_OR_EMV_CARD_READER_OTP
04- APP_OTP
05- OTP_OTHER
06- KBA
07- OOB_BIOMETRICS
08- OOB_LOGIN
09- OOB_OTHER
10- OTHER
-
txStatus- presence
- Optional
- Interface version
- 2.0
Result of the authentication communicated in the MPI during 3-D Secure payments.
List of values
9- CARD_NOT_ENROLLED
A- ATTEMPT
C- CHALLENGE
D- DECOUPLED_AUTHENTICATION
E- AUTHENTICATED_WITHOUT_CRYPTO
I- INFO_ONLY
N- NOT_AUTHENTICATED
R- AUTHENTICATION_REJECTED
U- ERROR
Y- AUTHENTICATED_WITH_CRYPTO
-
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.
-
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.
-
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.
-
title- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone- presence
- Optional
- Interface version
- 2.23
Holder’s business phone number.
-
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
-
cardCSCValue- presence
- Optional
- Interface version
- 2.3
Visual card security code on the bank card transmitted in the authorisation request (CSC, Card Security Code, referred to as CVV for Visa, CVC for Mastercard and 4DBC for American Express).
-
cscType- presence
- Optional
- Interface version
- 2.32
Format of the CSC (Card Security Code) provided in the data cardCscValue
List of values
CSE- The CSC (Card Security Code) provided is encrypted by the CSE (Client Side Encryption) Javascript library
PLAIN- The CSC (Card Security Code) is provided in clear text. It is the default value
-
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.
-
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.
-
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.
-
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.
-
title- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone- presence
- Optional
- Interface version
- 2.23
Holder’s business phone number.
-
customerData- presence
- Optional
- Interface version
- 2.1
Contains the customer’s information.
Contains
-
birthCity- presence
- Optional
- Interface version
- 2.1
Birthplace.
-
birthCountry- presence
- Optional
- Interface version
- 2.1
Country of birth.
-
birthZipCode- presence
- Optional
- Interface version
- 2.1
Postal code for the birth.
-
birthDate- presence
- Optional
- Interface version
- 2.1
Date of birth.
-
loyaltyIndicator- presence
- Optional
- Interface version
- 2.51
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.1
Country of nationality.
-
newPassword- presence
- Optional
- Interface version
- 2.1
Customer’s new password.
-
password- presence
- Optional
- Interface version
- 2.1
Password.
-
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.15
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
-
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.
-
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.
-
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.
-
title- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone- presence
- Optional
- Interface version
- 2.23
Holder’s business phone number.
-
deliveryData- presence
- Optional
- Interface version
- 2.19
Contains the delivery information.
Contains
-
deliveryAddressCreationDate- presence
- Optional
- Interface version
- 2.23
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.19
Total shipping costs for the order.
-
deliveryMethod- presence
- Optional
- Interface version
- 2.19
Method chosen for delivery (standard, priority, …).
-
deliveryMode- presence
- Optional
- Interface version
- 2.19
Mode of the delivery (Post Office, in a participating store, …).
List of values
BILLING_ADDRESSDIGITAL_GOODSEVENT_TICKETSOTHEROTHER_ADDRESSSHIP_TO_STOREVERIFIED_ADDRESS
-
deliveryOperator- presence
- Optional
- Interface version
- 2.19
Name of the carrier ensuring the delivery.
-
electronicDeliveryIndicator- presence
- Optional
- Interface version
- 2.23
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.19
Estimated delivery date by the merchant.
-
estimatedDeliveryDelay- presence
- Optional
- Interface version
- 2.19
Estimated delivery delay (in days) by the merchant.
-
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.27
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.23
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.23
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.23
Availability of the goods.
List of values
false- Boolean indicator is false
true- Boolean indicator is true
-
reorderProductIndicator- presence
- Optional
- Interface version
- 2.23
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.
-
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.
-
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.
-
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.
-
title- presence
- Optional
- Interface version
- 2.0
Title of the contact.
-
workphone- presence
- Optional
- Interface version
- 2.23
Holder’s business phone number.
-
holderData- presence
- Optional
- Interface version
- 2.17
Contains the payment mean holder’s information.
Contains
-
birthCity- presence
- Optional
- Interface version
- 2.1
Birthplace.
-
birthCountry- presence
- Optional
- Interface version
- 2.1
Country of birth.
-
birthZipCode- presence
- Optional
- Interface version
- 2.1
Postal code for the birth.
-
birthDate- presence
- Optional
- Interface version
- 2.1
Date of birth.
-
loyaltyIndicator- presence
- Optional
- Interface version
- 2.51
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.1
Country of nationality.
-
newPassword- presence
- Optional
- Interface version
- 2.1
Customer’s new password.
-
password- presence
- Optional
- Interface version
- 2.1
Password.
-
initialAuthenticationData- presence
- Optional
- Interface version
- 2.49
Contains the information on the initial cardholder’s authentication (CIT).
Contains
-
initialAuthentDateTime- presence
- Optional
- Interface version
- 2.49
UTC date and time of the initial authentication.
-
initialChallengeMode3DS- presence
- Optional
- Interface version
- 2.49
Holder authentication level requested on initial transaction.
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
-
initialHolderAuthentProgram- presence
- Optional
- Interface version
- 2.49
Authentication program on initial transaction
List of values
1EUROCOM- Cofidis Pay 5x10x20x authentication
3DS- 3-D Secure authentication
3DS_V2- 3-D Secure v2 authentication program. This value is accepted for the following versions Since the version 2.24 for Sogenactif Paypage Since the version 2.24 for Sogenactif Office Serveur Since the version 2.5 for Sogenactif In-App
APPLEPAY- Apple Pay authentication
BCMCMOBILE- BCMC authentication
MASTERPASS- MasterPass authentication
NOT_SPECIFIED- No specified authentication program
NO_AUTHENT- Equivalent to NO_AUTHENT_METHOD it is an alternative value used in the transaction report
NO_AUTHENT_METHOD- no authentication program
PAYLIB- Paylib authentication
SAMSUNGPAY- Samsung Pay authentication
THREE_DS- Equivalent to 3DS it is an alternative value used in the transaction report
-
initialHolderAuthentType- presence
- Optional
- Interface version
- 2.49
Cardholder authentication type applied by the issuer of the card on initial transaction. Field valued in 3-D Secure v2.
List of values
CHALLENGE- Authentication on challenge flow (redirection of authentication pages to cardholder)
FRICTIONLESS- Authentication on frictionless flow
FRICTIONLESS_DELEGATE- Deprecated - Authentication on delegated frictionless flow (DS manage the authentication instead of issuer in case of technical issues
NONE- No authentication could be implemented
-
initialSchemeTransactionIdentifier- presence
- Optional
- Interface version
- 2.33
Transaction reference used to perform MIT-CIT chaining.
-
intermediateServiceProviderId- presence
- Optional
- Interface version
- 2.12
Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
-
invoiceReference- presence
- Optional
- Interface version
- 2.0
Invoice reference.
-
merchantLocationId- presence
- Optional
- Interface version
- 2.48
Merchant data identifying the location of his shop.
-
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)
-
orderContext- presence
- Optional
- Interface version
- 2.19
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.19
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.19
Phone number that customer used to checkout captured automatically by the merchant.
-
customerANIInformationIdentifier- presence
- Optional
- Interface version
- 2.19
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.19
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.
-
paymentMeanBrand- presence
- Optional
- Interface version
- 2.36
Name of the payment method that is used. It is related to one paymentMeanType.
List of values
1EUROCOM- Cofidis Pay 5x10x20x Acquisition contract: ONLINE_CREDIT
3XCBCOFINOGA- Depreciated. Cofinoga 3xCB paymentMeanBrandType: CARD
ACCEPTGIRO- AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
AIRPLUS- Airplus card paymentMeanBrandType: CARD
AIRPLUS_LOGEE- Airplus card paymentMeanBrandType: CARD
AMEX- American Express card paymentMeanBrandType: CARD
AMEX_LOGEE- American Express card paymentMeanBrandType: CARD
AURORE- CPAY card paymentMeanBrandType: CARD
BCACB_3X- Payment in 3 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
BCACB_4X- Payment in 4 times with Floa Bank CB paymentMeanBrandType: ONLINE_CREDIT
BCACUP- CUP card of Floa Bank paymentMeanBrandType: CARD
BCMC- Bancontact card paymentMeanBrandType: CARD
CACF_3X- CACF payment in 3 installments paymentMeanBrandType: ONLINE_CREDIT
CACF_3XSANSFRAIS- CACF payment in 3 installments free of charge paymentMeanBrandType: ONLINE_CREDIT
CACF_4X- CACF payment in 4 installments paymentMeanBrandType: ONLINE_CREDIT
CACF_4XSANSFRAIS- CACF payment in 4 installments free of charge 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- Carte Diners club international paymentMeanBrandType: CARD
FRANFINANCE_3X- Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
FRANFINANCE_4X- Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
GIROPAY- Giropay paymentMeanBrandType: CREDIT_TRANSFER
ILLICADO- Illicado paymentMeanBrandType: CARD
INCASSO- Incasso paymentMeanBrandType: DIRECT_DEBIT
INGHOMEPAY- PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER
JCB- Carte Japan Credit Bureau paymentMeanBrandType: CARD
LEPOTCOMMUN- Le Pot Commun paymentMeanBrandType: CARD
LYDIA- Lydia paymentMeanBrandType: PROVIDER
MAESTRO- Maestro card (Mastercard) paymentMeanBrandType: CARD
MASTERCARD- Mastercard card paymentMeanBrandType: CARD
MASTERPASS- Deprecated - MasterPass paymentMeanBrandType:
ONEY34X- Payment in 3 or 4 times with Oney paymentMeanBrandType: ONLINE_CREDIT
PAYLIB- Paylib paymentMeanBrandType:
PAYPAL- Paypal paymentMeanBrandType: WALLET
PAYTRAIL- Paytrail paymentMeanBrandType: CREDIT_TRANSFER
PAY_BY_BANK- SEPA credit transfer paymentMeanBrandType: CREDIT_TRANSFER
SEPA_DIRECT_DEBIT- SDD (SEPA Direct Debit) paymentMeanBrandType: DIRECT_DEBIT
SOFINCO- Sofinco card paymentMeanBrandType: CARD
UNKNOWN- Unknown payment mean (this value can be returned by Sogenactif but must not be used in a request)
VISA- Visa card paymentMeanBrandType: CARD
VISACHECKOUT- Deprecated - Visa Checkout wallet paymentMeanBrandType: WALLET
VISA_ELECTRON- Carte Visa Electron paymentMeanBrandType: CARD
VPAY- VPAY card (Visa) paymentMeanBrandType: CARD
-
paymentMeanBrandSelectionStatus- presence
- Optional
- Interface version
- 2.38
Status of the processing of the brand application selection on paypage.
List of values
APPLIED_DEFAULT- The cardholder accepted the default merchant choice
APPLIED_HOLDER- The cardholder selected a card brand different from the default merchant choice
Empty- Transaction not processed according to the payment mean brand selection rules
NOT_APPLICABLE- Card number filled is not a cobadged card
-
paymentMeanData- presence
- Optional
- Interface version
- 2.17
Contains specific information regarding the payment method used by the buyer.
Contains
-
bcmcMobile- presence
- Optional
- Interface version
- 2.21
Contains specific information on Bancontact Mobile.
Contains
-
completionRedirectUrl- presence
- Optional
- Interface version
- 2.21
Optional URL for Bancontact mobile application that can be used as Merchant Callback URL for notifications. It is triggered by the Payer Mobile Payment Application once the Payer had reviewed the transaction results in its Mobile Payment Application.
-
defaultRedirectUrl- presence
- Optional
- Interface version
- 2.21
Optional URL for Bancontact mobile application that can be used as Merchant Callback URL for notifications. It can be triggered if the transaction is not completed, or if the connection between the Mobile Payer Payment Application and its Transaction Manager Issuing is lost later during the transaction.
-
cofinoga3xcb- presence
- Optional
- Interface version
- 2.17
Depreciated data. Contains specific information on Cofinoga 3xCB payment method.
Contains
-
creditIndicator- presence
- Optional
- Interface version
- 2.17
Credit indicator specifies the choice of payment by the holder or commercial operation of the acceptor
-
cofinoga- presence
- Optional
- Interface version
- 2.17
Depreciated data. Contains specific information on Cofinoga payment method.
Contains
-
settlementMode- presence
- Optional
- Interface version
- 2.17
Settlement mode chosen by the buyer. The values of this field should be acquirer’s native codes. Any convertion is done by Sogenactif.
-
bcaCup- presence
- Optional
- Interface version
- 2.17
Contains specific information on the CUP Card means of payment from Floa Bank.
Contains
-
settlementMode- presence
- Optional
- Interface version
- 2.17
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.
-
initialAuthenticationCavv- presence
- Optional
- Interface version
- 2.38
Initial authentication Cavv value.
-
payeeCardNumber- presence
- Optional
- Interface version
- 2.38
P2P payment recipient card number.
-
payeeHolderName- presence
- Optional
- Interface version
- 2.38
Name of the cardholder who is beneficiary of the P2P payment.
-
paypal- presence
- Optional
- Interface version
- 2.17
Contains specific information on PayPal payment method.
Contains
-
orderDescription- presence
- Optional
- Interface version
- 2.17
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.
-
deliveryAddressStatus- presence
- Optional
- Interface version
- 2.17
Status of the delivery address.For example: confirmed, unconfirmed.
-
payerStatus- presence
- Optional
- Interface version
- 2.17
Status of payer. For exemple, Paypal may return verified, unverified.
-
payerBusiness- presence
- Optional
- Interface version
- 2.17
Payer’s business name.
-
dupDesc- presence
- Optional
- Interface version
- 2.17
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.17
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.17
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.17
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
-
paymentStatus- presence
- Optional
- Interface version
- 2.17
Indicates whether the Sogenactif transaction has been reconciled with one acquirer movement of from RGI and MPI .the acquisition of payments (statement from your acquirer).
List of values
KO- Association not possible. The transaction was not matched on time
OK- Transaction successfully matched
-
payerId- presence
- Optional
- Interface version
- 2.17
Unique buyer account identification in the issuer of payment.
-
payerSuffix- presence
- Optional
- Interface version
- 2.17
Suffix of payer.
-
dupCustom- presence
- Optional
- Interface version
- 2.17
Paypal Field left free for the merchant, taken into account when dupFlag is set to “true”
-
dupType- presence
- Optional
- Interface version
- 2.17
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.17
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
-
token- presence
- Optional
- Interface version
- 2.17
Payor’s token used for a payment Paypal.
-
paymentToken- presence
- Optional
- Interface version
- 2.35
Hosted Fields payment token to be sent when making calls to Sogenactif Office Serveur and allowing you to find card payment information for classic or 3-D Secure payment, by wallet or not.
-
recurringData- presence
- Optional
- Interface version
- 2.37
Contains data relating to the due dates of a recurring payment.
Contains
-
recurringEndDate- presence
- Optional
- Interface version
- 2.37
Date of the last scheduled payment due N-times.
-
recurringPeriod- presence
- Optional
- Interface version
- 2.37
Minimum period between two installments expressed in number of days (payment N-times).
-
recurringSequence- presence
- Optional
- Interface version
- 2.37
Sequence number of the current due date being created (1 when ordering the N-times payment or when setting up the subscription).
-
recurringSequenceMax- presence
- Optional
- Interface version
- 2.37
Total number of payment due N-times.
-
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.
-
s10TransactionReference- presence
- Optional
- Interface version
- 2.6
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.6
- 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.6
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.12
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
-
settlementArchivingReference- presence
- Optional
- Interface version
- 2.33
Data provided to the acquirer for processing settlements and reconciliations. By default generated by the Sogenactif platform. Its supply by the merchant is subject to strong constraints. Contact Sogenactif to use this data in requests.
-
settlementMerchantSpecificData- presence
- Optional
- Interface version
- 2.33
Specific data provided by the merchant and transmitted to the acquirer for processing remittances. To use this data, please contact Sogenactif.
-
shoppingCartDetail- presence
- Optional
- Interface version
- 2.19
Information specific to the basket.
Contains
-
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
-
mainProduct- presence
- Optional
- Interface version
- 2.19
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.19
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.19
Information specific to an item of the basket.
Contains
-
productName- presence
- Optional
- Interface version
- 2.19
Name of the ordered product.
-
productUnitTaxAmount- presence
- Optional
- Interface version
- 2.19
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.19
Detailed description of the ordered product.
-
productSKU- presence
- Optional
- Interface version
- 2.19
Merchant’s product identifier code, sent back in the response without modification.
-
productQuantity- presence
- Optional
- Interface version
- 2.19
Quantity of products in the shopping cart.
-
productTaxRate- presence
- Optional
- Interface version
- 2.19
Tax rate for the product. For decimal numbers, use a dot instead of a comma (eg. 0.1999).
-
productUnitAmount- presence
- Optional
- Interface version
- 2.19
Unit amount of the product. The amount must be transmitted in the smallest unit of currency.
-
productCode- presence
- Optional
- Interface version
- 2.19
Code of the ordered product.
-
productCategory- presence
- Optional
- Interface version
- 2.19
Category of the ordered product (for example digital).
-
productTaxCategory- presence
- Optional
- Interface version
- 2.19
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.38
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.19
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.19
Total quantity of all products in the basket.
-
shoppingCartTotalTaxAmount- presence
- Optional
- Interface version
- 2.19
Total amount of taxes in the basket.
-
statementReference- presence
- Optional
- Interface version
- 2.2
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.41
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.
-
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.41
MCC Code of the vendor at the Payment Facilitator in a context of Collecting offer or a Marketplace offer.
-
subMerchantId- presence
- Optional
- Interface version
- 2.41
Merchant identifier of the Payment Facilitator in the context of Collecting offer or a Marketplace offer.
-
subMerchantLegalId- presence
- Optional
- Interface version
- 2.41
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.41
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.
-
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.19
Contains specific information regarding the travel.
Contains
-
numberOfRoutingCities- presence
- Optional
- Interface version
- 2.19
Number of routing cities.
-
numberOfAirlineCarriers- presence
- Optional
- Interface version
- 2.19
Number of airline carriers.
-
airlineCarrierList- presence
- Optional
- Interface version
- 2.19
Airline carrier list.
-
departureDate- presence
- Optional
- Interface version
- 2.19
Departure date.
-
destinationAirport- presence
- Optional
- Interface version
- 2.19
Destination airport.
-
reservationCode- presence
- Optional
- Interface version
- 2.19
Reservation code.
-
passengerName- presence
- Optional
- Interface version
- 2.19
Passenger name.
-
routingCityList- presence
- Optional
- Interface version
- 2.19
Routing city list.
-
fareBasis- presence
- Optional
- Interface version
- 2.38
Fare Basis. Example: business class, economy class, …
-
originAirport- presence
- Optional
- Interface version
- 2.19
Origin airport.
-
numberOfPassengers- presence
- Optional
- Interface version
- 2.19
Number of passengers.
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
-
acceptanceSystemApplicationId- presence
- Optional
- Interface version
- 2.20
Identifier of the ultimate Sogenactif application used for transmitting the authorisation request.This data value is transmitted to the acquirer as it is received within both the authorisation request and the remittance request. It is named ITP (identifiant d’application terminal au point d’acceptation) in the CB2A protocole.
-
acquirerResponseCode- presence
- Optional
- Interface version
- 2.0
Response code returned by the acquirer during an authorisation request.
List of values
00- Transaction approved or processed successfully
02- Contact payment mean issuer
03- Invalid acceptor
04- Keep the payment mean
05- Do not honour
07- Keep the payment mean, special conditions
08- Approve after identification
12- Invalid transaction
13- Invalid amount
14- Invalid PAN
15- Unknown payment mean issuer
17- Payment aborted by the buyer
20- Invalid response (error in server domain)
24- Operation not authorised
25- Transaction not found
30- Format error
31- Id of the acquiring organisation unknown
33- payment mean expired (Paypal / Cofidis)
34- Fraud suspicion
40- Function not supported
41- Payment mean lost
43- Payment mean stolen
51- Insufficient or exceeded credit
54- Payment mean expired (CB / Visa / MC / WLAcq / BCMC)
55- Wrong PIN
56- Payment mean missing from the file
57- Transaction unauthorised for this payment mean holder
58- Transaction forbidden to the terminal
59- Fraud suspicion
60- The payment mean acceptor must contact the acquirer
61- Exceeds the amount limit
62- Transaction awaiting payment confirmation
63- Security rules not complied with
65- Allowed number of daily transactions has been exceeded
68- Response not received or received too late
75- Exceeded number of PAN attempts
87- Terminal unknown
90- System temporarily stopped
91- Payment mean issuer inaccessible
92- The transaction does not contain enough information to be routed to the authorizing agency
93- Transaction cannot be completed: violation of law
94- Duplicated transaction
96- System malfunction
97- Request time-out; transaction refused
98- Server unavailable; network routing requested again
99- Incident with initiator domain
A1- Transaction refused because the 3-D Secure authentication data is missing
A4- Transaction refused because the 3-D Secure authentication exemption is misused
R1- the cardholder (or his bank) has revoked recurring payments made at a merchant
R3- the cardholder (or his bank) has revoked all recurring payments
-
acquirerResponseMessage- presence
- Optional
- Interface version
- 2.20
Acquirer response message to the originator of the transaction (for example, message to be displayed to the holder or the cashier)..
-
authorMessageReference- presence
- Optional
- Interface version
- 2.19
Identifier shared with the acquirer during the authorisation process.For example, this reference data could be sent by the acquirer in the authorisation response, then sent (unchanged) in a subsequent authorisation reversal message, to the extent that the acquirer is able to match a reversal message to the associated response message.
-
authorisationId- presence
- Optional
- Interface version
- 2.0
Authorisation ID returned by the acquirer if the authorisation request is accepted.
-
authorisationTypeLabel- presence
- Optional
- Interface version
- 2.19
Label of the authorisation request type.
List of values
DEMANDE_DE_RENSEIGNEMENT- Ask for information
TRANSACTION_DE_PAIEMENT- Payment transaction
-
avsAddressResponseCode- presence
- Optional
- Interface version
- 2.17
Contains the result of the AVS ADDRESS check.
List of values
0- No data was provided
1- No check has been done
2- Check successful
4- Check failed
8- Partial check
-
avsPostcodeResponseCode- presence
- Optional
- Interface version
- 2.17
Contains the result of the AVS POSTCODE check.
List of values
0- No data was provided
1- No check has been done
2- Check successful
4- Check failed
8- Partial check
-
captureDay- presence
- Optional
- Interface version
- 2.15
Deadline for settlement.
-
captureLimitDate- presence
- Optional
- Interface version
- 2.35
Date from which the transaction will be sent for settlement. Beyond this date, the merchant can no longer validate or cancel the transaction.
-
captureLimitDateTime- presence
- Optional
- Interface version
- 2.35
Date and time from which the transaction will be sent for settlement. Beyond this date, the merchant can no longer validate or cancel the transaction.
-
captureMode- presence
- Optional
- Interface version
- 2.15
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
-
cardCSCResultCode- presence
- Optional
- Interface version
- 2.17
Response code for the Card Security Code check returned in the authorisation response.
List of values
4D- Incorrect cryptogram
4E- Correct cryptogram
50- Cryptogram not processed
53- Cryptogram missing in the authorisation request
55- The Internet user’s bank is not certified; the control could not be performed
Empty- The Internet user’s bank has not responded
NO- No cryptogramme on the card
-
cardData- presence
- Optional
- Interface version
- 2.9
Contains specific information regarding a card
Contains
-
cardBrand- presence
- Optional
- Interface version
- 2.9
Please see “paymentMeanBrand”.
-
cardCorporateIndicator- presence
- Optional
- Interface version
- 2.9
Indicates whether the card is an Enterprise / Commercial card or not.
List of values
Empty- Unknown
N- The card is not a corporate card
Y- The card is a corporate card
-
cardEffectiveDateIndicator- presence
- Optional
- Interface version
- 2.9
Indicator of existence of a card effective date (Y/N/Empty)
-
cardPanType- presence
- Optional
- Interface version
- 2.52
PAN type sent on authentication / authorisation / settlement
List of values
DPAN- Digital PAN
PAN- Real PAN
-
cardProductCode- presence
- Optional
- Interface version
- 2.9
Product code of the card.
-
cardProductName- presence
- Optional
- Interface version
- 2.9
Product name of the card.
-
cardProductProfile- presence
- Optional
- Interface version
- 2.9
Profile code of the card.
List of values
C- Credit (pay after)
D- Debit (pay now)
Empty- Unknown
H- Charge card (UK specific)
N- Non-Mastercard
P- Prepaid
R- Deffered debit
U- Universal
-
cardProductUsageLabel- presence
- Optional
- Interface version
- 2.19
Profile name of the card which is displayed on payment electronic ticket in accordance with MPADS requirements.
List of values
COMMERCIAL- Business card
CREDIT- Credit card
DEBIT- Debit card
PREPAID- Prepaid card
-
cardScheme- presence
- Optional
- Interface version
- 2.0
Network name associated with the card.
List of values
ACCORD- Accord scheme
AMEX- American Express scheme
BCMC- Bancontact scheme
CB- Bank Card scheme
MASTERCARD- Mastercard scheme (Example of cards on the Mastercard scheme: Mastercard, Maestro)
SOFINCO- Sofinco scheme
VISA- Visa scheme (Example of cards on the Visa scheme: Visa, Vpay, Visa Electron)
-
cardSeqNumberIndicator- presence
- Optional
- Interface version
- 2.9
Indicator of existence of an issue number
List of values
1- Card issue number of length 1
2- Card issue number of length 2
3- Card issue number of length 3
Empty- Unknown
N- No card issue number
-
issuerCode- presence
- Optional
- Interface version
- 2.9
Issuer code of the card. This data is called cardIssuerCode in the reports.
-
issuerCountryCode- presence
- Optional
- Interface version
- 2.9
Country code of the card issuer. This data is called cardIssuerCountryCode in the reports.
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
-
issuerName- presence
- Optional
- Interface version
- 2.9
Issuer name of the card. This data is called cardIssuerName in the reports.
-
issuerRegionCode- presence
- Optional
- Interface version
- 2.9
region code of the card issuer
List of values
1- USA: California, Hawaii, Nevada
2- USA: West except California, Hawaii, Nevada
3- USA: Central North
4- USA: Central South
5- USA: Great Lakes states
6- USA: South East
7- USA: Extreme North East
8- USA: North East
9- USA: Florida and Georgia
A- Canada
B- South America
C- Oceania Asia
D- Europe
E- Africa and middle east
Empty- Unknown
-
issuingCountryCode- presence
- Optional
- Interface version
- 2.44
Country code in which the card has been issued. This data is called cardIssuingCountryCode in the reports.
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
-
panCheckAlgorithm- presence
- Optional
- Interface version
- 2.9
Control algorithm applied on the PAN (L/V/N/Empty)
List of values
Empty- Unknown PAN control algorithm
L- PAN control with Lühn Key algorithm
N- No PAN control algorithm
V- PAN control with Visa Modulus 10 algorithm
-
panLengthMax- presence
- Optional
- Interface version
- 2.9
Maximum length of the PAN
-
panLengthMin- presence
- Optional
- Interface version
- 2.9
Minimal length of the PAN
-
virtualCardIndicator- presence
- Optional
- Interface version
- 2.35
Indicates whether the card is a virtual card
List of values
Empty- Unknown
N- The card is not a virtual card
Y- The card is a virtual card
-
cardExpiryDate- presence
- Optional
- Interface version
- 2.41
Card expiry date. If the card does not have any expiry date, this field is empty.
-
cardScheme- presence
- Optional
- Interface version
- 2.0
Network name associated with the card.
List of values
ACCORD- Accord scheme
AMEX- American Express scheme
BCMC- Bancontact scheme
CB- Bank Card scheme
MASTERCARD- Mastercard scheme (Example of cards on the Mastercard scheme: Mastercard, Maestro)
SOFINCO- Sofinco scheme
VISA- Visa scheme (Example of cards on the Visa scheme: Visa, Vpay, Visa Electron)
-
complementaryCode- presence
- Optional
- Interface version
- 2.0
Additional response code from the Sogenactif server returned in the response. This field is only filled out if you have signed up for additional checks for the Sogenactif e-payment solution.
List of values
00- All controls that you adhered to have been successfully completed Fraud Rule: All
02- The card used has exceeded the authorised balance limit Fraud Rule: Card Velocity
03- The card used is on the merchant’s “grey list” Fraud Rule: Card number grey list
04- Deprecated value. The postal code used is on the merchant’s “grey list” Fraud Rule: Postal code grey list
05- Deprecated value. The BIN of the card used belongs to a range which is not referenced on Sogenactif platform BIN table Fraud Rule: Card country / Commercial card (and card country)
06- The country code related to the card number is not on the list of countries allowed by the merchant Fraud Rule: Card country
07- Virtual card (e-card) detected Fraud Rule: Virtual card
08- The card BIN is present in a range on the merchant’s “grey list” Fraud Rule: BIN range grey list
09- Deprecated value. Unknown country IP Fraud Rule: IP address country
10- Denied country IP Fraud Rule: IP address country
11- Card in hot/black list Fraud Rule: Hot list
12- Country card / IP address country combination denied Fraud Rule: IP and card country
13- Deprecated value. Unknown country IP or card. The country code cannot be determined from the card number Fraud Rule: Combination of card and IP address country
14- Systematic authorisation card Fraud Rule: Systematic authorisation card
15- Deprecated value. Unknown BIN (on control of systematic authorisation card) Fraud Rule: Systematic authorisation card
16- IP address in progress exceeded Fraud Rule: IP address velocity
17- Blocking related the status of the 3-D Secure authentication process Fraud Rule: 3-D Secure authentication
18- The card number is a commercial card number Fraud Rule: Commercial card
19- The card number is not part of the CB scheme Fraud Rule: CB scheme card
20- Customer ID in progress exceeded Fraud Rule: Customer ID velocity
21- Maximum number of customer ID per card exceeded Fraud Rule: Number of customers per card
22- Maximum number of cards per customer ID exceeded Fraud Rule: Number of cards per customer
23- The card is going to expire Fraud Rule: Card expiry date
24- For futur use
25- The amount violates one of the defined boundaries Fraud Rule: Cap collar Amounts
26- Delivery postal code and billing postal code are different Fraud Rule: Delivery and billing postal code
27- At least one of email addresses provided is contained in a list of suspicious domain names Fraud Rule: Free e-mail address
28- Customer identifier is on the merchant’s “black list” Fraud Rule: Customer ID black list
29- Customer identifier is on the merchant’s “grey list” Fraud Rule: Customer ID grey list
30- Delivery country and billing country are different Fraud Rule: Delivery and billing country
31- At least one of email addresses provided is on the merchant’s “black list” Fraud Rule: E-mail address black list
32- At least one of email addresses provided is on the merchant’s “grey list” Fraud Rule: E-mail address grey list
33- At least one of phone number provided is on the merchant’s “black list” Fraud Rule: Phone number black list
34- At least one of phone number provided is on the merchant’s “grey list” Fraud Rule: Phone number grey list
35- At least one of contact name provided is on the merchant’s “black list” Fraud Rule: Customer name black list
36- At least one of contact name provided is on the merchant’s “grey list” Fraud Rule: Customer name grey list
37- Buyer’s IP address is on the merchant’s “black list” Fraud Rule: IP address black list
38- Buyer’s IP address is on the merchant’s “grey list” Fraud Rule: IP address grey list
39- The country / postal code combination is on the merchant’s “black list” Fraud Rule: Postal code black list
3L- Reason of the refusal of the transaction which is the transaction is not guaranteed by any entity (acquirer, wallet provider, etc.) Fraud Rule: Authent guarantee
40- The country / postal code combination is on the merchant’s “grey list” Fraud Rule: Postal code grey list
41- The card BIN is present in a range on the merchant’s “black list” Fraud Rule: BIN range black list
42- Card country / delivery country combination denied Fraud Rule: Delivery and card country
43- The card number is a commercial card number and the issuing country is not associated to a country accepted by the merchant Fraud Rule: Commercial card (and card country)
44- IP address of the buyer denied Fraud Rule: IP address reputations
45- Number of different cards allowed for a given IP address. Fraud Rule: Number of cards per IP address
46- The email address format provided is incorrect Fraud Rule: E-mail address syntax
47- Card country / billing country combination denied Fraud Rule: Billing and card country
50- The card used is on the merchant’s “black list” Fraud Rule: Card number black list
51- At least one product in the basket is on a risky product list Fraud Rule: Risky product list
52- The quantity of risky products in the basket exceeds the allowed quantity Fraud Rule: Risky product quantity
53- The ration of risky products/total amount of the basket exceeds the allowed ratio Fraud Rule: Risky product ratio
54- The quantity of products in the basket exceeds the allowed quantity Fraud Rule: Product quantity
55- Simple mode: the IBAN country code is not allowed. Advanced mode: the IBAN country is disadvantaged or advantaged. Fraud Rule: IBAN country
56- Simple mode: the delivery country and IBAN country combination is not allowed. Advanced mode: the delivery country and IBAN country combination is disadvantaged or advantaged. Fraud Rule: Delivery and IBAN country
57- Simple mode: the phone number country and IBAN country combination is not allowed. Advanced mode: the phone number country and IBAN country combination is disadvantaged or advantaged. Fraud Rule: Phone number and IBAN country
58- Simple mode: the IP country and IBAN country combination is not allowed. Advanced mode: the IP country and IBAN country combination is disadvantaged or advantaged. Fraud Rule: IP address and IBAN country
59- The number of IBANs per IP address exceeds the allowed threshold. Fraud Rule: Number of IBANs per IP address
60- The number of IP addresses per IBAN exceeds the allowed threshold. Fraud Rule: Number of IP addresses per IBAN
61- The number of different customers per IBAN exceeds the allowed threshold. Fraud Rule: Number of customers per IBAN
62- The number of different IBANs per customer exceeds the allowed threshold. Fraud Rule: Number of IBANs per customer
63- The number of mandates per IP address exceeds the allowed threshold. Fraud Rule: Number of mandates per IP address
64- Too many transactions/Excessive amount spent for the mandate used. Fraud Rule: Mandate velocity
65- Too many transactions/Excessive amount spent for the IBAN used. Fraud Rule: IBAN velocity
66- The BIC is in your “blacklist”. Fraud Rule: BIC blacklist
67- The BIC is in the your “greylist”. Fraud Rule: BIC greylist
68- The IBAN is in your “blacklist”. Fraud Rule: IBAN blacklist
69- The IBAN is in your “greylist”. Fraud Rule: IBAN greylist
70- The mandate is in your “blacklist”. Fraud Rule: Mandate blacklist
71- The mandate is in your “greylist”. Fraud Rule: Mandate greylist
72- Prepaid carte detected Fraud rule: Prepaid card
73- Invalid issuer country. Fraud rule: Card issuing country
74- Invalid billing and card issuing country combinaison. Fraud rule: Card issuing and billing country
75- Invalid shipping and card issuing country combinaison. Fraud rule: Card issuing and delivery country
76- Invalid ip card and issuing country combinaison. Fraud rule: Card issuing and IP country
77- Commercial card with invalid issuing country. Fraud rule: Commercial card (and card issuing country)
99- the Sogenactif server encountered a problem during the processing of one of the additional local checks Fraud Rule: All
AA- Card number is on the merchant’s “white list” Fraud Rule: Card number white list
AB- Customer identifier is on the merchant’s “white list” Fraud Rule: Customer ID white list
AC- At least one of email addresses provided is on the merchant’s “white list” Fraud Rule: E-mail address white list
AD- At least one of phone number provided is on the merchant’s “white list” Fraud Rule: Phone number white list
AE- Buyer’s IP address is on the merchant’s “white list” Fraud Rule: IP address white list
AF- At least one of contact name provided is on the merchant’s “white list” Fraud Rule: Customer name white list
AG- The country / postal code combination is on the merchant’s “white list” Fraud Rule: Postal code white list
AH- The card BIN is present in a range on the merchant’s “white list” Fraud Rule: BIN Range white list
AI- The BIC is on your “whitelist” Fraud Rule: BIC whitelist
AJ- The customer’s BIC is on your “whitelist” Fraud Rule: IBAN whitelist
AK- The customer’s SDD mandate is on your “whitelist” Fraud Rule: Mandate whitelist
Empty- No control performed Fraud Rule: No rules
-
complementaryInfo- presence
- Optional
- Interface version
- 2.0
Additional information from the Sogenactif server sent back in the response.
-
customerAccountData- presence
- Optional
- Interface version
- 2.47
Contains the bank account data of the payer
Contains
-
customerAccount- presence
- Optional
- Interface version
- 2.47
Account number of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg IBAN …).
-
customerBankAccountType- presence
- Optional
- Interface version
- 2.47
Format of the customer bank code and account.
List of values
BIC_IBAN- The customer bank code and account are in BIC and IBAN format.
NATIONAL_DEU- The customer bank code and account are in domestic Germany codification.
NOT_SPECIFIED- The customer bank type is unknown
-
customerBankCode- presence
- Optional
- Interface version
- 2.47
Bank code of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg BIC …).
-
errorFieldName- presence
- Optional
- Interface version
- 2.21
Error field name of the incoming request. Present when responseCode = 12 or 30.
-
guaranteeIndicator- presence
- Optional
- Interface version
- 2.20
Transaction’s guarantee level.
List of values
E- Eligible to the guarantee (applicable for payments delivered upon shipping and in several shipments with CB) Method Payment: 3-D Secure card
Empty- The guarantee has not been calculated Method Payment: Card
N- The guarantee is not applicable Method Payment: 3-D Secure card
U- The guarantee is not defined Method Payment: 3-D Secure card
Y- The guarantee is applicable Method Payment: 3-D Secure card
-
guaranteeLimitDateTime- presence
- Optional
- Interface version
- 2.32
Deadline for application of the payment guarantee.
-
holderAuthentRelegationCode- presence
- Optional
- Interface version
- 2.20
Code indicating whether the issuer accepts or refuses the transfer of responsibility.
List of values
N- Transfer of responsibility accepted
Y- Transfer of responsibility refused
-
holderAuthentStatus- presence
- Optional
- Interface version
- 2.20
Result of the authentication process.
List of values
3D_ABORT- The buyer has abandoned the transaction during the process of authentication. Currently, this status is only possible in the case of a PAYLIB payment.
3D_ATTEMPT- The merchant and the cardholder are both enrolled in the authentication programme, but the buyer did not have to be authenticated (the server access control of the bank that issued the card, only implements the generation of an authentication attempt proof). This case can also occur when the DS replies instead of the ACS when the ACS is unavailable.
3D_BYPASS- According to certain criteria set by the merchant, the authentication programme checks were bypassed.
3D_ERROR- The merchant participates in the authentication programme but the Sogenactif server encountered a technical problem during the authentication process (when checking the registration card to the authentication programme or during authentication of the holder).
3D_FAILURE- The merchant and the cardholder are both enrolled in the authentication programme, but the buyer failed to authenticate (wrong password).
3D_NOTENROLLED- The merchant participates in the authentication programme, but the cardholder’s card is not enrolled.
3D_SUCCESS- The merchant and the cardholder are both enrolled in the authentication programme and the cardholder has successfully authenticated.
ATTEMPT- The merchant and the cardholder are both enrolled in the authentication programme, but the buyer did not have to be authenticated (the server access control of the bank that issued the card, only implements the generation of an authentication attempt proof). This case can also occur when the DS replies instead of the ACS when the ACS is unavailable.
BYPASS- According to certain criteria set by the merchant, the authentication programme checks were bypassed.
CANCEL- The buyer has abandoned the transaction during the process of authentication. Currently, this status is only possible in the case of a PAYLIB payment.
ERROR- The merchant participates in the authentication programme but the Sogenactif server encountered a technical problem during the authentication process (when checking the registration card to the authentication programme or during authentication of the holder).
FAILURE- The merchant and the cardholder are both enrolled in the authentication programme, but the buyer failed to authenticate (wrong password).
NOT_ENROLLED- The merchant participates in the authentication programme, but the cardholder’s card is not enrolled.
NOT_PARTICIPATING- The buyer has not authenticated to one of the following reasons: - the type of card is not supported by the authentication programm - the merchant is not enrolled in the authentication programm
NOT_SPECIFIED- The status of the holder authentication is not available.
NO_AUTHENT- According to certain criteria set by the merchant, the authentication programme checks were bypassed
NO_AUTHENT_DTA- According to certain criteria set by the merchant, the authentication programme checks were bypassed using Direct to Authorize
SSL- According to certain criteria set by the merchant, the authentication programme checks were bypassed
SUCCESS- The merchant and the cardholder are both enrolled in the authentication programme and the cardholder has successfully authenticated.
-
initialSchemeTransactionIdentifier- presence
- Optional
- Interface version
- 2.39
Transaction reference used to perform MIT-CIT chaining.
-
maskedPan- presence
- Optional
- Interface version
- 2.0
Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.
-
orderId- presence
- Optional
- Interface version
- 2.24
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.
-
paymentAccountReference- presence
- Optional
- Interface version
- 2.31
Reference of the bank account associated to the card used for the payment.
-
paymentMeanBrandSelectionStatus- presence
- Optional
- Interface version
- 2.38
Status of the processing of the brand application selection on paypage.
List of values
APPLIED_DEFAULT- The cardholder accepted the default merchant choice
APPLIED_HOLDER- The cardholder selected a card brand different from the default merchant choice
Empty- Transaction not processed according to the payment mean brand selection rules
NOT_APPLICABLE- Card number filled is not a cobadged card
-
preAuthorisationProfile- presence
- Optional
- Interface version
- 2.13
Name of the applied pre-authorisation profile.
-
preAuthorisationProfileValue- presence
- Optional
- Interface version
- 2.13
Unique identifier of the antifraud profile applied for a transaction in pre-authorisation step. Contrary to the profile name, the unique identifier takes into account the dynamic override and the bypassing of the antifraud rules. This identifier allows to retrieve all executed antifraud rules of a transaction and their setup and could be used in case of dispute.
-
preAuthorisationRuleResultList- presence
- Optional
- Interface version
- 2.13
List containing the result of each executed antifraud rules in pre-authorisation step.
Contains
-
ruleResult- presence
- Optional
- Interface version
- 2.13
Detailed result of the antifraud rule.
Contains
-
ruleCode- presence
- Optional
- Interface version
- 2.13
Identifier of antifraud rule.
-
ruleDetailedInfo- presence
- Optional
- Interface version
- 2.13
Detailed information returned once the antifraud rule executed. For example, for card country rule, the country of the card is returned.
-
ruleResultIndicator- presence
- Optional
- Interface version
- 2.13
Execution indicator of the antifraud rule.
-
ruleSetting- presence
- Optional
- Interface version
- 2.13
Setting up mode of the antifraud rule parameters.
-
ruleType- presence
- Optional
- Interface version
- 2.13
Type of antifraud rule.
-
ruleWeight- presence
- Optional
- Interface version
- 2.13
Weighting of the antifraud rule.
-
reattemptEndDateTime- presence
- Optional
- Interface version
- 2.48
End date of the allowed-reattempt period, where trying again an authorization request on a refused transaction is allowed
-
reattemptMax- presence
- Optional
- Interface version
- 2.48
Maximal number of allowed reattempts during the allowed-reattempt period
-
reattemptMode- presence
- Optional
- Interface version
- 2.48
Condition for a reattempt after a refused authorization.
List of values
LATER- Try again later
NEVER- Never try again
UPDATE- Provide new information before trying again
-
reattemptStartDateTime- presence
- Optional
- Interface version
- 2.48
Start date of the allowed-reattempt period, where trying again an authorization request on a refused transaction is allowed
-
recurringResponseCode- presence
- Optional
- Interface version
- 2.20
Additional information about a recurring payment decline responseApacs is the only protocol to value this data for English acquirers
List of values
0- Non recurring payment or recurring payment accepted
1- New account information available
2- Cannot approve at this time, try again later
4- Do not try again
8- Payment blocked by card scheme
-
responseCode- presence
- Optional
- Interface version
- 2.0
Sogenactif server response code.
List of values
00- Operation accepted
01- For panToToken and tokenToPan methods, partial success
02- Request of authorized on via telephone with the issuer because of exceeding the card authorization threshold
03- Invalid merchant contract
05- Refused authorization
11- Used for differed check. The PAN is blocked
12- Invalid transaction. Please check the request parameters
14- Invalid PAN or payment mean data check is failed (e.g. card number or the visual cryptogram of the card or AVS address)
17- Customer cancellation
24- In response to a cash management operation: operation not authorized. The operation you wish to perform is not compliant with the transaction status or another operation is in progress at the same time
- In response to a payment creation: operation rejected, request already carried out with the same data and the same parameters
25- Transaction unknown by Sogenactif
30- Format error
34- Fraud suspicion (seal erroneous)
40- Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorized
51- Amount too high
54- Payment mean expiry date is past
55- Merchant doesn’t accept prepaid cards
57- Refund operation refused because the original transaction was subject of an unpaid
60- Transaction pending
62- Waiting the confirmation for the transaction (used by PayPal 1.0)
63- Security rules not observed, transaction stopped
75- Number of attempts to enter the data of the payment mean from Sogenactif Paypage is exceeded
90- Service temporarily not available
94- Duplicated transaction: the transactionReference has been used previously
97- Session expired (no action from the user during 15 minutes), transaction refused
99- Temporarily problem with the payment server
-
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.
-
s10TransactionReference- presence
- Optional
- Interface version
- 2.6
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.6
- 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.6
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.
-
schemeTransactionIdentifier- presence
- Optional
- Interface version
- 2.31
Unique reference of the transaction calculated by the SAE (Authorisation server of the issuer) and returned in ther authorisation response.It allows to chain a MIT (Merchant Initiating Transaction) to a origin CIT (Customer Initiating Transaction)(Future use via the field initialSchemeTransactionIdentifier). Clarification on the format which is dependent on protocols and schemes: CB2A: ANS50 (FR acquirer) BXAP: N15 (BE acquirer) AMEX: N15 PAYPAL : ANS56
-
scoreColor- presence
- Optional
- Interface version
- 2.1
Colour associated with the score. Used to give a comparison between the antifraud rules applied on a payment request.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.
List of values
BLACK- Score color black
Empty- No check
GREEN- Score color green
ORANGE- Score color orange
RED- Score color red
WHITE- Score color white
-
scoreInfo- presence
- Optional
- Interface version
- 2.1
Return of the antifraud rule applied after the score is calculated, or ERROR if an error is generated during the check sequence.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.
-
scoreProfile- presence
- Optional
- Interface version
- 2.1
Name associated with the profile used to calculate the transaction score.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.
-
scoreThreshold- presence
- Optional
- Interface version
- 2.1
Thresholds to determine the risk level of a transaction in pre-authorisation step.The Business Score module assigns a score to each transaction qohich indicates the degree of risk you take if you accept the transaction. A color is also associated with this score through the scoreColor field.
-
scoreValue- presence
- Optional
- Interface version
- 2.1
Relative number representing the transaction score. Value of the score Pre-authorization computed by the Fraud engine in Business Score mode.
-
settlementArchivingReference- presence
- Optional
- Interface version
- 2.49
Data provided to the acquirer for processing settlements and reconciliations. By default generated by the Sogenactif platform. Its supply by the merchant is subject to strong constraints. Contact Sogenactif to use this data in requests.
-
tokenPan- presence
- Optional
- Interface version
- 2.1
Unique identifier for a PAN returned by the Sogenactif server via the AWL token server in a merchant-oriented format (the format is a parameter in the merchant’s configuration).
-
transactionDateTime- presence
- Optional
- Interface version
- 2.0
Date and time the transaction was processed on the Sogenactif server. (expressed in the Sogenactif server time zone)
-
transactionPlatform- presence
- Optional
- Interface version
- 2.17
Platform where the transaction has been executed.
List of values
PRE-PROD- Pre-production transaction not sent to remittance
PROD- Production transaction
SIMU- Simulated transaction
UAT- User acceptance test transaction
-
transactionReference- presence
- Optional
- Interface version
- 2.6
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.
Response sample
Changelog
