WL SIPS DOCS

Release 24.5

go directly to content

Search by keywords

searchMandate

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

This operation allows to search the exising mandates of a client. The mandates are related to a given client only if the customerId field was provided in the initializeMandate request parameters.

interfaceVersion recommandée : MR_WS_2.55

It is advised to read the following documents before

  • Recommended

    SDD

    Functional, technical documentation and user guides to help you to integrate WL Sips online payment solution.

    Open in new tab SDD

  • PROD
    https://office-server.sips-services.com/rs-services/v2/mandate/searchMandate
    method
    POST
  • TEST
    https://office-server.test.sips-services.com/rs-services/v2/mandate/searchMandate
    method
    POST
  • PROD
    https://office-server.sips-services.com/services/v2/mandate?wsdl
    method
    POST
  • TEST
    https://office-server.test.sips-services.com/services/v2/mandate?wsdl
    method
    POST

Required

Optional

Request sample

            {
  "customerId": "test123",
  "interfaceVersion": "MR_WS_2.20",
  "keyVersion": "1",
  "merchantId": "011223344550000",
  "seal": "df97074b81e534d70cccbff5446b71d36c4d4de6d995fe630c8077d6fa85c0a3"
}

        
                  <urn:searchMandate>
         <urn:input>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:customerId>test123</urn:customerId>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:seal>4528716bcc78a6e47ae49b1a5dd3dc5ad7a36732f59d3a8c7f0c00a4d3aba79c</urn:seal>
         </urn:input>
      </urn:searchMandate>

        

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",
  "acquirerResponseCode": "00",
  "mandateList": [
    {
      "mandateId": "6768",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    },
    {
      "mandateId": "4659",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    },
    {
      "mandateId": "7083",
      "mandateStatus": "ACTIVE",
      "bic": "123456789",
      "iban": "987654321",
      "transactionActors": "B2C",
      "mandateUsage": "RECURRENT"
    }
  ],
  "seal": "10a575f493ac8a791e78d750ec7bbaa15ebec2c5a39f95dbc49d9a5f1b6ef671"
}

        
                  <searchMandateResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <mandateList>
               <mandate>
                  <mandateId>5840</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
               <mandate>
                  <mandateId>1514</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
               <mandate>
                  <mandateId>9500</mandateId>
                  <mandateStatus>ACTIVE</mandateStatus>
                  <bic>123456789</bic>
                  <iban>987654321</iban>
                  <transactionActors>B2C</transactionActors>
                  <mandateUsage>RECURRENT</mandateUsage>
               </mandate>
            </mandateList>
            <seal>ef7354b3881b5116ec41c10ea2685ad3a48711f629814ca2fa856fd93aa14c07</seal>
         </output>
      </searchMandateResponse>

        

Changelog


Interface version Data Attendance Container
2.0 intermediateServiceProviderId Request
2.0 sealAlgorithm Request
2.0 customerId Request
2.0 interfaceVersion Request
2.0 keyVersion Request
2.0 merchantId Request
2.0 seal Request/Response
2.0 acquirerResponseCode Response
2.21 errorFieldName Response
2.0 mandateList Response
2.0 mandate Container
  • mandateList
  • 2.0 iban Container
  • mandate
  • 2.0 bic Container
  • mandate
  • 2.0 mandateCreationDate Container
  • mandate
  • 2.0 mandateId Container
  • mandate
  • 2.0 mandateLastUpdateDate Container
  • mandate
  • 2.29 mandateSecureReference Container
  • mandate
  • 2.0 mandateSignatureDate Container
  • mandate
  • 2.0 mandateStatus Container
  • mandate
  • 2.0 mandateUsage Container
  • mandate
  • 2.29 riskyMandate Container
  • mandate
  • 2.0 transactionActors Container
  • mandate
  • 2.0 mandateResponseCode Response

    This site uses trackers to improve your experience, perform analysis and researches on your use of WL Sips documentation website.
    You have several options:
    Closing this banner you refuse the use of trackers on your device.

    Configuration