Release 24.5

go directly to content

Search by keywords

Credit

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

This function enables you to credit a customer’s account without an original reference transaction. Therefore, you must have the information of your customer’s means of payment, or the associated token.

Required

Optional

Request sample

            FILE;request;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1
CREDIT;4;023101122334456;SIM20220329092501;66;20210328;20210329;1234567890123456;987;44;978;customer@email.com;customerId;128.0.0.1;INTERNET;orderId;VISA;returnContext;origin;PAN;101;20210329;statementReference;settlementArchivingReference;settlementMerchantSpecificData;invoiceReference
END;1

        
            <?xml version="1.0" encoding="UTF-8"?>
<file format="office" type="request" version="5">
	<header>
		<remitterId>023101122334455</remitterId>
		<date>2018-07-25+02:00</date>
		<time>09:00:00+01:00</time>
		<sequence>1</sequence>
	</header>
	<body>
		<credit recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <amount>66</amount>
            <cardEffectiveDate>20210328</cardEffectiveDate>
            <cardExpiryDate>20210329</cardExpiryDate>
            <cardNumber>1234567890123456</cardNumber>
            <cardCSCValue>987</cardCSCValue>
            <cardSeqNumber>44</cardSeqNumber>
            <currencyCode>978</currencyCode>
            <customerEmail>customer@email.com</customerEmail>
            <customerId>customerId</customerId>
            <customerIpAddress>128.0.0.1</customerIpAddress>
            <orderChannel>INTERNET</orderChannel>
            <orderId>orderId</orderId>
            <paymentMeanBrand>VISA</paymentMeanBrand>
            <returnContext>returnContext</returnContext>
            <transactionOrigin>origin</transactionOrigin>
            <panType>PAN</panType>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <statementReference>statementReference</statementReference>
            <settlementArchivingReference>settlementArchivingReference</settlementArchivingReference>
            <settlementMerchantSpecificData>settlementMerchantSpecificData</settlementMerchantSpecificData>
            <shoppingCartDetail>
                <shoppingCartTotalAmount>66</shoppingCartTotalAmount>
                <shoppingCartTotalQuantity>1</shoppingCartTotalQuantity>
                <shoppingCartTotalTaxAmount>2</shoppingCartTotalTaxAmount>
                <mainProduct>main</mainProduct>
                <ShoppingCartItemList>
                    <shoppingCartItem>
                        <productName>name</productName>
                        <productDescription>description</productDescription>
                        <productCode>code</productCode>
                        <productSKU>sku</productSKU>
                        <productUnitAmount>66</productUnitAmount>
                        <productQuantity>1</productQuantity>
                        <productTaxRate>01</productTaxRate>
                        <productUnitTaxAmount>2</productUnitTaxAmount>
                        <productCategory>category</productCategory>
                        <productTaxCategory>tax</productTaxCategory>
                        <travelData>
                            <numberOfTravelers>3</numberOfTravelers>
                            <travelStartDateTime>2021-03-27</travelStartDateTime>
                            <travelEndDateTime>2021-03-28</travelEndDateTime>
                            <travelReason>reason</travelReason>
                            <travelCardPeriod>period</travelCardPeriod>
                            <travelCardType>cardtype</travelCardType>
                            <PassportDataList>
                                <passportData>
                                    <passportExpirationDate>20210322</passportExpirationDate>
                                    <passportIssueCountry>POL</passportIssueCountry>
                                </passportData>
                            </PassportDataList>
                            <StayDataList>
                                <stayData>
                                    <stayLocation>stayLocation</stayLocation>
                                    <stayArrivalDateTime>2021-03-24</stayArrivalDateTime>
                                    <stayDepartureDateTime>2021-03-23</stayDepartureDateTime>
                                    <numberOfNights>8</numberOfNights>
                                    <numberOfPeopleStaying>9</numberOfPeopleStaying>
                                    <roomServiceLevel>roomServiceLevel</roomServiceLevel>
                                    <stayNumberOfRooms>10</stayNumberOfRooms>
                                    <stayCategory>stayCategory</stayCategory>
                                    <stayCompany>stayCompany</stayCompany>
                                    <stayInsurance>stayInsurance</stayInsurance>
                                    <stayInsuranceIndicator>true</stayInsuranceIndicator>
                                    <stayRentalCarIndicator>true</stayRentalCarIndicator>
                                </stayData>
                            </StayDataList>
                            <JourneyDataList>
                                <journeyData>
                                    <departureLocation>Brazilia</departureLocation>
                                    <arrivalLocation>Sao Polo</arrivalLocation>
                                    <destinationCountry>SRI</destinationCountry>
                                    <departureDateTime>2021-03-26</departureDateTime>
                                    <numberOfTickets>7</numberOfTickets>
                                    <ticketIssuerName>issuerName</ticketIssuerName>
                                    <ticketReference>ticketReference</ticketReference>
                                    <ticketIssueCity>La Paz</ticketIssueCity>
                                    <ticketIssueDate>20210325</ticketIssueDate>
                                    <fareBasis>fareBasis</fareBasis>
                                    <carrierIdentifier>carrierId</carrierIdentifier>
                                    <carrierName>carrierName</carrierName>
                                    <classLevel>class</classLevel>
                                    <journeyModality>modality</journeyModality>
                                    <journeyMode>mode</journeyMode>
                                    <journeyStage>stage</journeyStage>
                                    <journeySequence>sequ</journeySequence>
                                    <journeyInsurance>insurance</journeyInsurance>
                                    <journeyInsuranceIndicator>true</journeyInsuranceIndicator>
                                    <journeyCancellableIndicator>true</journeyCancellableIndicator>
                                    <luggageSupplementIndicator>true</luggageSupplementIndicator>
                                    <ticketExchangeabilityIndicator>true</ticketExchangeabilityIndicator>
                                    <journeyAmount>777</journeyAmount>
                                    <journeyNature>nature</journeyNature>
                                </journeyData>
                            </JourneyDataList>
                            <travelingPayerIndicator>true</travelingPayerIndicator>
                            <bookingData>
                                <bookingPlatform>platform</bookingPlatform>
                                <bookingPlatformOrderId>platformOrderId</bookingPlatformOrderId>
                                <bookingId>bookingId</bookingId>
                                <bookerFirstName>Melody</bookerFirstName>
                                <bookerLastName>Pond</bookerLastName>
                            </bookingData>
                        </travelData>
                    </shoppingCartItem>
                </ShoppingCartItemList>
            </shoppingCartDetail>
            <orderContext>
                <customerHostName>hostName</customerHostName>
                <customerBrowserType>browser</customerBrowserType>
                <customerANI>ani</customerANI>
                <customerANIInformationIdentifier>aniId</customerANIInformationIdentifier>
                <merchantOrderSpecificDataList>
                    <merchantOrderSpecificData>
                        <merchantOrderSpecificDataReference>orderReference</merchantOrderSpecificDataReference>
                        <merchantOrderSpecificDataType>orderDataType</merchantOrderSpecificDataType>
                        <merchantOrderSpecificDataValue>orderDataValue</merchantOrderSpecificDataValue>
                    </merchantOrderSpecificData>
                </merchantOrderSpecificDataList>
            </orderContext>
            <invoiceReference>invoiceReference</invoiceReference>
            <customerContact>
                <firstName>River</firstName>
                <lastName>Song</lastName>
                <gender>F</gender>
                <phone>0203040506</phone>
                <email>river.song.1@dw.net</email>
                <mobile>0607080910</mobile>
                <title>title</title>
                <initials>MP</initials>
            </customerContact>
            <holderContact>
                <firstName>River</firstName>
                <lastName>Song</lastName>
                <gender>F</gender>
                <phone>0203040506</phone>
                <email>river.song.2@dw.net</email>
                <mobile>0607080910</mobile>
                <title>title</title>
                <initials>MP</initials>
            </holderContact>
        </credit>
	</body>
	<end nbRecord="1" />
</file>

Required

  • amount
    presence
    Required
    Interface version
    4
    Order
    4

    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
    4
    Order
    5

    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
    4
    Order
    2

    Identifier of the shop, this value is provided to the merchant by Sherlock’s during the shop registration.

  • officeBatchResponseCode
    presence
    Required
    Interface version
    4
    Order
    21

    officeBatchResponseCode completes the result of the processing of a payment request handled by which would be rejected (classic reject responseCode) and contains the field of the payment request that is in error.

    List of values
    00
    None (all fields are correct)
    01
    merchantId error
    03
    transactionReference error
    04
    merchantTransactionDateTime error
    05
    amount error
    06
    captureDay error
    07
    captureMode error
    08
    operationAmount error
    09
    operationOrigin error
    11
    currencyCode error
    12
    customerIpAddress error
    13
    customerEmail error
    14
    customerId error
    16
    orderId error
    17
    orderChannel error
    18
    transactionOrigin error
    19
    returnContext error
    20
    fromTransactionReference error
    21
    cardExpiryDate error
    22
    cardNumber error
    23
    cardCSCValue error
    24
    cardEffectiveDate error
    25
    cardSeqNumber error
    26
    paymentMeanBrand error
    27
    authorisationId error
    28
    merchantWalletId error
    29
    paymentMeanId error
    30
    paymentPattern error
    31
    number error
    32
    statementReference error
    33
    panType error
    34
    mandateId error
    35
    valueDate error
    36
    paymentMeanAlias error
    37
    account error
    38
    bankCode error
    39
    transactionActors error
    45
    Date fields format error
    46
    settlementMode error
    47
    comment error
    48
    validationIndicator error
    50
    s10TransactionId error
    51
    s10TransactionIdDate error
    52
    s10FromTransactionId error
    53
    s10FromTransactionIdDate error
    54
    fraudData error
    55
    riskManagementDynamicParam error
    56
    riskManagementDynamicValue error
    57
    riskManagementDynamicSettingList error
    58
    fraudListReason error
    59
    fraudListType error
    60
    fraudListLevel error
    61
    fraudListElementType error
    62
    fraudListElementValue error
    63
    lastRecoveryIndicator error
    64
    orderContext error
    65
    travelContext error
    66
    deliveryData error
    67
    address error
    68
    contact error
    69
    cardAuthPolicy error
    70
    shoppingCartDetail error
    71
    merchantExternalId error
    72
    paymentMeansBrandSelectionStatus error
    73
    settlementArchivingReference error
    74
    settlementMerchantSpecificData error
    75
    fromTransactionAcceptor error
    80
    Merchant not registered to use Sherlock’s Office Batch / Merchant not linked to the remitter declared in the header.
  • recordSequence
    presence
    Required
    Interface version
    4
    Order
    1

    Transaction order in a Sherlock’s Office Batch file.

Optional

  • acquirerResponseCode
    presence
    Optional
    Interface version
    4
    Order
    16

    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
  • authorisationId
    presence
    Optional
    Interface version
    4
    Order
    17

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

  • customerEmail
    presence
    Optional
    Interface version
    4
    Order
    6

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

  • customerId
    presence
    Optional
    Interface version
    4
    Order
    7

    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
    4
    Order
    8

    Buyer’s IP address.

  • maskedPan
    presence
    Optional
    Interface version
    4
    Order
    18

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

  • newStatus
    presence
    Optional
    Interface version
    4
    Order
    19

    Status of the transaction updated after a checkout operation. The status of a transaction is described by different keywords which change during the operations it undergoes.

    List of values
    ABORTED
    Transaction totally aborted
    CANCELLED
    Transaction totally cancelled
    CAPTURED
    Transaction sent to the bank
    CAPTURE_REFUSED
    Capture refused
    CREDITED
    Transaction totally refund
    ENDED
    Transaction ended
    EXPIRED
    Transaction expired
    PENDING
    Transaction waiting for the authorisation request response
    PREPROD
    Transaction of a merchant which is in the pre-production mode. It cannot be settled.
    REFUSED
    Transaction refused
    TO_AUTHORIZE
    Transaction waiting for the authorisation request
    TO_CAPTURE
    Transaction to send to the bank to debit the user
    TO_CHALLENGE
    Transaction with a fraud suspicion
    TO_CONFIRM_AUTHOR
    Transaction waiting for confirmation of authorization.
    TO_CONFIRM_CAPTURE
    Transaction waiting for confirmation of settlement
    TO_CONFIRM_CREDIT
    TO_CREDIT
    Transaction to send to the bank to credit the user
    TO_REPLAY
    Transaction waiting for a validation with authorization request
    TO_VALIDATE
    Transaction waiting for a validation
    UNDEFINED
    Transaction status not defined
    WAITING_AUTHOR
    Technical status for transaction in a temporarily state waiting for a authorisation batch response
  • operationDateTime
    presence
    Optional
    Interface version
    4
    Order
    20

    Date and time calculated by Sherlock’s on which the transaction has been completed.

  • orderId
    presence
    Optional
    Interface version
    4
    Order
    9

    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.
  • panType
    presence
    Optional
    Interface version CSV
    5
    Order
    13

    Format of the Primary Account Number provided in the data cardNumber

    List of values
    CSE
    The PAN provided is encrypted by CSE Javascript library (Client Side Encryption)
    PAN
    The PAN is provided in clear text
    STKPAN
    The provided PAN is a SchemeToken
    TOKEN_PAN
    The PAN provided is a token
    VCO_PAN
    Obsolete
  • paymentMeanBrand
    presence
    Optional
    Interface version
    4
    Order
    10

    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
  • responseCode
    presence
    Optional
    Interface version
    4
    Order
    15

    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
    4
    Order
    11

    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.
  • s10TransactionReference
    presence
    Optional
    Interface version XML
    5
    Interface version CSV
    5
    Order
    14

    Contains the identification of the transaction (to be compliant with Sherlock’s 1.0).Contains the data pair (s10TransactionId, s10TransactionIdDAte) which ensures the uniqueness of the transaction 1.0.

    Contains
  • settlementArchivingReference
    presence
    Optional
    Interface version XML
    22
    Interface version CSV
    22
    Order
    25

    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.

  • statementReference
    presence
    Optional
    Interface version XML
    10
    Interface version CSV
    10
    Order
    23

    Reference provided by the merchant which is sent in the payment collection flow. This reference appears on the account statements of the cardholder.

  • transactionOrigin
    presence
    Optional
    Interface version
    4
    Order
    12

    Origin of a transaction (for example: name of the programme), set by the merchant. Exemple: “Website A v1.32”.

  • transactionPlatform
    presence
    Optional
    Interface version XML
    7
    Interface version CSV
    7
    Order
    22

    Platform where the transaction has been executed.

    List of values
    PRE-PROD
    Pre-production transaction not sent to remittance
    PROD
    Production transaction
    SIMU
    Simulated transaction
    UAT
    User acceptance test transaction
  • transactionReference
    presence
    Optional
    Interface version
    4
    Order
    3

    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.

  • virtualCardIndicator
    presence
    Optional
    Interface version XML
    13
    Interface version CSV
    13
    Order
    24

    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

Response sample

            FILE;response;office;v19
HEADER;023101122334455;2021-12-16+0100;14:26:45+0100;1;00;2021-12-16T00:00:00+0100;2021-12-16T00:00:00+0100
CREDIT;4;023101122334456;SIM20220329092501;66;978;customer@email.com;customerId;128.0.0.1;orderId;VISA;returnContext;origin;PAN;101;20210329;00;00;authorisationId;maskedPan;TO_CAPTURE;operationDateTime;00;transactionPlatform;statementReference;virtualCardIndicator
END;1

        
            <?xml version="1.0" encoding="UTF-8"?>
<file version="v19" format="office" type="response">
    <header>
        <remitterId>023101122334455</remitterId>
        <date>2021-12-16+01:00</date>
        <time>14:26:45+01:00</time>
        <sequence>1</sequence>
        <processingResponseCode>00</processingResponseCode>
        <beginProcessTime>2021-12-16T00:00:00+01:00</beginProcessTime>
        <endProcessTime>2021-12-16T00:00:00+01:00</endProcessTime>
    </header>
	<body>
		<credit recordSequence="1">
            <merchantId>023101122334456</merchantId>
            <transactionReference>SIM20220329092501</transactionReference>
            <amount>66</amount>
            <currencyCode>978</currencyCode>
            <customerEmail>customer@email.com</customerEmail>
            <customerId>customerId</customerId>
            <customerIpAddress>128.0.0.1</customerIpAddress>
            <orderId>orderId</orderId>
            <paymentMeanBrand>VISA</paymentMeanBrand>
            <returnContext>returnContext</returnContext>
            <transactionOrigin>origin</transactionOrigin>
            <panType>PAN</panType>
            <s10TransactionReference>
                <s10TransactionId>101</s10TransactionId>
                <s10TransactionIdDate>20210329</s10TransactionIdDate>
            </s10TransactionReference>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <authorisationId>authorisationId</authorisationId>
            <maskedPan>maskedPan</maskedPan>
            <newStatus>TO_CAPTURE</newStatus>
            <operationDateTime>operationDateTime</operationDateTime>
            <officeBatchResponseCode>00</officeBatchResponseCode>
            <transactionPlatform>transactionPlatform</transactionPlatform>
            <statementReference>statementReference</statementReference>
            <virtualCardIndicator>virtualCardIndicator</virtualCardIndicator>
        </credit>
	</body>
	<end nbRecord="1" />
</file>

Changelog


Interface version Data Attendance Container
4 cardCSCValue Request
4 cardEffectiveDate Request
4 cardSeqNumber Request
XML: 15 customerContact Request
4 email Container
  • customerContact
  • holderContact
    • 4 firstname Container
  • customerContact
  • holderContact
    • 4 gender Container
  • customerContact
  • holderContact
    • XML: 18
    CSV: 18     		initials Container
  • customerContact
  • holderContact
    • 4 lastname Container
  • customerContact
  • holderContact
    • XML: 8
    CSV: 8     		mobile Container
  • customerContact
  • holderContact
    • 4 phone Container
  • customerContact
  • holderContact
    • XML: 18
    CSV: 18     		title Container
  • customerContact
  • holderContact
    • 4 customerEmail Request/Response
    4 customerId Request/Response
    4 customerIpAddress Request/Response
    XML: 16 holderContact Request
    XML: 15
    CSV: 15     		invoiceReference Request
    XML: 20
    CSV: 20     		merchantLocationId Request
    4 orderChannel Request
    XML: 15 orderContext Request
    4 customerHostName Container
  • orderContext
    • 4 customerANIInformationIdentifier Container
  • orderContext
    • XML: 15 merchantOrderSpecificDataList Container
  • orderContext
    • 4 merchantOrderSpecificData Container
  • merchantOrderSpecificDataList
    • merchantOrderSpecificDataReference Container
  • merchantOrderSpecificData
    • merchantOrderSpecificDataType Container
  • merchantOrderSpecificData
    • merchantOrderSpecificDataValue Container
  • merchantOrderSpecificData
    • 4 customerANI Container
  • orderContext
    • 4 customerBrowserType Container
  • orderContext
    • 4 orderId Request/Response
    CSV: 5 panType Request/Response
    4 paymentMeanBrand Request/Response
    4 returnContext Request/Response
    XML: 5
    CSV: 5     		s10TransactionReference Request/Response
    4 s10TransactionId Container
  • s10TransactionReference
    • 4 s10TransactionIdDate Container
  • s10TransactionReference
    • XML: 13
    CSV: 13     		settlementArchivingReference Request/Response
    XML: 13
    CSV: 13     		settlementMerchantSpecificData Request
    XML: 15 shoppingCartDetail Request
    4 mainProduct Container
  • shoppingCartDetail
    • 4 shoppingCartItemList Container
  • shoppingCartDetail
    • 4 shoppingCartItem Container
  • shoppingCartItemList
    • productName Container
  • shoppingCartItem
    • productUnitTaxAmount Container
  • shoppingCartItem
    • productDescription Container
  • shoppingCartItem
    • productSKU Container
  • shoppingCartItem
    • productQuantity Container
  • shoppingCartItem
    • productTaxRate Container
  • shoppingCartItem
    • productUnitAmount Container
  • shoppingCartItem
    • productCode Container
  • shoppingCartItem
    • productCategory Container
  • shoppingCartItem
    • productTaxCategory Container
  • shoppingCartItem
    • travelData Container
  • shoppingCartItem
    • travelCardPeriod Container
  • travelData
    • journeyDataList Container
  • travelData
    • journeyData Container
  • journeyDataList
    • journeyAmount Container
  • journeyData
    • carrierIdentifier Container
  • journeyData
    • classLevel Container
  • journeyData
    • departureDateTime Container
  • journeyData
    • arrivalLocation Container
  • journeyData
    • destinationCountry Container
  • journeyData
    • fareBasis Container
  • journeyData
    • carrierName Container
  • journeyData
    • journeyCancellableIndicator Container
  • journeyData
    • departureLocation Container
  • journeyData
    • journeyInsurance Container
  • journeyData
    • journeyInsuranceIndicator Container
  • journeyData
    • journeyModality Container
  • journeyData
    • journeyMode Container
  • journeyData
    • journeyNature Container
  • journeyData
    • journeySequence Container
  • journeyData
    • journeyStage Container
  • journeyData
    • luggageSupplementIndicator Container
  • journeyData
    • numberOfTickets Container
  • journeyData
    • ticketExchangeabilityIndicator Container
  • journeyData
    • ticketIssueCity Container
  • journeyData
    • ticketIssueDate Container
  • journeyData
    • ticketIssuerName Container
  • journeyData
    • ticketReference Container
  • journeyData
    • stayDataList Container
  • travelData
    • stayData Container
  • stayDataList
    • stayCategory Container
  • stayData
    • numberOfNights Container
  • stayData
    • stayCompany Container
  • stayData
    • stayArrivalDateTime Container
  • stayData
    • numberOfPeopleStaying Container
  • stayData
    • roomServiceLevel Container
  • stayData
    • stayDepartureDateTime Container
  • stayData
    • stayInsurance Container
  • stayData
    • stayInsuranceIndicator Container
  • stayData
    • stayLocation Container
  • stayData
    • stayNumberOfRooms Container
  • stayData
    • stayRentalCarIndicator Container
  • stayData
    • passportDataList Container
  • travelData
    • passportData Container
  • passportDataList
    • passportExpirationDate Container
  • passportData
    • passportIssueCountry Container
  • passportData
    • mainTravelerFirstName Container
  • travelData
    • travelCardType Container
  • travelData
    • bookingData Container
  • travelData
    • bookerFirstName Container
  • bookingData
    • bookerLastName Container
  • bookingData
    • bookingId Container
  • bookingData
    • bookingPlatform Container
  • bookingData
    • bookingPlatformOrderId Container
  • bookingData
    • mainTravelerLastName Container
  • travelData
    • numberOfTravelers Container
  • travelData
    • travelEndDateTime Container
  • travelData
    • travelingPayerIndicator Container
  • travelData
    • travelReason Container
  • travelData
    • travelStartDateTime Container
  • travelData
    • 4 shoppingCartTotalAmount Container
  • shoppingCartDetail
    • 4 shoppingCartTotalQuantity Container
  • shoppingCartDetail
    • 4 shoppingCartTotalTaxAmount Container
  • shoppingCartDetail
    • XML: 10
    CSV: 10     		statementReference Request/Response
    4 transactionOrigin Request/Response
    4 transactionReference Request/Response
    4 amount Request/Response
    4 cardExpiryDate Request
    4 cardNumber Request
    4 currencyCode Request/Response
    4 merchantId Request/Response
    4 recordSequence Request/Response
    4 acquirerResponseCode Response
    4 authorisationId Response
    4 maskedPan Response
    4 newStatus Response
    4 operationDateTime Response
    4 responseCode Response
    XML: 7
    CSV: 7     		transactionPlatform Response
    XML: 13
    CSV: 13     		virtualCardIndicator Response
    4 officeBatchResponseCode 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