Release 24.5

go directly to content

Search by keywords

initializeMandate

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

This operation initializes a mandate signing process. 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 signing process. This redirection must be made via a POST form, see the part “POST form to external suppliers”.

In the request, you shall also indicate the URL (merchantReturnUrl) to which the customer will be redirected to at the end of the process for mandate signature. You must then call the finalizeMandate service to obtain the result of the signing process.

Recommended interfaceVersion: MR_WS_2.55

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

Required

Optional

Request sample

            {
  "customerAddress": {
    "city": "City",
    "country": "FRA",
    "street": "street name",
    "streetNumber": "123",
    "zipCode": "12345"
  },
  "customerContact": {
    "email": "test@sips.com",
    "firstname": "Firstname",
    "gender": "M",
    "lastname": "Lastname"
  },
  "iban": "FR123456456546546546546546",
  "interfaceVersion": "MR_WS_2.18",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "merchantReturnUrl": "https://mywebsite/return.jsp",
  "paymentMeanAlias": "alias",
  "seal": "fc24b9e6bd7a433d258a1df1a8af2698b917d1632aaa1bc12c5c8f45adbeba11"
}

        
                  <urn:initializeMandate>
         <urn:input>
            <urn:paymentMeanAlias>alias</urn:paymentMeanAlias>
            <urn:merchantReturnUrl>https://mywebsite/request.jsp</urn:merchantReturnUrl>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:seal>a7eb2054b6054bedc02e918e7eeb07e3bcecfca945b3e1697fe2a2c4cc3b52a6</urn:seal>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:customerContact>
               <urn:email>test@worldline.com</urn:email>
               <urn:firstname>firstName</urn:firstname>
               <urn:gender>M</urn:gender>
               <urn:lastname>Lastname</urn:lastname>
            </urn:customerContact>
            <urn:customerAddress>
               <urn:city>City</urn:city>
               <urn:country>FRA</urn:country>
               <urn:street>Street name</urn:street>
               <urn:streetNumber>123</urn:streetNumber>
               <urn:zipCode>12345</urn:zipCode>
            </urn:customerAddress>
            <urn:iban>FR7617906001120227366700148</urn:iban>
         </urn:input>
      </urn:initializeMandate>

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

  • acquirerResponseCode
    presence
    Optional
    Interface version
    2.0

    Response code returned by the acquirer during an authorisation request.

    List of values
    00
    Transaction approved or processed successfully
    02
    Contact payment mean issuer
    03
    Invalid acceptor
    04
    Keep the payment mean
    05
    Do not honour
    07
    Keep the payment mean, special conditions
    08
    Approve after identification
    12
    Invalid transaction
    13
    Invalid amount
    14
    Invalid PAN
    15
    Unknown payment mean issuer
    17
    Payment aborted by the buyer
    20
    Invalid response (error in server domain)
    24
    Operation not authorised
    25
    Transaction not found
    30
    Format error
    31
    Id of the acquiring organisation unknown
    33
    payment mean expired (Paypal / Cofidis)
    34
    Fraud suspicion
    40
    Function not supported
    41
    Payment mean lost
    43
    Payment mean stolen
    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
  • errorFieldName
    presence
    Optional
    Interface version
    2.21

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

  • mandateId
    presence
    Optional
    Interface version
    2.0

    Mandate number.

  • mandateResponseCode
    presence
    Optional
    Interface version
    2.0

    Response code returned by the mandate management service.

    List of values
    00
    Mandate operation accepted
    03
    Invalid merchant contract
    05
    Process is refused
    12
    Invalid mandate, check the request parameters
    17
    Buyer cancellation
    25
    Unknown mandate
    30
    Format error
    34
    Fraud suspicion (erroneous seal)
    40
    Function not supported: the operation that you wish to perform is not part of the operation type for which you are authorised
    99
    Temporary problem at the Sherlock’s server level
  • messageVersion
    presence
    Optional
    Interface version
    2.0

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

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

Response sample

            {
  "mandateResponseCode": "00",
  "acquirerResponseCode": "00",
  "redirectionUrl": "https://payment-web.test.sips-services.com/paymentprovider/initsps",
  "redirectionData": "bt1QVw4zgOYphloN0S7DMHpIAJfrMks9H/...j3MFRNbExX",
  "mandateId": "000000000000000826",
  "messageVersion": "0.1",
  "seal": "9019f36306c3c5de4ff8ea9bc4fcc9ebca236cb350c348c6951a81f86d0c6c60"
}

        
                  <initializeMandateResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <redirectionUrl>https://payment-web.test.sips-services.com/paymentprovider/initsps</redirectionUrl>
            <redirectionData>bt1QVw4zgOYphloN0S7DMM9DY...+KSFdhTJlLnw==</redirectionData>
            <messageVersion>0.1</messageVersion>
            <seal>bbd5cc75da6794009791ddb78431828aff33d12e2fe4085be079cdadf29c33e9</seal>
         </output>
      </initializeMandateResponse>

Changelog


Interface version Data Attendance Container
2.0 customerAddress Request
2.0 addressAdditional3 Container
  • customerAddress
    • 2.0 businessName Container
  • customerAddress
    • 2.0 country Container
  • customerAddress
    • 2.0 city Container
  • customerAddress
    • 2.0 company Container
  • customerAddress
    • 2.0 addressAdditional1 Container
  • customerAddress
    • 2.0 addressAdditional2 Container
  • customerAddress
    • 2.0 postBox Container
  • customerAddress
    • 2.0 state Container
  • customerAddress
    • 2.0 street Container
  • customerAddress
    • 2.0 streetNumber Container
  • customerAddress
    • 2.0 zipCode Container
  • customerAddress
    • 2.0 customerContact Request
    2.0 email Container
  • customerContact
    • 2.0 firstname Container
  • customerContact
    • 2.0 gender Container
  • customerContact
    • 2.0 initials Container
  • customerContact
    • 2.0 lastname Container
  • customerContact
    • 2.0 legalId Container
  • customerContact
    • 2.0 mobile Container
  • customerContact
    • 2.0 phone Container
  • customerContact
    • 2.0 positionOccupied Container
  • customerContact
    • 2.0 title Container
  • customerContact
    • 2.0 customerId Request
    2.0 customerLanguage Request
    2.0 intermediateServiceProviderId Request
    2.0 mandateId Request/Response
    2.0 paymentMeanData Request
    2.0 returnContext Request
    2.0 sealAlgorithm Request
    2.0 transactionActors Request
    2.0 iban Request
    2.0 interfaceVersion Request
    2.0 keyVersion Request
    2.0 merchantId Request
    2.0 merchantReturnUrl Request
    2.0 paymentMeanAlias Request
    2.0 seal Request/Response
    2.0 acquirerResponseCode Response
    2.21 errorFieldName Response
    2.0 mandateResponseCode Response
    2.0 messageVersion Response
    2.0 redirectionData Response
    2.0 redirectionUrl 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