cardValidateAuthenticationAndOrder

To search in the page use Ctrl+F on your keyboard

Requests for payment finalization and order with a 3-D Secure process.

In this document, unless otherwise stated, any reference to 3-D Secure includes Visa (Verified by Visa), MasterCard (SecureCode) and American Express (SafeKey).

This request is mandatory to perform the payment order with a 3-D Secure context (PARes message). It must be called after you received the POST form from the ACS (Access Control Server) (See Post form to the ACS).

Recommended interfaceVersion: IR_WS_2.55

PROD

https://office-server.sogenactif.com/rs-services/v2/checkout/cardValidateAuthenticationAndOrder

method

POST
TEST

https://office-server-sogenactif.test.sips-services.com/rs-services/v2/checkout/cardValidateAuthenticationAndOrder

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

interfaceVersion
presence

Required

Interface version

2.0
Format
AN20(restricted String)
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

Format

N10

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

Format

N15

Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
messageVersion

presence

Required

Interface version

2.0

Format

ANS20

Parameters version of redirection (used for Sogenactif Office Serveur with redirection).
redirectionData

presence

Required

Interface version

2.0

Format

ANS10240

In case of 3-D Secure payment, contains the context of the transaction retrieved from the cardCheckEnrollment method. In case of 3-D Secure server Standalone, it contains the Payer Authentication Request (PAReq) that the merchant must transmit to ACS for 3-D Secure authentication (format: base 64 encoded).In case of external payment provider, contains the context of the transaction sent by the merchant during the transaction initialisation.
seal

presence

Required

Interface version

2.0

Format

ANS128

Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.

Optional

intermediateServiceProviderId

presence

Optional

Interface version

2.12

Format

AN30

Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
paResMessage

presence

Optional

Interface version

2.0

Format

ANS10240

Payer Authentication Response (PARes) generated by the ACS for the cardholder authentication response and transmitted to the ThreedSecureService service.
s10TransactionReference

presence

Optional

Interface version

2.0

Format

Container

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.0
  
  Format
  
  N6
  
  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.0
  
  Format
  
  N8(YYYYMMDD)
  
  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

Format

ANS20(restricted values)

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
transactionReference

presence

Optional

Interface version

2.0

Format

AN35

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.

Request sample

json
soap

            {
  "interfaceVersion": "IR_WS_2.9",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "messageVersion": "0.1",
  "paResMessage": "eJydVVuTqjgQ....7h%2FwH0CKem",
  "redirectionData": "uqjeV+KegCSM0POI...CjVUfxqyFq7zSYus7E\u003d",
  "transactionReference": "TREFEXA2015",
  "seal": "9565b71cb583f025278de91940c69900dee72d91e8184ddb6547f00927597fd1"
}

                  <urn:cardValidateAuthenticationAndOrder>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2015</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.9</urn:interfaceVersion>
            <urn:redirectionData>RSs7cZyL1DqsV... 9P15xVe</urn:redirectionData>
            <urn:messageVersion>0.1</urn:messageVersion>
            <urn:paResMessage>eJydVVuTqjgQ....7h%2FwH0CKem</urn:paResMessage>
         </urn:input>
      </urn:cardValidateAuthenticationAndOrder>

Response

Required

amount

presence

Required

Interface version

2.0

Format

N12

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

Format

N3(restricted values / ISO4217)

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
merchantId

presence

Required

Interface version

2.0

Format

N15

Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
responseCode

presence

Required

Interface version

2.0

Format

N2(restricted values)

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
seal

presence

Required

Interface version

2.0

Format

ANS128

Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
transactionDateTime

presence

Required

Interface version

2.0

Format

ANS25(ISO8601)

Date and time the transaction was processed on the Sogenactif server. (expressed in the Sogenactif server time zone)
transactionReference

presence

Required

Interface version

2.0

Format

AN35

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.

Optional

acceptanceSystemApplicationId

presence

Optional

Interface version

2.20

Format

ANS12

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.
acquirerNativeResponseCode

presence

Optional

Interface version

2.14

Format

ANS10

Response code returned by the acquirer, in its own codification, during an authorisation request.
acquirerResponseCode

presence

Optional

Interface version

2.0

Format

AN2(restricted values)

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.0

Format

ANS512

Acquirer response message to the originator of the transaction (for example, message to be displayed to the holder or the cashier)..
authentExemptionReasonList
presence

Optional

Interface version

2.31
Format
ANU256(restricted String)
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_RTS

RECURRING_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
authorMessageReference

presence

Optional

Interface version

2.19

Format

N6

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

Format

AN10/ANS32

Authorisation ID returned by the acquirer if the authorisation request is accepted.
authorisationTypeLabel

presence

Optional

Interface version

2.19

Format

ANS50(restricted values)

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.0

Format

AN1(restricted values)

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.0

Format

AN1(restricted values)

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.0

Format

N2

Deadline for settlement.
captureLimitDate

presence

Optional

Interface version

2.35

Format

N8(YYYYMMDD)

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

Format

ANS25(ISO8601)

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.0

Format

ANS20(restricted values)

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.0

Format

AN2(restricted values)

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.19

Format

Container

Contains specific information regarding a card
Contains
- cardBrand
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  ANS20(restricted values)
  
  Please see “paymentMeanBrand”.
- cardCorporateIndicator
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  A1(restricted values)
  
  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.19
  
  Format
  
  A1(restricted values)
  
  Indicator of existence of a card effective date (Y/N/Empty)
- cardPanType
  
  presence
  
  Optional
  
  Interface version
  
  2.52
  
  Format
  
  A4
  
  PAN type sent on authentication / authorisation / settlement
  
  List of values
  
  DPAN
  
  Digital PAN
  
  PAN
  
  Real PAN
- cardProductCode
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  AN5
  
  Product code of the card.
- cardProductName
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  ANS70
  
  Product name of the card.
- cardProductProfile
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  A1(restricted values)
  
  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
  
  Format
  
  ANS50(restricted values)
  
  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.19
  
  Format
  
  ANS20(restricted values)
  
  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.19
  
  Format
  
  AN1(restricted values)
  
  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.19
  
  Format
  
  AN6
  
  Issuer code of the card. This data is called cardIssuerCode in the reports.
- issuerCountryCode
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  A3(restricted values)
  
  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.19
  
  Format
  
  ANS250
  
  Issuer name of the card. This data is called cardIssuerName in the reports.
- issuerRegionCode
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  AN1(restricted values)
  
  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
  
  Format
  
  A3(restricted values)
  
  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.19
  
  Format
  
  A1(restricted values)
  
  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.19
  
  Format
  
  N2
  
  Maximum length of the PAN
- panLengthMin
  
  presence
  
  Optional
  
  Interface version
  
  2.19
  
  Format
  
  N2
  
  Minimal length of the PAN
- virtualCardIndicator
  
  presence
  
  Optional
  
  Interface version
  
  2.35
  
  Format
  
  A1(restricted values)
  
  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.0

Format

N6(YYYYMM)

Card expiry date. If the card does not have any expiry date, this field is empty.
challengeMode3DS

presence

Optional

Interface version

2.41

Format

ANS20(restricted values)

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
complementaryCode

presence

Optional

Interface version

2.0

Format

AN2(restricted values)

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
Format
AN256(extended String)
Additional information from the Sogenactif server sent back in the response.
customerAccountData

presence

Optional

Interface version

2.47

Format

Container

Contains the bank account data of the payer
Contains
- customerAccount
  
  presence
  
  Optional
  
  Interface version
  
  2.47
  
  Format
  
  AN34
  
  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
  
  ANS20(restricted values)
  
  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
  
  Format
  
  AN11
  
  Bank code of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg BIC …).
customerId
presence

Optional

Interface version

2.0
Format
AN19(restricted String)
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

Format

ipAddress

Buyer’s IP address.
errorFieldName

presence

Optional

Interface version

2.0

Format

ANS50

Error field name of the incoming request. Present when responseCode = 12 or 30.
guaranteeIndicator

presence

Optional

Interface version

2.0

Format

A1(restricted values)

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

Format

N8

Deadline for application of the payment guarantee.
holderAuthentMethod

presence

Optional

Interface version

2.0

Format

ANS20 (restricted values)

Name of the method applied to authenticate a payment mean holder

List of values

DYNAMIC

Dynamic authentication method

NOT_SPECIFIED

Not specified (compatible holderAuthentProgram: 3DS)

NO_AUTHENT

Equivalent to NO_AUTHENT_METHOD, it is an alternative value used in the transaction report Compatible holderAuthentProgram: NO_AUTHENT

NO_AUTHENT_METHOD

No Holder Verification Method performed Compatible holderAuthentProgram: PAYLIB

OOB

Out Of Band authentication method that is not defined by 3D Secure application

OTP_HARDWARE

OTP on Hardware secure element (CAP, SIM, …) Compatible holderAuthentProgram: PAYLIB

OTP_SOFTWARE

OTP on Software secure element (SEA, …) Compatible holderAuthentProgram: PAYLIB

OTP_TELE

One Time Password (SMS, SVI, Token…) Compatible holderAuthentProgram: PAYLIB

PASSWORD

Password is reusable (birth date, password, zip code, …) Compatible holderAuthentMethod: BCMCMOBILE

STATIC

Static authentication method
holderAuthentProgram

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

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
holderAuthentRelegation

presence

Optional

Interface version

2.0

Format

A1(restricted values)

Please see “holderAuthentRelegationCode”. This data is used by Sogenactif Office Serveur for versions lower than 2.17.
holderAuthentRelegationCode

presence

Optional

Interface version

2.17

Format

A1(restricted values)

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
holderAuthentResponseCode

presence

Optional

Interface version

2.23

Format

A2(restricted values)

Response code of the authentication process.

List of values

00

Holder authenticated

01

Holder not authenticated

02

Holder authentication could not be performed because of a technical problem on the ACS (TX.status = U in the PARes message)

03

Proof of authentication available

88

An Error message was sent by ACS instead of a CRes message

89

The session has expired

95

Invalid PARes message signature

96

Invalid PARes message
holderAuthentStatus

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

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.
holderAuthentType

presence

Optional

Interface version

2.24

Format

ANS25(restricted values)

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
invoiceReference

presence

Optional

Interface version

2.0

Format

AN30

Invoice reference.
issuerWalletInformation

presence

Optional

Interface version

2.21

Format

ANS255

Information given by the wallet provider intended for the merchant in response to a transaction creation request.
maskedPan

presence

Optional

Interface version

2.0

Format

NS19

Masked Primary Account Number. In the case of wallets, masked PAN of the payment mean registered in the wallet.
merchantTransactionDateTime

presence

Optional

Interface version

2.0

Format

ANS25(ISO8601)

Date and time of the transaction, set by the merchant at the merchant’s local time (in the merchant’s time zone)
orderChannel

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

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
orderId

presence

Optional

Interface version

2.0

Format

ANS32

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.
panEntryMode

presence

Optional

Interface version

2.21

Format

AN20 (restricted values)

Primary Account Number reading mode. For example, for a OneClick payment, indicates that the PAN was retrieved from the Sogenactif wallet.

List of values

CTACTLESS_ICC

Obsolete

CTACTLESS_MAG

Obsolete

CTACTLESS_MOB

Obsolete

ICC

Obsolete

IC_CONSTRUCTED

Obsolete

MAG_ICC_FAILED

Obsolete

MAG_STRIPE

Obsolete

MANUAL

Manual (pan entered via web site, or key entry or OCR reading of embossing or printed data either at time of transaction or after the event)

OEMPAY

OEMPAY

VIRTUAL

Pan entered via virtual keyboard

WALLET

Wallet data created by the holder
paymentAccountReference

presence

Optional

Interface version

2.31

Format

ANS29

Reference of the bank account associated to the card used for the payment.
paymentMeanBrand

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

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.13

Format

ANS20(restricted values)

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
paymentPattern

presence

Optional

Interface version

2.0

Format

ANS20(restricted values)

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
preAuthorisationProfile

presence

Optional

Interface version

2.13

Format

ANS50

Name of the applied pre-authorisation profile.
preAuthorisationProfileValue

presence

Optional

Interface version

2.13

Format

ANS50

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

Format

Composite list

List containing the result of each executed antifraud rules in pre-authorisation step.
Contains
- ruleResult
  
  presence
  
  Optional
  
  Interface version
  
  2.13
  
  Format
  
  Container
  
  Detailed result of the antifraud rule.
  Contains
  - ruleCode
    
    presence
    
    Optional
    
    Interface version
    
    2.13
    
    Format
    
    AN2 (restricted values)
    
    Identifier of antifraud rule.
  - ruleDetailedInfo
    
    presence
    
    Optional
    
    Interface version
    
    2.13
    
    Format
    
    ANS255
    
    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
    
    Format
    
    AN3 (restricted values)
    
    Execution indicator of the antifraud rule.
  - ruleSetting
    
    presence
    
    Optional
    
    Interface version
    
    2.13
    
    Format
    
    A1(restricted values)
    
    Setting up mode of the antifraud rule parameters.
  - ruleType
    
    presence
    
    Optional
    
    Interface version
    
    2.13
    
    Format
    
    A2 (restricted values)
    
    Type of antifraud rule.
  - ruleWeight
    
    presence
    
    Optional
    
    Interface version
    
    2.13
    
    Format
    
    AN2 (restricted values)
    
    Weighting of the antifraud rule.
reattemptEndDateTime

presence

Optional

Interface version

2.48

Format

ANS25(ISO8601)

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

Format

N2

Maximal number of allowed reattempts during the allowed-reattempt period
reattemptMode

presence

Optional

Interface version

2.48

Format

ANS20(restricted values)

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

Format

ANS25(ISO8601)

Start date of the allowed-reattempt period, where trying again an authorization request on a refused transaction is allowed
returnContext

presence

Optional

Interface version

2.0

Format

ANS255

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.0

Format

Container

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.0
  
  Format
  
  N6
  
  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.0
  
  Format
  
  N8(YYYYMMDD)
  
  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

Format

ANS56

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.0

Format

ANS30(restricted values)

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.0

Format

ANS512

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.0

Format

ANS50

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.0

Format

ANS10

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.0

Format

ANS10

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

Format

ANS50

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.
statementReference
presence

Optional

Interface version

2.0
Format
AN100(extended String)
Reference provided by the merchant which is sent in the payment collection flow. This reference appears on the account statements of the cardholder.
tokenPan
presence

Optional

Interface version

2.0
Format
AN35(restricted String)
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).
transactionPlatform

presence

Optional

Interface version

2.17

Format

ANS12(restricted values)

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
walletType

presence

Optional

Interface version

2.21

Format

ANS20(restricted values)

Wallet Type.

List of values

BCMCMOBILE

Wallet of Bancontact

MASTERPASS

Deprecated - Wallet of Mastercard

MERCHANT_WALLET

Wallet of Sogenactif

PAYLIB

Wallet of a group of Banks

VISACHECKOUT

Deprecated - Wallet of Visa Checkout

Response sample

json
soap

            {
  "amount": 1000,
  "authorisationId": "010628",
  "avsAddressResponseCode": "1",
  "avsPostcodeResponseCode": "1",
  "captureDay": 0,
  "captureMode": "AUTHOR_CAPTURE",
  "cardExpiryDate": "201602",
  "currencyCode": "978",
  "holderAuthentStatus": "3D_SUCCESS",
  "guaranteeIndicator": "Y",
  "maskedPan": "4907##########00",
  "merchantId": "011223344550000",
  "orderChannel": "INTERNET",
  "orderId": "1234",
  "paymentMeanBrand": "VISA",
  "responseCode": "00",
  "transactionDateTime": "2015-05-28T12:38:25+03:00",
  "transactionReference": "TREFEXA2015",
  "s10TransactionReference": {
    "s10TransactionId": "129306",
    "s10TransactionIdDate": "20150528"
  },
  "seal": "ef3f3cc68a39a5d1144663162a35fa6070bfe39d5abbe672b15417ff87afc431",
  "transactionPlatform": "PROD"
}

                  <cardValidateAuthenticationAndOrderResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <amount>1000</amount>
            <authorisationId>010606</authorisationId>
            <avsAddressResponseCode>1</avsAddressResponseCode>
            <avsPostcodeResponseCode>1</avsPostcodeResponseCode>
            <captureDay>0</captureDay>
            <captureMode>AUTHOR_CAPTURE</captureMode>
            <cardExpiryDate>201602</cardExpiryDate>
            <currencyCode>978</currencyCode>
            <holderAuthentMethod/>
            <holderAuthentStatus>3D_SUCCESS</holderAuthentStatus>
            <holderAuthentProgram/>
            <guaranteeIndicator>Y</guaranteeIndicator>
            <maskedPan>4907##########00</maskedPan>
            <merchantId>011223344550000</merchantId>
            <orderChannel>INTERNET</orderChannel>
            <orderId>1234</orderId>
            <paymentMeanBrand>VISA</paymentMeanBrand>
            <responseCode>00</responseCode>
            <transactionDateTime>2015-05-28T10:40:44+03:00</transactionDateTime>
            <transactionReference>TREFEXA2015</transactionReference>
            <s10TransactionReference>
               <s10TransactionId>128918</s10TransactionId>
               <s10TransactionIdDate>20150528</s10TransactionIdDate>
            </s10TransactionReference>
            <transactionPlatform>PROD</transactionPlatform>
         </output>
      </cardValidateAuthenticationAndOrderResponse>

Changelog

Filter

Interface version	Data	Attendance	Container
2.0	`interfaceVersion`	Request
2.0	`keyVersion`	Request
2.0	`merchantId`	Request/Response
2.0	`messageVersion`	Request
2.0	`redirectionData`	Request
2.0	`seal`	Request/Response
2.12	`intermediateServiceProviderId`	Request
2.0	`paResMessage`	Request
2.0	`s10TransactionReference`	Request/Response
2.0	`s10TransactionId`	Container	`s10TransactionReference`
2.0	`s10TransactionIdDate`	Container	`s10TransactionReference`
2.12	`sealAlgorithm`	Request
2.0	`transactionReference`	Request/Response
2.20	`acceptanceSystemApplicationId`	Response
2.14	`acquirerNativeResponseCode`	Response
2.0	`acquirerResponseCode`	Response
2.0	`acquirerResponseMessage`	Response
2.31	`authentExemptionReasonList`	Response
2.19	`authorMessageReference`	Response
2.0	`authorisationId`	Response
2.19	`authorisationTypeLabel`	Response
2.0	`avsAddressResponseCode`	Response
2.0	`avsPostcodeResponseCode`	Response
2.0	`captureDay`	Response
2.35	`captureLimitDate`	Response
2.35	`captureLimitDateTime`	Response
2.0	`captureMode`	Response
2.0	`cardCSCResultCode`	Response
2.19	`cardData`	Response
2.19	`cardBrand`	Container	`cardData`
2.19	`cardCorporateIndicator`	Container	`cardData`
2.19	`cardEffectiveDateIndicator`	Container	`cardData`
2.52	`cardPanType`	Container	`cardData`
2.19	`cardProductCode`	Container	`cardData`
2.19	`cardProductName`	Container	`cardData`
2.19	`cardProductProfile`	Container	`cardData`
2.19	`cardProductUsageLabel`	Container	`cardData`
2.19	`cardScheme`	Container	`cardData`
2.19	`cardSeqNumberIndicator`	Container	`cardData`
2.19	`issuerCode`	Container	`cardData`
2.19	`issuerCountryCode`	Container	`cardData`
2.19	`issuerName`	Container	`cardData`
2.19	`issuerRegionCode`	Container	`cardData`
2.44	`issuingCountryCode`	Container	`cardData`
2.19	`panCheckAlgorithm`	Container	`cardData`
2.19	`panLengthMax`	Container	`cardData`
2.19	`panLengthMin`	Container	`cardData`
2.35	`virtualCardIndicator`	Container	`cardData`
2.0	`cardExpiryDate`	Response
2.41	`challengeMode3DS`	Response
2.0	`complementaryCode`	Response
2.0	`complementaryInfo`	Response
2.47	`customerAccountData`	Response
2.47	`customerAccount`	Container	`customerAccountData`
2.47	`customerBankAccountType`	Container	`customerAccountData`
2.47	`customerBankCode`	Container	`customerAccountData`
2.0	`customerId`	Response
2.0	`customerIpAddress`	Response
2.0	`errorFieldName`	Response
2.0	`guaranteeIndicator`	Response
2.32	`guaranteeLimitDateTime`	Response
2.0	`holderAuthentMethod`	Response
2.0	`holderAuthentProgram`	Response
2.0	`holderAuthentRelegation`	Response
2.17	`holderAuthentRelegationCode`	Response
2.23	`holderAuthentResponseCode`	Response
2.0	`holderAuthentStatus`	Response
2.24	`holderAuthentType`	Response
2.0	`invoiceReference`	Response
2.21	`issuerWalletInformation`	Response
2.0	`maskedPan`	Response
2.0	`merchantTransactionDateTime`	Response
2.0	`orderChannel`	Response
2.0	`orderId`	Response
2.21	`panEntryMode`	Response
2.31	`paymentAccountReference`	Response
2.0	`paymentMeanBrand`	Response
2.13	`paymentMeanBrandSelectionStatus`	Response
2.0	`paymentPattern`	Response
2.13	`preAuthorisationProfile`	Response
2.13	`preAuthorisationProfileValue`	Response
2.13	`preAuthorisationRuleResultList`	Response
2.13	`ruleResult`	Container	`preAuthorisationRuleResultList`
2.13	`ruleCode`	Container	`ruleResult`
2.13	`ruleDetailedInfo`	Container	`ruleResult`
2.13	`ruleResultIndicator`	Container	`ruleResult`
2.13	`ruleSetting`	Container	`ruleResult`
2.13	`ruleType`	Container	`ruleResult`
2.13	`ruleWeight`	Container	`ruleResult`
2.48	`reattemptEndDateTime`	Response
2.48	`reattemptMax`	Response
2.48	`reattemptMode`	Response
2.48	`reattemptStartDateTime`	Response
2.0	`returnContext`	Response
2.31	`schemeTransactionIdentifier`	Response
2.0	`scoreColor`	Response
2.0	`scoreInfo`	Response
2.0	`scoreProfile`	Response
2.0	`scoreThreshold`	Response
2.0	`scoreValue`	Response
2.49	`settlementArchivingReference`	Response
2.0	`statementReference`	Response
2.0	`tokenPan`	Response
2.17	`transactionPlatform`	Response
2.21	`walletType`	Response
2.0	`amount`	Response
2.0	`currencyCode`	Response
2.0	`responseCode`	Response
2.0	`transactionDateTime`	Response