Release 24.5

go directly to content

Search by keywords

walletIssuerWalletInitialize

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

Requests to initialize a one-click payment with an issuer wallets: This request is mandatory to obtain the redirection data and urls used to redirect to buyer into the OneClick authentication process pages for issuer wallets stored in a Sherlock’s wallet. If the initialization step is successful, you will receive in response a secure URL (redirectionUrl) to which the customer should be redirected to continue the one-click payment. This redirection must be made via a POST form, see the part “POST form to external suppliers”. You shall also indicate in the request the URL (merchantReturnUrl) to which the customer will be redirected to at the end of the one-click payment with an external wallet. You must then call the walletIssuerWalletFinalize service to finalize the transaction.

Recommended interfaceVersion: IR_WS_2.55

  • PROD
    https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/checkout/walletIssuerWalletInitialize
    method
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/rs-services/v2/checkout/walletIssuerWalletInitialize
    method
    POST
  • PROD
    https://sherlocks-office-server.secure.lcl.fr/services/v2/checkout?wsdl
    method
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/services/v2/checkout?wsdl
    method
    POST

Required

Optional

Request sample

            {
  "amount": "1000",
  "captureMode": "AUTHOR_CAPTURE",
  "currencyCode": "978",
  "customerIpAddress": "127.0.0.1",
  "interfaceVersion": "IR_WS_2.3",
  "keyVersion": "1",
  "merchantId": "023101122334455",
  "merchantReturnUrl": "http://www.yoursiteweb.com",
  "merchantTransactionDateTime": "2014-07-11T10:59:57.723+02:00",
  "orderChannel": "INTERNET",
  "paymentMeanBrand": "PAYLIB",
  " transactionReference": "TREFEXA2012",
  "merchantWalletId":"12",
  "seal": " 95e479c276d71a07c655f3c2db1bb8b483c0921e544d4af4cff3e220b04eb551"
}

        
                  <urn:walletIssuerWalletInitialize>
         <urn:input>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:transactionReference>TREFEXA2012</urn:transactionReference>
            <urn:interfaceVersion>IR_WS_2.2</urn:interfaceVersion>
            <urn:amount>2500</urn:amount>
            <urn:orderChannel>INTERNET</urn:orderChannel>
            <urn:currencyCode>978</urn:currencyCode>
            <urn:paymentMeanBrand>PAYLIB</urn:paymentMeanBrand>
            <urn:merchantReturnUrl>http://www.yoursiteweb.com</urn:merchantReturnUrl>
            <urn:merchantWalletId>12</urn:merchantWalletId>
            <urn:paymentMeanId>3</urn:paymentMeanId>
         </urn:input>
      </urn:walletIssuerWalletInitialize>

Required

  • seal
    presence
    Required
    Interface version
    2.0

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

Optional

  • errorFieldName
    presence
    Optional
    Interface version
    2.0

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

  • issuerWalletType
    presence
    Optional
    Interface version
    2.0

    Issuer wallet type.

    List of values
    BCMCMOBILE
    Bancontact Mobile
    MASTERPASS
    Deprecated - Masterpass
    MERCHANT_WALLET
    Wallet Sherlock’s
    PAYLIB
    Paylib
    VISACHECKOUT
    Deprecated - Visa Checkout
  • messageVersion
    presence
    Optional
    Interface version
    2.0

    Parameters version of redirection (used for Sherlock’s Office with redirection).

  • paymentProviderSessionId
    presence
    Optional
    Interface version
    2.0

    Session ID calculated during initialization of a Sherlock’s In-App payment or via a Wallet external with Sherlock’s Office.

  • redirectionData
    presence
    Optional
    Interface version
    2.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.

  • redirectionUrl
    presence
    Optional
    Interface version
    2.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.

  • 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

Response sample

            {
  "responseCode": "00",
  "redirectionUrl": "https://private-payment.test.sips-services.com/paylib/FrontController",
  "redirectionData": "RSs7cZyL1DqsVso",
  "messageVersion": "0.1",
  "seal": "79cf30535e08b8c6c9cfdd55c343845947f8fea892ec0ea1db96378055f71de6"
}

        
                  <walletIssuerWalletInitializeResponse xmlns="urn:sips:cn:contract:office:checkout:v2">
         <output>
            <responseCode>00</responseCode>
            <redirectionUrl>https://private-payment.test.sips-services.com/paylib/FrontController</redirectionUrl>
            <redirectionData>RSs7cZyL1DqsVs...vceJKsC4lg</redirectionData>
            <messageVersion>0.1</messageVersion>
         </output>
      </walletIssuerWalletInitializeResponse>

Changelog


Interface version Data Attendance Container
2.0 authenticationData Request
2.37 authentAmount Container
  • authenticationData
    • 2.0 cardAuthPolicy Container
  • authenticationData
    • 2.0 automaticReverse Container
  • cardAuthPolicy
    • 2.0 checkAVS Container
  • cardAuthPolicy
    • 2.0 ignoreAddressCheckResult Container
  • cardAuthPolicy
    • 2.0 ignoreCSCCheckResult Container
  • cardAuthPolicy
    • 2.0 ignorePostcodeCheckResult Container
  • cardAuthPolicy
    • 2.0 billingAddress Request
    2.0 addressAdditional3 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional1 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 addressAdditional2 Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 city Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 company Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 country Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 postBox Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 state Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 street Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 streetNumber Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 zipCode Container
  • billingAddress
  • customerAddress
  • deliveryAddress
  • holderAddress
    • 2.0 billingContact Request
    2.0 email Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 firstname Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 gender Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.11 initials Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 lastname Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 mobile Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 phone Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 title Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.23 workphone Container
  • billingContact
  • customerContact
  • deliveryContact
  • holderContact
    • 2.0 captureDay Request
    2.0 captureMode Request
    2.0 customerAddress Request
    2.0 customerContact Request
    2.0 customerData Request
    2.0 birthCity Container
  • customerData
  • holderData
    • 2.0 birthCountry Container
  • customerData
  • holderData
    • 2.0 birthZipCode Container
  • customerData
  • holderData
    • 2.0 birthDate Container
  • customerData
  • holderData
    • 2.51 loyaltyIndicator Container
  • customerData
  • holderData
    • 2.18 maidenName Container
  • customerData
  • holderData
    • 2.0 nationalityCountry Container
  • customerData
  • holderData
    • 2.0 newPassword Container
  • customerData
  • holderData
    • 2.0 password Container
  • customerData
  • holderData
    • 2.0 customerId Request
    2.0 customerIpAddress Request
    2.0 customerLanguage Request
    2.0 deliveryAddress Request
    2.0 deliveryContact Request
    2.0 deliveryData Request
    2.23 deliveryAddressCreationDate Container
  • deliveryData
    • 2.0 deliveryChargeAmount Container
  • deliveryData
    • 2.0 deliveryMethod Container
  • deliveryData
    • 2.0 deliveryMode Container
  • deliveryData
    • 2.0 deliveryOperator Container
  • deliveryData
    • 2.23 electronicDeliveryIndicator Container
  • deliveryData
    • 2.0 estimatedDeliveryDate Container
  • deliveryData
    • 2.0 estimatedDeliveryDelay Container
  • deliveryData
    • 2.0 fraudData Request
    2.0 allowedIpCountryList Container
  • fraudData
    • 2.0 deniedIpCountryList Container
  • fraudData
    • 2.0 bypass3DS Container
  • fraudData
    • 2.0 bypassCtrlList Container
  • fraudData
    • 2.0 allowedCardArea Container
  • fraudData
    • 2.0 allowedIpArea Container
  • fraudData
    • 2.0 deniedCardArea Container
  • fraudData
    • 2.0 deniedCardCountryList Container
  • fraudData
    • 2.23 challengeMode3DS Container
  • fraudData
    • 2.0 allowedCardCountryList Container
  • fraudData
    • 2.23 addressDeliveryBillingMatchIndicator Container
  • fraudData
    • 2.0 deniedIpArea Container
  • fraudData
    • 2.0 bypassInfoList Container
  • fraudData
    • 2.39 merchantAuthentScoreValue Container
  • fraudData
    • 2.27 merchantCustomerAuthentData Container
  • fraudData
    • 2.27 merchantCustomerAuthentDateTime Container
  • fraudData
    • 2.23 merchantCustomerAuthentMethod Container
  • fraudData
    • 2.23 nameDeliveryCustomerMatchIndicator Container
  • fraudData
    • 2.27 productAvailabilityDate Container
  • fraudData
    • 2.23 productAvailabilityIndicator Container
  • fraudData
    • 2.23 reorderProductIndicator Container
  • fraudData
    • 2.0 riskManagementDynamicSettingList Container
  • fraudData
    • 2.0 riskManagementDynamicSetting Container
  • riskManagementDynamicSettingList
    • 2.0 riskManagementDynamicParam Container
  • riskManagementDynamicSetting
    • 2.0 riskManagementDynamicValue Container
  • riskManagementDynamicSetting
    • 2.0 holderAddress Request
    2.0 holderContact Request
    2.0 holderData Request
    2.0 intermediateServiceProviderId Request
    2.0 invoiceReference Request
    2.0 merchantTransactionDateTime Request
    2.0 orderContext Request
    2.0 customerBrowserType Container
  • orderContext
    • 2.0 customerANI Container
  • orderContext
    • 2.0 customerANIInformationIdentifier Container
  • orderContext
    • 2.38 merchantOrderSpecificDataList Container
  • orderContext
    • 2.38 merchantOrderSpecificData Container
  • merchantOrderSpecificDataList
    • 2.38 merchantOrderSpecificDataReference Container
  • merchantOrderSpecificData
    • 2.38 merchantOrderSpecificDataType Container
  • merchantOrderSpecificData
    • 2.38 merchantOrderSpecificDataValue Container
  • merchantOrderSpecificData
    • 2.0 customerHostName Container
  • orderContext
    • 2.0 orderId Request
    2.0 paymentPattern Request
    2.0 responseKeyVersion Request
    2.0 returnContext Request
    2.0 s10TransactionReference Request
    2.0 s10TransactionId Container
  • s10TransactionReference
    • 2.0 s10TransactionIdDate Container
  • s10TransactionReference
    • 2.0 sealAlgorithm Request
    2.33 settlementArchivingReference Request
    2.33 settlementMerchantSpecificData Request
    2.0 shoppingCartDetail Request
    2.27 giftCardAmount Container
  • shoppingCartDetail
    • 2.27 giftCardCurrencyCode Container
  • shoppingCartDetail
    • 2.0 mainProduct Container
  • shoppingCartDetail
    • 2.27 giftCardCount Container
  • shoppingCartDetail
    • 2.0 shoppingCartItemList Container
  • shoppingCartDetail
    • 2.0 shoppingCartItem Container
  • shoppingCartItemList
    • 2.0 productName Container
  • shoppingCartItem
    • 2.0 productUnitTaxAmount Container
  • shoppingCartItem
    • 2.0 productDescription Container
  • shoppingCartItem
    • 2.0 productSKU Container
  • shoppingCartItem
    • 2.0 productQuantity Container
  • shoppingCartItem
    • 2.0 productTaxRate Container
  • shoppingCartItem
    • 2.0 productUnitAmount Container
  • shoppingCartItem
    • 2.0 productCode Container
  • shoppingCartItem
    • 2.0 productCategory Container
  • shoppingCartItem
    • 2.0 productTaxCategory Container
  • shoppingCartItem
    • 2.38 travelData Container
  • shoppingCartItem
    • 2.38 travelCardPeriod Container
  • travelData
    • 2.38 journeyDataList Container
  • travelData
    • 2.38 journeyData Container
  • journeyDataList
    • 2.41 journeyAmount Container
  • journeyData
    • 2.38 carrierIdentifier Container
  • journeyData
    • 2.38 classLevel Container
  • journeyData
    • 2.38 departureDateTime Container
  • journeyData
    • 2.38 arrivalLocation Container
  • journeyData
    • 2.38 destinationCountry Container
  • journeyData
    • 2.0 fareBasis Container
  • journeyData
  • travelContext
    • 2.38 carrierName Container
  • journeyData
    • 2.38 journeyCancellableIndicator Container
  • journeyData
    • 2.38 departureLocation Container
  • journeyData
    • 2.38 journeyInsurance Container
  • journeyData
    • 2.38 journeyInsuranceIndicator Container
  • journeyData
    • 2.38 journeyModality Container
  • journeyData
    • 2.38 journeyMode Container
  • journeyData
    • 2.41 journeyNature Container
  • journeyData
    • 2.38 journeySequence Container
  • journeyData
    • 2.38 journeyStage Container
  • journeyData
    • 2.38 luggageSupplementIndicator Container
  • journeyData
    • 2.38 numberOfTickets Container
  • journeyData
    • 2.38 ticketExchangeabilityIndicator Container
  • journeyData
    • 2.38 ticketIssueCity Container
  • journeyData
    • 2.38 ticketIssueDate Container
  • journeyData
    • 2.38 ticketIssuerName Container
  • journeyData
    • 2.38 ticketReference Container
  • journeyData
    • 2.38 stayDataList Container
  • travelData
    • 2.38 stayData Container
  • stayDataList
    • 2.38 stayCategory Container
  • stayData
    • 2.38 numberOfNights Container
  • stayData
    • 2.38 stayCompany Container
  • stayData
    • 2.38 stayArrivalDateTime Container
  • stayData
    • 2.38 numberOfPeopleStaying Container
  • stayData
    • 2.38 roomServiceLevel Container
  • stayData
    • 2.38 stayDepartureDateTime Container
  • stayData
    • 2.38 stayInsurance Container
  • stayData
    • 2.38 stayInsuranceIndicator Container
  • stayData
    • 2.38 stayLocation Container
  • stayData
    • 2.38 stayNumberOfRooms Container
  • stayData
    • 2.38 stayRentalCarIndicator Container
  • stayData
    • 2.38 passportDataList Container
  • travelData
    • 2.38 passportData Container
  • passportDataList
    • 2.38 passportExpirationDate Container
  • passportData
    • 2.38 passportIssueCountry Container
  • passportData
    • 2.46 mainTravelerFirstName Container
  • travelData
    • 2.38 travelCardType Container
  • travelData
    • 2.41 bookingData Container
  • travelData
    • 2.41 bookerFirstName Container
  • bookingData
    • 2.41 bookerLastName Container
  • bookingData
    • 2.41 bookingId Container
  • bookingData
    • 2.41 bookingPlatform Container
  • bookingData
    • 2.41 bookingPlatformOrderId Container
  • bookingData
    • 2.46 mainTravelerLastName Container
  • travelData
    • 2.38 numberOfTravelers Container
  • travelData
    • 2.38 travelEndDateTime Container
  • travelData
    • 2.38 travelingPayerIndicator Container
  • travelData
    • 2.38 travelReason Container
  • travelData
    • 2.38 travelStartDateTime Container
  • travelData
    • 2.0 shoppingCartTotalAmount Container
  • shoppingCartDetail
    • 2.0 shoppingCartTotalQuantity Container
  • shoppingCartDetail
    • 2.0 shoppingCartTotalTaxAmount Container
  • shoppingCartDetail
    • 2.0 statementReference Request
    2.0 transactionOrigin Request
    2.0 transactionReference Request
    2.0 travelContext Request
    2.0 numberOfRoutingCities Container
  • travelContext
    • 2.0 numberOfAirlineCarriers Container
  • travelContext
    • 2.0 airlineCarrierList Container
  • travelContext
    • 2.0 departureDate Container
  • travelContext
    • 2.0 destinationAirport Container
  • travelContext
    • 2.0 reservationCode Container
  • travelContext
    • 2.0 passengerName Container
  • travelContext
    • 2.0 routingCityList Container
  • travelContext
    • 2.0 originAirport Container
  • travelContext
    • 2.0 numberOfPassengers Container
  • travelContext
    • 2.0 amount Request
    2.0 currencyCode Request
    2.0 interfaceVersion Request
    2.0 keyVersion Request
    2.0 merchantId Request
    2.0 merchantReturnUrl Request
    2.0 merchantWalletId Request
    2.0 orderChannel Request
    2.0 paymentMeanId Request
    2.0 seal Request/Response
    2.0 errorFieldName Response
    2.0 issuerWalletType Response
    2.0 messageVersion Response
    2.0 paymentProviderSessionId Response
    2.0 redirectionData Response
    2.0 redirectionUrl Response
    2.0 responseCode 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