Release 24.5

go directly to content

Search by keywords

finalizeMandate

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

This operation allows the finalization of the mandate signing process and know the result. It must be called after you received the POST form through the merchantReturnUrl (see request of initializeMandate).

Recommended interfaceVersion: MR_WS_2.55

  • PROD
    https://sherlocks-office-server.secure.lcl.fr/rs-services/v2/mandate/finalizeMandate
    method
    POST
  • TEST
    https://office-server-sherlocks.test.sips-services.com/rs-services/v2/mandate/finalizeMandate
    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

            {
  "interfaceVersion": "MR_WS_2.18",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "messageVersion": "0.1",
  "redirectionData": "O4ytL5JBCPDNASyhleIA57zt3cZJx...86aea7"
}

        
                  <urn:finalizeMandate>
         <urn:input>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:messageVersion>0.1</urn:messageVersion>
            <urn:redirectionData>O4ytL5JBCPDNASyhleIA...GAoqArcvXHEEY9WeeBQ7ppJCIEbLvVUUqFZYJDVPWFeW2YqLssk=</urn:redirectionData>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:seal>fa92674c6f3f4d311a96f2948b9e4ffab61b2f8c284c384ec1cde1ba3e18fb76</urn:seal>
         </urn:input>
      </urn:finalizeMandate>

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

Response sample

            {
  "mandateResponseCode": "00",
  "bic": "AGRIFRPP879",
  "iban": "FR1233321114456666",
  "transactionActors": "BTOC",
  "paymentMeanData": {
    "sdd": {
      "mandateAuthentMethod": "MAIL_OTP",
      "mandateUsage": "RECURRENT",
      "mandateCertificationType": "E_BASIC"
    }
  },
  "customerContact": {
    "email": "test@sips.com",
    "firstname": "Firstname",
    "lastname": "Lastname"
  },
  "customerAddress": {
    "city": "City",
    "street": "street name",
    "streetNumber": "123",
    "zipCode": "12345"
  },
  "mandateId": "000000000000000827",
  "seal": "eecf79584ac1acb2d91949940dbebb856061c8dab7f6ed655b8a624742df7adc"
}

        
                  <finalizeMandateResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <bic>AGRIFRPP123</bic>
            <iban>FR761123245648466700148</iban>
            <transactionActors>BTOC</transactionActors>
            <paymentMeanData>
               <sdd>
                  <mandateAuthentMethod>MAIL_OTP</mandateAuthentMethod>
                  <mandateUsage>RECURRENT</mandateUsage>
                  <mandateCertificationType>E_BASIC</mandateCertificationType>
               </sdd>
            </paymentMeanData>
            <paymentMeanAlias/>
            <customerContact>
               <email>test@sips.net</email>
               <firstname>Firstname</firstname>
               <lastname>Lastname</lastname>
               <legalId/>
               <positionOccupied/>
            </customerContact>
            <customerAddress>
               <city>City</city>
               <company/>
               <street>Street name</street>
               <streetNumber>7</streetNumber>
               <zipCode>75000</zipCode>
               <businessName/>
            </customerAddress>
            <mandateId>000000000000008912</mandateId>
            <seal>b6b6df35d94a2d9c0c8f3be354b2e80189c3cecd54e6ce1ba82d409e7a94a173</seal>
         </output>
      </finalizeMandateResponse>

Changelog


Interface version Data Attendance Container
2.0 intermediateServiceProviderId Request
2.0 sealAlgorithm Request
2.0 interfaceVersion Request
2.0 keyVersion Request
2.0 merchantId Request/Response
2.0 messageVersion Request/Response
2.0 redirectionData Request
2.0 seal Request/Response
2.0 acquirerResponseCode Response
2.0 bic Response
2.0 customerAddress Response
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 Response
    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.21 errorFieldName Response
    2.0 iban Response
    2.0 mandateId Response
    2.0 mandateResponseCode Response
    2.0 paymentMeanAlias Response
    2.0 paymentMeanData Response
    2.0 transactionActors 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