Release 24.6

go directly to content

Search by keywords

orderInitialize

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

Allows to initialize a payment with “Sherlock’s In-App.”

Recommended interfaceVersion: IR_MB_3.0

  • PROD
    https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/checkoutInApp/orderInitialize
    method
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/rs-services/v2/checkoutInApp/orderInitialize
    method
    POST

Required

  • amount
    presence
    Required
    Interface version
    1.0

    Transaction amount. The amount must be transmitted in the smallest currency unit.For example in euros: an amount of EUR 10.50 must be transmitted in the form 1050.

  • currencyCode
    presence
    Required
    Interface version
    1.0

    Currency code for the transaction. This code is ISO 4217 compatible.

    List of values
    032
    Argentinean Peso
    036
    Australian Dollar
    048
    Bahrain Dinar
    116
    Cambodian Riel
    124
    Canadian Dollar
    144
    Sri Lanka Rupee
    156
    China Yuan Renminbi
    191
    Croatia Kuna
    203
    Czech Republic Koruna
    208
    Danes crown
    344
    Hong Kong dollar
    348
    Hungary Forint
    352
    Iceland Rupee
    356
    Indian rupee
    376
    Israel Shekel
    392
    Japanese Yen
    410
    South Korean Won
    414
    Kuwait Dinar
    458
    Malaysia Ringgit
    480
    Mauritius Rupee
    484
    Mexican Peso
    524
    Nepal Rupee
    554
    New Zealand Dollar
    578
    Norwegian crown
    634
    Qatar Riyal
    643
    Russia Ruble
    682
    Saudi Arabia Riyal
    702
    Singapore Dollar
    710
    South Africa Rand
    752
    Swedish crown
    756
    Swiss Franc
    764
    Thailand Baht
    784
    United Arab Emirates Dirham
    788
    Tunisia Dinar
    826
    Pound
    840
    American Dollar
    901
    Taiwan Dollar
    941
    Serbian Dinar
    946
    Roumania New Leu
    949
    New Turkish Lira
    952
    CFA Franc
    953
    CFP Franc
    975
    Bulgaria Lev
    978
    Euro
    980
    Ukraine Hryvnia
    985
    Poland Zloty
    986
    Brazilian Real
  • interfaceVersion
    presence
    Required
    Interface version
    1.0

    Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).

    Please refer to the function page for the value to use. Use the latest interface version number.

    List of values
    AR_WS_2.
    Obsolete
    AUT_WS_2.
    Sherlock’s Office (SOAP/JSON) interface for the Sherlock’s authentication services.
    AU_WS_2.
    AU_WS: Sherlock’s Office (SOAP/JSON) interface for the Sherlock’s account update services.
    CR_WS_2.
    Sherlock’s Office (SOAP/JSON) interface for Cash Management functions.
    DR_WS_2.
    Sherlock’s Office (SOAP/JSON) interface for Diagnostic functions.
    FR_WS_2.
    Sherlock’s Office (SOAP) interface for Fraud functions.
    HP_x.x
    Sherlock’s Paypage and Sherlock’s Walletpage (POST) interface.
    IR_MB_
    Sherlock’s In-App (JSON) interface for Sherlock’s In-App functions.
    IR_WS_
    Sherlock’s Paypage and Sherlock’s Office (SOAP/JSON) interface.
    MR_WS_2.
    Sherlock’s Office (SOAP/JSON) interface for mandate management.
    PMR_WS_2.
    Sherlock’s Office (SOAP/JSON) interface for payment method repository information request functions.
    TR_WS_2.
    Sherlock’s Office (SOAP) interface for Token functions.
    WMR_WS_2.
    Sherlock’s Walletpage interface (SOAP/JSON).
    WR_WS_2.
    WR_WS: Sherlock’s Office (SOAP/JSON) interface for Wallet functions.
  • keyVersion
    presence
    Required
    Interface version
    1.2

    Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).

  • merchantId
    presence
    Required
    Interface version
    1.0

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

  • sdkOperationName
    presence
    Required
    Interface version
    1.0

    In the context of Sherlock’s In-App (example: mobile application), indicates at the time of the phase initialization, the name of the operation that was chosens (example: card payment).

    List of values
    ADDCARD
    Adding a card to the Wallet Sherlock’s for the initialization phase of an Sherlock’s In-App transaction
    CARDORDER
    Card payment for the initialization phase of an Sherlock’s In-App transaction
    GETWALLETDATA
    Consulting the information of a Wallet Sherlock’s for the initialization phase of a transaction Sherlock’s In-App
    PAYMENTPROVIDERORDER
    Via an external partner for the initialization phase of an Sherlock’s In-App transaction
    PAYMENTTOKENGENERATE
    Generation of token for a payment Sherlock’s In-App
    THREEDSECUREANDORDER
    Card payment for the initialization phase of an Sherlock’s In-App transaction with 3-D Secure authentication
    THREEDSECUREANDWALLETORDER
    Payment means registered in the Wallet Sherlock’s for the initialization phase of a transaction Sherlock’s In-App with 3-D Secure authentication
    WALLETORDER
    Payment with the Wallet Sherlock’s for the initialization phase of an Sherlock’s In-App transaction
  • seal
    presence
    Required
    Interface version
    1.2

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

Optional

Request sample

            {
  "amount" : "2500",
  "automaticResponseUrl" : "https://automatic-response-url.fr/",
  "captureDay" : "0",
  "captureMode" : "AUTHOR_CAPTURE",
  "currencyCode" : "978",
  "interfaceVersion" : "IR_MB_2.38",
  "keyVersion" : "1",
  "merchantId" : "011223344550000",
  "sdkOperationName" : "CARDORDER",
  "sdkVersion" : "SDK100",
  "transactionReference" : "TREFEXA2021",
  "seal" : "c4372c03a0d678fcf5a401d6a7d8625785580d07257208b8c0dc098e0109963a"
}

Required

  • seal
    presence
    Required
    Interface version
    1.0

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

Optional

  • publicKeyValue
    presence
    Optional
    Interface version
    1.0

    In the context of a payment via Sherlock’s In-App, value of the public key that Sherlock’s sent to merchant in the response of initialisation in order to encrypt the card data that the merchant will send to Sherlock’s.

  • redirectionData
    presence
    Optional
    Interface version
    1.0

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

  • redirectionStatusCode
    presence
    Optional
    Interface version
    1.0

    Response code returned by Sherlock’s when redirecting (e.g. redirecting to the ACS, to Sherlock’s server…). Indicates whether redirecting is possible or not.

    List of values
    00
    • In response to paymentWebInit: transaction initialized
    • In response to walletCheckEnrollment and cardCheckEnrollment: Carte enrolled
    01
    In response to cardCheckEnrollment and walletCheckEnrollment: card non 3-D Secure enrolled
    03
    Merchant contract invalid
    10
    Undefinied card enrollment (in response to cardCheckEnrollment and walletCheckEnrollment only)
    12
    Invalid transaction, check parameters transferred in the request
    14
    Invalid payment mean data (ex: PAN)
    30
    Format error (Webinit ERROR)
    34
    Suspicion of fraud, signature error (Webinit ERROR)
    80
    Error during DS interrogation
    89
    MPI session expired
    91
    Merchant not configured in the 3-D Secire server
    94
    • In response to paymentWebInit: transaction duplicated. The transactionReference of this transaction has already been used
    • In response to cardCheckEnrollment or walletCheckEnrollment: error during the enrollment verification call
    99
    Internal error
  • redirectionStatusMessage
    presence
    Optional
    Interface version
    1.0

    Additional information that is returned with redirectionStatusCode.

  • redirectionUrl
    presence
    Optional
    Interface version
    1.0

    In case of an enrollment check, contains the redirection URL to the ACS required for the cardholder authentication. In case of Sherlock’s In-App payment, contains the URL of the next request. In case of 3-D Secure Standalone, contains the redirection URL to the ACS required for the cardholder authentication.

  • redirectionVersion
    presence
    Optional
    Interface version
    1.0

    Version of the redirection message.

Response sample

            {
  "publicKeyValue":"30820122...10001",
  "redirectionData":"4AgbsrffvP...1_H2YKez1ncQ",
  "redirectionStatusCode":"00",
  "redirectionStatusMessage":"Process succeeded",
  "redirectionUrl":"https://office-server.sips-services.com/rs-api/public/v2/checkoutInApp/cardOrder",
  "redirectionVersion":"IR_MB_2.38",
  "seal":"7001f8b6e4e589878c22fcf22734435f1dc6578ffb315ea0b8d808b1f9a65ea8"
}

Changelog


Interface version Data Attendance Container
2.37 authenticationData Request
2.37 authentAmount Container
  • authenticationData
    • 1.0 automaticResponseUrl Request
    2.35 billingAddress Request
    2.35 addressAdditional3 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 addressAdditional1 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 addressAdditional2 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 city Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 company Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 country Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 postBox Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 state Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 street Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 streetNumber Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 zipCode Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
  • subMerchantAddress
    • 2.35 billingContact Request
    2.35 email Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 firstname Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 gender Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 initials Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 lastname Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 mobile Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 phone Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 title Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.35 workphone Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 1.0 captureDay Request
    1.0 captureMode Request
    2.35 customerAccountHistoric Request
    2.35 addPaymentMeanDate Container
  • customerAccountHistoric
    • 2.35 creationDate Container
  • customerAccountHistoric
    • 2.35 changeDate Container
  • customerAccountHistoric
    • 2.35 customerAccountId Container
  • customerAccountHistoric
    • 2.35 numberOfAttemptsAddCard24Hours Container
  • customerAccountHistoric
    • 2.35 numberOfPurchase180Days Container
  • customerAccountHistoric
    • 2.51 numberOfScoringCancelledPurchase Container
  • customerAccountHistoric
    • 2.35 numberOfTransaction24Hours Container
  • customerAccountHistoric
    • 2.35 numberOfTransactionYear Container
  • customerAccountHistoric
    • 2.51 numberOfUncancelledPurchase Container
  • customerAccountHistoric
    • 2.35 passwordChangeDate Container
  • customerAccountHistoric
    • 2.35 suspiciousActivityIndicator Container
  • customerAccountHistoric
    • 2.35 customerAddress Request
    2.35 customerContact Request
    2.35 customerData Request
    2.35 birthCity Container
  • customerData
  • holderData
    • 2.35 birthCountry Container
  • customerData
  • holderData
    • 2.35 birthZipCode Container
  • customerData
  • holderData
    • 2.35 birthDate Container
  • customerData
  • holderData
    • 2.51 loyaltyIndicator Container
  • customerData
  • holderData
    • 2.35 maidenName Container
  • customerData
  • holderData
    • 2.35 nationalityCountry Container
  • customerData
  • holderData
    • 2.35 newPassword Container
  • customerData
  • holderData
    • 2.35 password Container
  • customerData
  • holderData
    • 1.0 customerEmail Request
    1.0 customerId Request
    1.0 customerLanguage Request
    2.35 deliveryAddress Request
    2.35 deliveryContact Request
    2.35 deliveryData Request
    2.35 deliveryAddressCreationDate Container
  • deliveryData
    • 2.35 deliveryChargeAmount Container
  • deliveryData
    • 2.35 deliveryMethod Container
  • deliveryData
    • 2.35 deliveryMode Container
  • deliveryData
    • 2.35 deliveryOperator Container
  • deliveryData
    • 2.35 electronicDeliveryIndicator Container
  • deliveryData
    • 2.35 estimatedDeliveryDate Container
  • deliveryData
    • 2.35 estimatedDeliveryDelay Container
  • deliveryData
    • 2.35 fraudData Request
    2.35 allowedIpCountryList Container
  • fraudData
    • 2.35 deniedIpCountryList Container
  • fraudData
    • 2.35 bypass3DS Container
  • fraudData
    • 2.35 bypassCtrlList Container
  • fraudData
    • 2.35 allowedCardArea Container
  • fraudData
    • 2.35 allowedIpArea Container
  • fraudData
    • 2.35 deniedCardArea Container
  • fraudData
    • 2.35 deniedCardCountryList Container
  • fraudData
    • 2.35 challengeMode3DS Container
  • fraudData
    • 2.35 allowedCardCountryList Container
  • fraudData
    • 2.35 addressDeliveryBillingMatchIndicator Container
  • fraudData
    • 2.35 deniedIpArea Container
  • fraudData
    • 2.35 bypassInfoList Container
  • fraudData
    • 2.35 merchantAuthentScoreValue Container
  • fraudData
    • 2.35 merchantCustomerAuthentData Container
  • fraudData
    • 2.35 merchantCustomerAuthentDateTime Container
  • fraudData
    • 2.35 merchantCustomerAuthentMethod Container
  • fraudData
    • 2.35 nameDeliveryCustomerMatchIndicator Container
  • fraudData
    • 2.35 productAvailabilityDate Container
  • fraudData
    • 2.35 productAvailabilityIndicator Container
  • fraudData
    • 2.35 reorderProductIndicator Container
  • fraudData
    • 2.35 riskManagementDynamicSettingList Container
  • fraudData
    • 2.35 riskManagementDynamicSetting Container
  • riskManagementDynamicSettingList
    • 2.35 riskManagementDynamicParam Container
  • riskManagementDynamicSetting
    • 2.35 riskManagementDynamicValue Container
  • riskManagementDynamicSetting
    • 2.35 holderAddress Request
    2.35 holderContact Request
    2.35 holderData Request
    3.0 interfaceVersionAutomaticResponse Request
    1.2 intermediateServiceProviderId Request
    1.0 invoiceReference Request
    2.35 merchantName Request
    2.35 merchantReturnUrl Request
    2.35 merchantUrl Request
    1.0 merchantWalletId Request
    2.35 orderContext Request
    2.35 customerBrowserType Container
  • orderContext
    • 2.35 customerANI Container
  • orderContext
    • 2.35 customerANIInformationIdentifier Container
  • orderContext
    • 2.35 customerHostName Container
  • orderContext
    • 1.0 orderId Request
    1.0 paymentMeanBrand Request
    1.2 paymentMeanBrandSelectionStatus Request
    2.38 paymentMeanData Request
    2.38 bancontact Container
  • paymentMeanData
    • 2.38 bancontactMerchantCustomerAuthenticationMethod Container
  • bancontact
    • 2.38 initialAuthenticationCavv Container
  • bancontact
    • 1.0 paymentPattern Request
    2.37 recurringData Request
    2.37 recurringEndDate Container
  • recurringData
    • 2.37 recurringPeriod Container
  • recurringData
    • 2.37 recurringSequence Container
  • recurringData
    • 2.37 recurringSequenceMax Container
  • recurringData
    • 1.5 responseEncoding Request
    1.0 responseKeyVersion Request
    1.0 returnContext Request
    1.3 s10TransactionReference Request
    1.3 s10TransactionId Container
  • s10TransactionReference
    • 1.3 s10TransactionIdDate Container
  • s10TransactionReference
    • 1.0 sdkVersion Request
    1.2 sealAlgorithm Request
    2.33 settlementArchivingReference Request
    2.33 settlementMerchantSpecificData Request
    2.35 shoppingCartDetail Request
    2.35 giftCardAmount Container
  • shoppingCartDetail
    • 2.35 giftCardCurrencyCode Container
  • shoppingCartDetail
    • 2.35 mainProduct Container
  • shoppingCartDetail
    • 2.35 giftCardCount Container
  • shoppingCartDetail
    • 2.35 shoppingCartItemList Container
  • shoppingCartDetail
    • 2.35 shoppingCartItem Container
  • shoppingCartItemList
    • 2.35 productName Container
  • shoppingCartItem
    • 2.35 productUnitTaxAmount Container
  • shoppingCartItem
    • 2.35 productDescription Container
  • shoppingCartItem
    • 2.35 productSKU Container
  • shoppingCartItem
    • 2.35 productQuantity Container
  • shoppingCartItem
    • 2.35 productTaxRate Container
  • shoppingCartItem
    • 2.35 productUnitAmount Container
  • shoppingCartItem
    • 2.35 productCode Container
  • shoppingCartItem
    • 2.35 productCategory Container
  • shoppingCartItem
    • 2.35 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
    • 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
    • 2.35 shoppingCartTotalAmount Container
  • shoppingCartDetail
    • 2.35 shoppingCartTotalQuantity Container
  • shoppingCartDetail
    • 2.35 shoppingCartTotalTaxAmount Container
  • shoppingCartDetail
    • 1.0 statementReference Request
    2.42 subMerchantAddress Request
    2.42 subMerchantCategoryCode Request
    2.42 subMerchantId Request
    2.42 subMerchantLegalId Request
    2.42 subMerchantName Request
    2.42 subMerchantUrl Request
    2.35 tokenPan Request
    2.35 transactionOrigin Request
    1.0 transactionReference Request
    2.35 travelContext Request
    2.35 numberOfRoutingCities Container
  • travelContext
    • 2.35 numberOfAirlineCarriers Container
  • travelContext
    • 2.35 airlineCarrierList Container
  • travelContext
    • 2.35 departureDate Container
  • travelContext
    • 2.35 destinationAirport Container
  • travelContext
    • 2.35 reservationCode Container
  • travelContext
    • 2.35 passengerName Container
  • travelContext
    • 2.35 routingCityList Container
  • travelContext
    • 2.35 fareBasis Container
  • travelContext
    • 2.35 originAirport Container
  • travelContext
    • 2.35 numberOfPassengers Container
  • travelContext
    • 1.0 amount Request
    1.0 currencyCode Request
    1.0 interfaceVersion Request
    1.2 keyVersion Request
    1.0 merchantId Request
    1.0 sdkOperationName Request
    1.2 seal Request/Response
    1.0 publicKeyValue Response
    1.0 redirectionData Response
    1.0 redirectionStatusCode Response
    1.0 redirectionStatusMessage Response
    1.0 redirectionUrl Response
    1.0 redirectionVersion 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