Release 25.5

go directly to content

Search by keywords

Automatic and Manual response Paypage et InApp

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

Manual and automatic response for Sherlock’s Paypage and Sherlock’s In-App containing the payment information

Required

Optional

  • abortedProcessingLocation
    presence
    Optional
    Interface version
    3.0

    Name of the processing step where the transaction has been aborted (responseCode = 97 ou 17).

    List of values
    PARTNER
    External partner page
    PAT_PLATFORM
    Sherlock’s acceptance platform
  • abortedProcessingStep
    presence
    Optional
    Interface version
    3.0

    Location of the last processing step where the transaction was aborted (responCode = 97 or 17).

    List of values
    AUTHENTICATION_PAGE
    Authentication page
    PAYMENT_PAGE
    Payment page
    SELECTION_PAGE
    Selection page
  • acceptanceSystemApplicationId
    presence
    Optional
    Interface version
    2.39

    Identifier of the ultimate Sherlock’s 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.

  • acquirerContractNumber
    presence
    Optional
    Interface version
    2.25

    Please see “contractNumber”

  • acquirerNativeResponseCode
    presence
    Optional
    Interface version
    2.12

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

  • 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
    46
    Business specific error
    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
    6P
    Verification data failed
    75
    Exceeded number of PAN attempts
    77
    Closed account
    78
    Card not yet activated, or temporarily blocked
    82
    Card verification method failed for CAM, dCVV, iCVV or CVV
    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
    R0
    Stop payment order
    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
  • acquirerResponseIdentifier
    presence
    Optional
    Interface version
    2.8

    Please see “authorMessageReference”.

  • acquirerResponseMessage
    presence
    Optional
    Interface version
    2.8

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

  • amount
    presence
    Optional
    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.

  • amountsList
    presence
    Optional
    Interface version
    2.6

    List of amounts for the occurrences for payment in instalments.The amount is transmitted in the smallest currency unit:For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.

  • authentDateTime
    presence
    Optional
    Interface version
    3.4

    UTC date and time of the authentication.

  • authentExemptionReasonList
    presence
    Optional
    Interface version
    2.28

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

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

    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
  • businessName
    presence
    Optional
    Interface version
    2.17

    Business name.

  • captureDay
    presence
    Optional
    Interface version
    2.0

    Deadline for settlement.

  • captureLimitDate
    presence
    Optional
    Interface version
    2.3

    Date 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

    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

    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
  • cardProductCode
    presence
    Optional
    Interface version
    2.12

    Product code of the card.

  • cardProductName
    presence
    Optional
    Interface version
    2.12

    Product name of the card.

  • cardProductProfile
    presence
    Optional
    Interface version
    2.12

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

    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
    Carte Bancaire 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)
  • cardSeqNumber
    presence
    Optional
    Interface version
    2.0

    Card sequence number allocated by the issuer.

  • challengeMode3DS
    presence
    Optional
    Interface version
    2.41

    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
  • company
    presence
    Optional
    Interface version
    2.17

    Company for the address.

  • complementaryCode
    presence
    Optional
    Interface version
    2.0

    Additional response code from the Sherlock’s server returned in the response. This field is only filled out if you have signed up for additional checks for the Sherlock’s 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 Sherlock’s 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 Sherlock’s 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 Sherlock’s server sent back in the response.

  • creditorId
    presence
    Optional
    Interface version
    2.7

    Unique identifier of the creditor. For SEPA, the Creditor Identifier (CI) is required to send Direct Debit instructions.

  • currencyCode
    presence
    Optional
    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
  • customerAccount
    presence
    Optional
    Interface version
    3.0

    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
    3.0

    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
    3.0

    Bank code of the customer either in national, or international or specific codification. The format is specified in the field customerBankAccountType (eg BIC …).

  • customerEmail
    presence
    Optional
    Interface version
    2.0

    Depreciated, replaced by “email” in the container customerContact.

  • customerId
    presence
    Optional
    Interface version
    2.0

    Customer identifier

    Attention: use this free field only for the intended purpose, and therefore do not insert any personal data, especially cardholder data

    As a subcontractor, Crédit Lyonnais 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 Crédit Lyonnais via the fields provided for this purpose (see data dictionary).
    • All other personal data not listed in the DPA must not be transmitted to Crédit Lyonnais.
  • customerIpAddress
    presence
    Optional
    Interface version
    2.0

    Buyer’s IP address.

  • datesList
    presence
    Optional
    Interface version
    2.6

    List of the dates of occurrences for payment in instalments.

  • dccAmount
    presence
    Optional
    Interface version
    2.3

    Amount of the DCC transaction (include exchange rate), in card holder currency.

  • dccCurrencyCode
    presence
    Optional
    Interface version
    2.3

    Currency code of the card holder.

    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
  • dccProvider
    presence
    Optional
    Interface version
    2.3

    DCC provider name.

  • dccResponseCode
    presence
    Optional
    Interface version
    2.3

    DCC response code of the transaction.

    List of values
    00
    Successful operation
    03
    Invalid merchant contract
    05
    Operation is refused
    12
    Invalid data, verify the request
    24
    Operation not authorized
    51
    Invalid amount
    90
    Technical error
  • dccStatus
    presence
    Optional
    Interface version
    2.3

    DCC status of the transaction.

    List of values
    00
    Success
    01
    Declined by card holder
    02
    Non eligible - DCC provider refusal
    03
    Non applicable – Sherlock’s refusal, no call to DCC Provider
    04
    The DCC service has been deactivated by the merchant
    Empty
    No DCC for this transaction
  • email
    presence
    Optional
    Interface version
    2.20

    Contact’s email address.

  • guaranteeIndicator
    presence
    Optional
    Interface version
    2.0

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

    Deadline for application of the payment guarantee.

  • hashPan1
    presence
    Optional
    Interface version
    2.0

    Cryptographic PAN identifier, calculated by Sherlock’s.

  • hashPan2
    presence
    Optional
    Interface version
    2.0

    Please see “hashPan1”.

  • holderAuthentMethod
    presence
    Optional
    Interface version
    2.4

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

    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 Sherlock’s Paypage Since the version 2.24 for Sherlock’s Office Since the version 2.5 for Sherlock’s 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

    Please see “holderAuthentRelegationCode”. This data is used by Sherlock’s Office for versions lower than 2.17.

  • holderAuthentStatus
    presence
    Optional
    Interface version
    2.0

    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 Sherlock’s 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 Sherlock’s 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

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

    Invoice reference.

  • issuerCode
    presence
    Optional
    Interface version
    2.12

    Issuer code of the card. This data is called cardIssuerCode in the reports.

  • issuerCountryCode
    presence
    Optional
    Interface version
    2.12

    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
    3.2

    Issuer name of the card. This data is called cardIssuerName in the reports.

  • issuerWalletInformation
    presence
    Optional
    Interface version
    2.9

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

  • 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
  • legalId
    presence
    Optional
    Interface version
    2.17

    Legal business identifier (SIRET in France). This field is applicable for merchant or customer (please see fields Contact).

  • mandateAuthentMethod
    presence
    Optional
    Interface version
    2.2

    Type of signature used for the creation of the mandate.

    List of values
    MAIL_OTP
    Authentication by SMS
    SMS_OTP
    Authentication by eMail
  • mandateCertificationType
    presence
    Optional
    Interface version
    2.7

    Mandate signature certification type.

    List of values
    E_BASIC
    Electronic signature not certified. If the mandate is an E_BASIC one, the merchant didn’t proof that he has a sufficient knowledge of his client allowing him to be sure that the client is the one that he claims to be when he creates his mandate. The client can oppose the validity of the mandate.
  • mandateId
    presence
    Optional
    Interface version
    2.3

    Mandate number.

  • mandateUsage
    presence
    Optional
    Interface version
    2.2

    Type of mandate used.

    List of values
    ONE_OFF
    Single use mandate
    RECURRENT
    Recurring use mandate
  • 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.

  • merchantSessionId
    presence
    Optional
    Interface version
    2.0

    Merchant’s session number. Allows consolidation between requests and responses.

  • merchantTransactionDateTime
    presence
    Optional
    Interface version
    2.0

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

  • merchantWalletId
    presence
    Optional
    Interface version
    2.0

    Customer’s Wallet identifier.

  • mobile
    presence
    Optional
    Interface version
    2.1

    Mobile phone number for the contact.

  • number
    presence
    Optional
    Interface version
    2.6

    Number of occurrences for payment in instalments.

  • orderChannel
    presence
    Optional
    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
  • 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, Crédit Lyonnais 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 Crédit Lyonnais via the fields provided for this purpose (see data dictionary).
    • All other personal data not listed in the DPA must not be transmitted to Crédit Lyonnais.
  • panEntryMode
    presence
    Optional
    Interface version
    2.4

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

    List of values
    COF
    Card On File. Pan retrieved from a merchant-managed wallet
    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
  • panExpiryDate
    presence
    Optional
    Interface version
    2.0

    Expiry date of an instrument associated with a Primary Account Number.For example, for a card, it contains the expiry date for an authorisation request operation. If the payment method does not have a validity date, this field should be empty.

  • paymentAccountReference
    presence
    Optional
    Interface version
    2.28

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

  • paymentAttemptNumber
    presence
    Optional
    Interface version
    2.18

    Number of payment attempts made by the buyer.

  • paymentMeanBrand
    presence
    Optional
    Interface version
    2.0

    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 Sherlock’s 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.14

    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
  • paymentMeanDataProvider
    presence
    Optional
    Interface version
    2.35

    Name of data provider of the payment mean.

    List of values
    APPLEPAY
    Apple Pay
    GOOGLEPAY
    Google Pay
    SAMSUNGPAY
    Samsung Pay
  • paymentMeanId
    presence
    Optional
    Interface version
    2.6

    Payment mean rank in Sherlock’s wallet.

  • paymentMeanTradingName
    presence
    Optional
    Interface version
    2.8

    Trading name of the partner merchant accepting with the payment method. For example, for a privative card, indicates the brand to which the card is “cobranded”.

  • paymentMeanType
    presence
    Optional
    Interface version
    2.0

    Payment method type (card, transfer, withdrawal, etc). It groups together a set of paymentMeanBrand.

    List of values
    1EUROCOM
    Cofidis Pay 5x10x20x paymentMeanBrandType: ONLINE_CREDIT
    3XCBCOFINOGA
    Deprecated. Cofinoga 3xCB paymentMeanBrandType: CARD
    ACCEPTGIRO
    AcceptGiro paymentMeanBrandType: CREDIT_TRANSFER
    ACCORD_3X
    Facily Pay 3 X payment paymentMeanBrandType: ONLINE_CREDIT
    ACCORD_4X
    Facily Pay 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    AIRPLUS
    Airplus card paymentMeanBrandType: CARD
    AIRPLUS_LOGEE
    Airplus logee card paymentMeanBrandType: CARD
    AMEX
    American Express card paymentMeanBrandType: CARD
    AMEX_LOGEE
    American Express logee card paymentMeanBrandType: CARD
    AURORE
    CPAY card paymentMeanBrandType : CARD
    BCACB_3X
    Floa Bank CB 3 X payment paymentMeanBrandType: ONLINE_CREDIT
    BCACB_4X
    Floa Bank CB 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    BCACUP
    CUP card issued by Floa Bank paymentMeanBrandType: CARD
    BCMC
    Bancontact paymentMeanBrandType: CARD
    CACF_3X
    CACF 3 X payment paymentMeanBrandType: ONLINE_CREDIT
    CACF_4X
    CACF 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    CADHOC
    Cadhoc paymentMeanBrandType: CARD
    CADOCARTE
    Cado Carte paymentMeanBrandType: CARD
    CB
    Carte Bancaire paymentMeanBrandType: CARD
    CETELEM_3X
    Cetelem 3xCB paymentMeanBrandType: ONLINE_CREDIT
    CETELEM_4X
    Cetelem 4xCB paymentMeanBrandType: ONLINE_CREDIT
    COFIDIS_3X
    Cofidis 3xCB paymentMeanBrandType: ONLINE_CREDIT
    COFIDIS_4X
    Cofidis 4xCB paymentMeanBrandType: ONLINE_CREDIT
    CONECS
    Titres Restaurants Dématérialisés Conecs paymentMeanBrandType: VOUCHER
    CUP
    China UnionPay card paymentMeanBrandType: CARD
    CVA
    Visa Aurore card paymentMeanBrandType: CARD
    CVCO
    Chèque-Vacances Connect paymentMeanBrandType: VOUCHER
    DINERS
    Diners club international card paymentMeanBrandType: CARD
    FRANFINANCE_3X
    Franfinance 3xCB paymentMeanBrandType: ONLINE_CREDIT
    FRANFINANCE_4X
    Franfinance 4xCB paymentMeanBrandType: ONLINE_CREDIT
    GIROPAY
    Giropay paymentMeanBrandType: CREDIT_TRANSFER
    ILLICADO
    Illicado paymentMeanBrandType: CARD
    INCASSO
    Incasso paymentMeanBrandType: DIRECT_DEBIT
    INGHOMEPAY
    PayButton ING Home’Pay paymentMeanBrandType: CREDIT_TRANSFER
    JCB
    Japan Credit Bureau card paymentMeanBrandType: CARD
    LEPOTCOMMUN
    Le Pot Commun paymentMeanBrandType: CARD
    LYDIA
    Lydia paymentMeanBrandType: PROVIDER
    MAESTRO
    Carte Maestro (Mastercard) paymentMeanBrandType: CARD
    MASTERCARD
    Mastercard card paymentMeanBrandType: CARD
    MASTERPASS
    Deprecated - MasterPass electronic wallet paymentMeanBrandType: WALLET
    ONEY34X
    Oney Paiement 3 or 4 X payment paymentMeanBrandType: ONLINE_CREDIT
    OTHER
    Unknown (no payment mean selected)
    PAYLIB
    Paylib electronic wallet paymentMeanBrandType: WALLET
    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
    VISA
    Visa card paymentMeanBrandType: CARD
    VISACHECKOUT
    Deprecated - Visa Checkout electronic wallet paymentMeanBrandType: WALLET
    VISA_ELECTRON
    Visa Electron card paymentMeanBrandType: CARD
    VPAY
    VPAY card (Visa) paymentMeanBrandType: CARD
  • paymentPattern
    presence
    Optional
    Interface version
    2.0

    Type of payment (per operation, 1st recurring payment etc).

    List of values
    INSTALMENT
    transactionInitiator : CIT, MIT Payment by instalment
    MULTIPLE_1
    transactionInitiator : CIT First payment for a purchase dispatched in several shipments
    MULTIPLE_N
    transactionInitiator : MIT Nth payment for a purchase dispatched in several shipments
    ONE_SHOT
    transactionInitiator : CIT One shot payment (default value)
    RECURRING_1
    transactionInitiator : CIT Subscription payment first
    RECURRING_N
    transactionInitiator : MIT Abonnement Nème paiement
  • positionOccupied
    presence
    Optional
    Interface version
    2.17

    Position occupied.

  • preAuthenticationColor
    presence
    Optional
    Interface version
    2.10

    Colour associated with the result of pre-authentication antifraud rules. Used to trigger the authentication level for a given transaction.

    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
  • preAuthenticationInfo
    presence
    Optional
    Interface version
    2.10

    Detailed result of each rule executed during the antifraud controls in pre-authentication. ERROR is displayed if an error is generated during the check sequence.

  • preAuthenticationProfile
    presence
    Optional
    Interface version
    2.10

    Name of the applied pre-authentication profile.

  • preAuthenticationProfileValue
    presence
    Optional
    Interface version
    2.14

    Identifier of the antifraud profile applied during the pre-authentication step. Unlike the profile name, the unique identifier takes into account the dynamic override and the bypassing of the antifraud rules. With this identifier you can retrieve all executed antifraud rules of a transaction and their setup and could be used in case of dispute.

  • preAuthenticationRuleResultList
    presence
    Optional
    Interface version
    2.14

    List containing the result of each executed antifraud rules in pre-authentication step.

    Contains
  • preAuthenticationThreshold
    presence
    Optional
    Interface version
    2.10

    Thresholds to determine the risk level of a transaction in pre-authentication step.

  • preAuthenticationValue
    presence
    Optional
    Interface version
    2.10

    Antifraud result of the pre-authentication check.

  • preAuthorisationProfile
    presence
    Optional
    Interface version
    2.14

    Name of the applied pre-authorisation profile.

  • preAuthorisationProfileValue
    presence
    Optional
    Interface version
    2.14

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

    List containing the result of each executed antifraud rules in pre-authorisation step.

    Contains
  • reattemptEndDateTime
    presence
    Optional
    Interface version
    3.1

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

  • reattemptMax
    presence
    Optional
    Interface version
    3.1

    Maximal number of allowed reattempts during the allowed-reattempt period

  • reattemptMode
    presence
    Optional
    Interface version
    3.1

    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
    3.1

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

  • responseCode
    presence
    Optional
    Interface version
    2.0

    Sherlock’s 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 Sherlock’s
    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 Sherlock’s 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 Sherlock’s 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, Crédit Lyonnais 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 Crédit Lyonnais via the fields provided for this purpose (see data dictionary).
    • All other personal data not listed in the DPA must not be transmitted to Crédit Lyonnais.
  • s10TransactionId
    presence
    Optional
    Interface version
    2.9

    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 Sherlock’s 1.0. The couple s10TransactionId/s10TransactionIdDate ensures the unicity of the transaction.

  • s10TransactionIdDate
    presence
    Optional
    Interface version
    2.9

    Date of the transaction (expressed in the Sherlock’s 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.

  • s10TransactionIdsList
    presence
    Optional
    Interface version
    2.11

    List of alternative identifiers for the transaction of occurrences for payment in instalments, to be compliant with Sherlock’s 1.0.As part of payment in several times, it is the list of due dates of the payment in instalments.

  • schemeTransactionIdentifier
    presence
    Optional
    Interface version
    2.28

    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

    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

    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

    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

    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

    Relative number representing the transaction score. Value of the score Pre-authorization computed by the Fraud engine in Business Score mode.

  • sealAlgorithm
    presence
    Optional
    Interface version
    2.0

    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
  • secureReference
    presence
    Optional
    Interface version
    2.26

    as parto of SDD option Safe Debit, reference of the secure transaction returned by the SSP (Score & Secure Payment).

  • settlementArchivingReference
    presence
    Optional
    Interface version
    3.2

    Data provided to the acquirer for processing settlements and reconciliations. By default generated by the Sherlock’s platform. Its supply by the merchant is subject to strong constraints. Contact Sherlock’s to use this data in requests.

  • settlementMode
    presence
    Optional
    Interface version
    2.7

    Settlement mode chosen by the buyer. The values of this field should be acquirer’s native codes. Any convertion is done by Sherlock’s.

  • statementReference
    presence
    Optional
    Interface version
    2.4

    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

    Unique identifier for a PAN returned by the Sherlock’s server via the AWL token server in a merchant-oriented format (the format is a parameter in the merchant’s configuration).

  • transactionActors
    presence
    Optional
    Interface version
    2.2

    Indicates the players in the transaction.

    List of values
    BTOB
    Business to Business
    BTOC
    Business to Consumer
    BTOF
    Business to organization / association
  • transactionDateTime
    presence
    Optional
    Interface version
    2.0

    Date and time the transaction was processed on the Sherlock’s server. (expressed in the Sherlock’s server time zone)

  • 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”.

  • transactionPlatform
    presence
    Optional
    Interface version
    2.16

    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
  • transactionReferencesList
    presence
    Optional
    Interface version
    2.6

    List of references for the transaction of occurrences for payment in instalments.

  • valueDate
    presence
    Optional
    Interface version
    2.7

    Payment value date

  • virtualCardIndicator
    presence
    Optional
    Interface version
    2.36

    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
  • walletType
    presence
    Optional
    Interface version
    2.4

    Wallet Type.

    List of values
    BCMCMOBILE
    Wallet of Bancontact
    MASTERPASS
    Deprecated - Wallet of Mastercard
    MERCHANT_WALLET
    Wallet of Sherlock’s
    PAYLIB
    Wallet of a group of Banks
    VISACHECKOUT
    Deprecated - Wallet of Visa Checkout

Response sample

            {
"keyVersion":1,
"acquirerResponseCode":"00",
"acquirerResponseDescription":"Transaction approved or processed successfully",
"amount":1000,
"authorisationId":"813979",
"captureDay":0,
"captureMode":"AUTHOR_CAPTURE",
"cardScheme":"CB",
"chargeAmount":0,
"complementaryCode":"00",
"complementaryInfo":"<CARD_INFOS BDOM=LA BANQUE POSTALE COUNTRY=FRA PRODUCTCODE=3DV2 NETWORK=CB BANKCODE=20041 PRODUCTNAME=CB FR 3DSV2 ONLY PRODUCTPROFILE=D />",
"currencyCode":"978",
"customerIpAddress":"10.X.X.X",
"guaranteeIndicator":"Y",
"holderAuthentRelegation":"N",
"holderAuthentStatus":"SUCCESS",
"maskedPan":"############0400",
"merchantId":"029000254447216",
"orderAmount":1000,
"orderChannel":"INTERNET",
"panExpiryDate":"202401",
"paymentMeanBrand":"CB",
"paymentPattern":"ONE_SHOT",
"responseCode":"00",
"responseDescription":"Process succeeded",
"scoreProfile":"01_GONOGO_PRE_AUTHORISATION",
"tokenPan":"501767h071470400",
"transactionDateTime":"2023-11-27.17:58:31+0100",
"transactionOrigin":"SIMS",
"transactionReference":"SIM20231127175823",
"captureLimitDate":"20231127",
"paymentMeanType":"CARD",
"panEntryMode":"MANUAL",
"holderAuthentMethod":"NOT_SPECIFIED",
"holderAuthentProgram":"3DS_V2",
"s10TransactionId":"7",
"s10TransactionIdDate":"20231127",
"cardProductCode":"3DV2",
"cardProductName":"CB FR 3DSV2 ONLY",
"cardProductProfile":"D",
"issuerCode":"20041",
"issuerCountryCode":"FRA",
"acquirerNativeResponseCode":"00",
"sealAlgorithm":"sha256",
"paymentMeanBrandSelectionStatus":"NOT_APPLICABLE",
"transactionPlatform":"PROD",
"paymentAttemptNumber":1,
"holderAuthentType":"FRICTIONLESS",
"acquirerContractNumber":"1999641011",
"authentExemptionReasonList":["LOW_VALUE"],
"schemeTransactionIdentifier":"7dcafb57d28f4003b16b002d12bd50461746c6c30ccf46208e",
"paymentAccountReference":"5577729c2fff49698bbce797637bc",
"virtualCardIndicator":"N",
"cardProductUsageLabel":"DEBIT",
"authorisationTypeLabel":"TRANSACTION DE PAIEMENT",
"authorMessageReference":"311942",
"acceptanceSystemApplicationId":"142000000001",
"challengeMode3DS":"NO_PREFERENCE",
"issuingCountryCode":"FRA",
"abortedProcessingData":{},
"settlementArchivingReference":"303000000876",
"issuerName":"LA BANQUE POSTALE",
"threeDLiabilityShift":"Y",
"threeDRelegationCode":"N",
"threeDStatusCode":"SUCCESS"
}
        
            captureDay=0|captureMode=AUTHOR_CAPTURE|currencyCode=978|merchantId=029000254447216|orderChannel=INTERNET|responseCode=00|transactionDateTime=2023-11-27T17:57:47+01:00|transactionReference=SIM20231127175654|keyVersion=1|acquirerResponseCode=00|amount=1000|authorisationId=304827|guaranteeIndicator=Y|panExpiryDate=202401|paymentMeanBrand=CB|paymentMeanType=CARD|complementaryCode=00|complementaryInfo=<CARD_INFOS BDOM=LA BANQUE POSTALE COUNTRY=FRA PRODUCTCODE=3DV2 NETWORK=CB BANKCODE=20041 PRODUCTNAME=CB FR 3DSV2 ONLY PRODUCTPROFILE=D />|customerIpAddress=10.X.X.X|maskedPan=############0400|scoreProfile=01_GONOGO_PRE_AUTHORISATION|holderAuthentRelegation=N|holderAuthentStatus=SUCCESS|tokenPan=501767h071470400|transactionOrigin=SIMS|paymentPattern=ONE_SHOT|customerMobilePhone=null|mandateAuthentMethod=null|mandateUsage=null|transactionActors=null|mandateId=null|captureLimitDate=20231127|dccStatus=null|dccResponseCode=null|dccAmount=null|dccCurrencyCode=null|dccExchangeRate=null|dccExchangeRateValidity=null|dccProvider=null|statementReference=null|panEntryMode=MANUAL|walletType=null|holderAuthentMethod=NOT_SPECIFIED|holderAuthentProgram=3DS_V2|paymentMeanId=null|instalmentNumber=null|instalmentDatesList=null|instalmentTransactionReferencesList=null|instalmentAmountsList=null|settlementMode=null|mandateCertificationType=null|valueDate=null|creditorId=null|acquirerResponseIdentifier=null|acquirerResponseMessage=null|paymentMeanTradingName=null|additionalAuthorisationNumber=null|issuerWalletInformation=null|s10TransactionId=6|s10TransactionIdDate=20231127|preAuthenticationColor=null|preAuthenticationInfo=null|preAuthenticationProfile=null|preAuthenticationThreshold=null|preAuthenticationValue=null|invoiceReference=null|s10transactionIdsList=null|cardProductCode=3DV2|cardProductName=CB FR 3DSV2 ONLY|cardProductProfile=D|issuerCode=20041|issuerCountryCode=FRA|acquirerNativeResponseCode=00|settlementModeComplement=null|preAuthorisationProfile=null|preAuthorisationProfileValue=null|preAuthorisationRuleResultList=null|preAuthenticationProfileValue=null|preAuthenticationRuleResultList=null|paymentMeanBrandSelectionStatus=NOT_APPLICABLE|transactionPlatform=PROD|avsAddressResponseCode=null|avsPostcodeResponseCode=null|customerCompanyName=null|customerBusinessName=null|customerLegalId=null|customerPositionOccupied=null|paymentAttemptNumber=1|holderContactEmail=null|installmentIntermediateServiceProviderOperationIdsList=null|holderAuthentType=FRICTIONLESS|acquirerContractNumber=1999641011|secureReference=null|authentExemptionReasonList=LOW_VALUE|paymentAccountReference=8aef6418ef204436b648b991f941c|schemeTransactionIdentifier=2c25917425cc45738cb9475b2bc496446132dceaab3344949b|guaranteeLimitDateTime=null|paymentMeanDataProvider=null|virtualCardIndicator=N|cardProductUsageLabel=DEBIT|authorisationTypeLabel=TRANSACTION DE PAIEMENT|authorMessageReference=268095|acceptanceSystemApplicationId=142000000001|challengeMode3DS=NO_PREFERENCE|issuingCountryCode=FRA|abortedProcessingStep=null|abortedProcessingLocation=null|customerBankAccountType=null|customerBankCode=null|customerAccount=null|reattemptMode=null|reattemptMax=null|reattemptStartDateTime=null|reattemptEndDateTime=null|settlementArchivingReference=303000000875|issuerName=LA BANQUE POSTALE

Changelog


Interface version Data Attendance Container
3.0 abortedProcessingLocation Response
3.0 abortedProcessingStep Response
2.39 acceptanceSystemApplicationId Response
2.25 acquirerContractNumber Response
2.12 acquirerNativeResponseCode Response
2.0 acquirerResponseCode Response
2.8 acquirerResponseIdentifier Response
2.8 acquirerResponseMessage Response
2.0 amount Response
2.6 amountsList Response
3.4 authentDateTime Response
2.28 authentExemptionReasonList Response
2.39 authorMessageReference Response
2.0 authorisationId Response
2.39 authorisationTypeLabel Response
2.17 avsAddressResponseCode Response
2.17 avsPostcodeResponseCode Response
2.17 businessName Response
2.0 captureDay Response
2.3 captureLimitDate Response
2.0 captureMode Response
2.0 cardCSCResultCode Response
2.12 cardProductCode Response
2.12 cardProductName Response
2.12 cardProductProfile Response
2.39 cardProductUsageLabel Response
2.0 cardScheme Response
2.0 cardSeqNumber Response
2.41 challengeMode3DS Response
2.17 company Response
2.0 complementaryCode Response
2.0 complementaryInfo Response
2.7 creditorId Response
2.0 currencyCode Response
3.0 customerAccount Response
3.0 customerBankAccountType Response
3.0 customerBankCode Response
2.0 customerEmail Response
2.0 customerId Response
2.0 customerIpAddress Response
2.6 datesList Response
2.3 dccAmount Response
2.3 dccCurrencyCode Response
2.3 dccProvider Response
2.3 dccResponseCode Response
2.3 dccStatus Response
2.20 email Response
2.0 guaranteeIndicator Response
2.29 guaranteeLimitDateTime Response
2.0 hashPan1 Response
2.0 hashPan2 Response
2.4 holderAuthentMethod Response
2.5 holderAuthentProgram Response
2.0 holderAuthentRelegation Response
2.0 holderAuthentStatus Response
2.24 holderAuthentType Response
2.10 invoiceReference Response
2.12 issuerCode Response
2.12 issuerCountryCode Response
3.2 issuerName Response
2.9 issuerWalletInformation Response
2.44 issuingCountryCode Response
2.17 legalId Response
2.2 mandateAuthentMethod Response
2.7 mandateCertificationType Response
2.3 mandateId Response
2.2 mandateUsage Response
2.0 maskedPan Response
2.0 merchantSessionId Response
2.0 merchantTransactionDateTime Response
2.0 merchantWalletId Response
2.1 mobile Response
2.6 number Response
2.0 orderChannel Response
2.0 orderId Response
2.4 panEntryMode Response
2.0 panExpiryDate Response
2.28 paymentAccountReference Response
2.18 paymentAttemptNumber Response
2.0 paymentMeanBrand Response
2.14 paymentMeanBrandSelectionStatus Response
2.35 paymentMeanDataProvider Response
2.6 paymentMeanId Response
2.8 paymentMeanTradingName Response
2.0 paymentMeanType Response
2.0 paymentPattern Response
2.17 positionOccupied Response
2.10 preAuthenticationColor Response
2.10 preAuthenticationInfo Response
2.10 preAuthenticationProfile Response
2.14 preAuthenticationProfileValue Response
2.14 preAuthenticationRuleResultList Response
2.0 ruleCode Container
  • preAuthenticationRuleResultList
  • preAuthorisationRuleResultList
    • 2.0 ruleDetailedInfo Container
  • preAuthenticationRuleResultList
  • preAuthorisationRuleResultList
    • 2.0 ruleResultIndicator Container
  • preAuthenticationRuleResultList
  • preAuthorisationRuleResultList
    • 2.0 ruleSetting Container
  • preAuthenticationRuleResultList
  • preAuthorisationRuleResultList
    • 2.0 ruleType Container
  • preAuthenticationRuleResultList
  • preAuthorisationRuleResultList
    • 2.0 ruleWeight Container
  • preAuthenticationRuleResultList
  • preAuthorisationRuleResultList
    • 2.10 preAuthenticationThreshold Response
    2.10 preAuthenticationValue Response
    2.14 preAuthorisationProfile Response
    2.14 preAuthorisationProfileValue Response
    2.14 preAuthorisationRuleResultList Response
    3.1 reattemptEndDateTime Response
    3.1 reattemptMax Response
    3.1 reattemptMode Response
    3.1 reattemptStartDateTime Response
    2.0 responseCode Response
    2.0 returnContext Response
    2.9 s10TransactionId Response
    2.9 s10TransactionIdDate Response
    2.11 s10TransactionIdsList Response
    2.28 schemeTransactionIdentifier Response
    2.0 scoreColor Response
    2.0 scoreInfo Response
    2.0 scoreProfile Response
    2.0 scoreThreshold Response
    2.0 scoreValue Response
    2.0 sealAlgorithm Response
    2.26 secureReference Response
    3.2 settlementArchivingReference Response
    2.7 settlementMode Response
    2.4 statementReference Response
    2.0 tokenPan Response
    2.2 transactionActors Response
    2.0 transactionDateTime Response
    2.0 transactionOrigin Response
    2.16 transactionPlatform Response
    2.6 transactionReferencesList Response
    2.7 valueDate Response
    2.36 virtualCardIndicator Response
    2.4 walletType Response
    2.0 keyVersion Response
    Back to top Need help?

    This site uses trackers to improve your experience, perform analysis and researches on your use of Sherlock's documentation website.
    You have several options:
    Closing this banner you refuse the use of trackers on your device.

    Configuration