logo Mercanet

Release 25.5

go directly to content

Search by keywords

getMandateData

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

This operation provides information about an existing mandate. The response contains mandate-specific information such as status, IBAN, etc … but also the list of “direct debit SEPA” transactions associated with the mandates (if any).

Recommended interfaceVersion: MR_WS_2.58

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

Required

Optional

Request sample

            {
  "interfaceVersion": "MR_WS_2.20",
  "keyVersion": "1",
  "mandateId": "000000000000000677",
  "merchantId": "011223344550000",
  "seal": "39b46a6656d6647b20ffc0d1351d863b7627d7838f7ded02f34a690d9a2d2b8c"
}

        
            <urn:getMandateData>
         <urn:input>
            <urn:interfaceVersion>MR_WS_2.18</urn:interfaceVersion>
            <urn:merchantId>011223344550000</urn:merchantId>
            <urn:mandateId>000000000000000667</urn:mandateId>
            <urn:keyVersion>1</urn:keyVersion>
            <urn:seal>ae13163cfb5c7c8adb39c032876323f6d34d22d378f95d3e05ef774af7f0a720</urn:seal>
         </urn:input>
</urn:getMandateData>

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",
  "mandateId": "000000000000000677",
  "mandateStatus": "ACTIVE",
  "bic": "123456789",
  "iban": "987654321",
  "transactionActors": "BTOC",
  "mandateUsage": "RECURRENT",
  "customerContact": {
    "lastname": "JOHAN JOHAN"
  },
  "customerAddress": {
    "city": "MockCity",
    "country": "FR",
    "street": "Street",
    "streetNumber": "1234",
    "zipCode": "11111"
  },
  "directDebitList": [
    {
      "orderId": "7419",
      "amount": 0
    },
    {
      "orderId": "3336",
      "amount": 0
    },
    {
      "orderId": "8901",
      "amount": 0
    }
  ],
  "seal": "cfff04f2baddfa04c1f731468ebe77dbc83ffca5a3af97e2dbd182762a6b0c8b"
}

        
                  <getMandateDataResponse xmlns="urn:sips:cn:contract:office:mandatemanagement:v2">
         <output>
            <responseCode>00</responseCode>
            <acquirerResponseCode>00</acquirerResponseCode>
            <mandateId>000000000000000667</mandateId>
            <mandateStatus>ACTIVE</mandateStatus>
            <bic>123456789</bic>
            <iban>987654321</iban>
            <transactionActors>BTOC</transactionActors>
            <mandateUsage>RECURRENT</mandateUsage>
            <debtorName>FirstName Lastname</debtorName>
            <customerContact>
               <email>firstname.lastname@maiil.com</email>
            </customerContact>
            <customerAddress>
               <city>MockCity</city>
               <country>FR</country>
               <street>Street</street>
               <streetNumber>1234</streetNumber>
               <zipCode>11111</zipCode>
            </customerAddress>
            <directDebitList>
               <directDebit>
                  <amount>100</amount>
               </directDebit>
               <directDebit>
                  <amount>200</amount>
               </directDebit>
               <directDebit>
                  <amount>200</amount>
               </directDebit>
            </directDebitList>
            <seal>f001a2d283afa8e2087e560e107d49d3100899df93f4ce0e06e814983f93f992</seal>
         </output>
      </getMandateDataResponse>

Changelog


Interface version Data Attendance Container
2.0 intermediateServiceProviderId Request
2.0 sealAlgorithm Request
2.0 interfaceVersion Request
2.0 keyVersion Request
2.0 mandateId Request/Response
2.0 merchantId 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.19 debtorName Response
    2.0 directDebitList Response
    2.0 directDebit Container
  • directDebitList
    • 2.0 amount Container
  • directDebit
    • 2.0 directDebitCreationDate Container
  • directDebit
    • 2.0 directDebitStatus Container
  • directDebit
    • 2.0 dueDate Container
  • directDebit
    • 2.0 iban Response
    2.0 mandateCreationDate Response
    2.0 mandateLastUpdateDate Response
    2.0 mandateResponseCode Response
    2.0 mandateSignatureDate Response
    2.0 mandateStatus Response
    2.0 mandateUsage Response
    2.0 transactionActors Response
    Back to top Need help?