Release 24.6

go directly to content

Search by keywords

walletInitialize

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

This function allows to launch several kind of wallet management kinematic with “ (consulting the content of a wallet, adding or deleting a card from a wallet).”

Recommended interfaceVersion: IR_MB_3.0

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

Required

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

  • merchantWalletId
    presence
    Required
    Interface version
    1.0

    Customer’s Wallet identifier.

  • 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

            {
  "automaticResponseUrl" : "https://automatic-response-url.fr/",
  "interfaceVersion" : "IR_MB_1.1",
  "keyVersion" : "1",
  "merchantId" : "011223344550000",
  "merchantWalletId" : "walletId01",
  "sdkOperationName" : "GETWALLETDATA",
  "sdkVersion" : "SDK100",
  "seal" : "4e586868b436245140b1fc96c363fd6b211907b4e742c9b4229499e148711288"
}

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":"OneClick available for provided merchant",
  "redirectionUrl":"https://office-server.sips-services.com/rs-api/public/v2/walletInApp/getWalletData",
  "redirectionVersion":"IR_MB_1.1",
  "seal":"2cbb1daf03059d015e8523ca3e270a36a0614bbe172178c8b3b7cdf53ea7a5fc"
}

Changelog


Interface version Data Attendance Container
1.0 automaticResponseUrl Request
1.2 intermediateServiceProviderId Request
1.0 responseKeyVersion Request
1.0 sdkVersion Request
1.2 sealAlgorithm Request
2.42 subMerchantAddress Request
2.42 streetNumber Container
  • subMerchantAddress
    • 2.42 addressAdditional3 Container
  • subMerchantAddress
    • 2.42 country Container
  • subMerchantAddress
    • 2.42 state Container
  • subMerchantAddress
    • 2.42 postBox Container
  • subMerchantAddress
    • 2.42 city Container
  • subMerchantAddress
    • 2.42 company Container
  • subMerchantAddress
    • 2.42 street Container
  • subMerchantAddress
    • 2.42 addressAdditional1 Container
  • subMerchantAddress
    • 2.42 addressAdditional2 Container
  • subMerchantAddress
    • 2.42 zipCode Container
  • subMerchantAddress
    • 2.42 subMerchantCategoryCode Request
    2.42 subMerchantId Request
    2.42 subMerchantLegalId Request
    2.42 subMerchantName Request
    2.42 subMerchantUrl Request
    1.0 interfaceVersion Request
    1.2 keyVersion Request
    1.0 merchantId Request
    1.0 merchantWalletId 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