API

Click here for a complete list of operations.

GetCancelledPayerReport

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: secure.api.emandates.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.emandates.co.uk/v3/GetCancelledPayerReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <UserAuthenticateHeader xmlns="https://www.emandates.co.uk/v3/">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserAuthenticateHeader>
  </soap:Header>
  <soap:Body>
    <GetCancelledPayerReport xmlns="https://www.emandates.co.uk/v3/">
      <clientSUN>string</clientSUN>
      <fromDate>string</fromDate>
      <toDate>string</toDate>
    </GetCancelledPayerReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCancelledPayerReportResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetCancelledPayerReportResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <CancelledPayerRecords>
          <CancelledPayerRecordAPI>
            <Reference>string</Reference>
            <CreationDate>string</CreationDate>
            <NumberOfPayments>string</NumberOfPayments>
            <NumberOfPaids>string</NumberOfPaids>
            <ValueOfPaids>string</ValueOfPaids>
            <NumberOfUnpaids>string</NumberOfUnpaids>
            <ValueOfUnpaids>string</ValueOfUnpaids>
            <CancelledDate>string</CancelledDate>
            <Type>string</Type>
            <Reason>string</Reason>
          </CancelledPayerRecordAPI>
          <CancelledPayerRecordAPI>
            <Reference>string</Reference>
            <CreationDate>string</CreationDate>
            <NumberOfPayments>string</NumberOfPayments>
            <NumberOfPaids>string</NumberOfPaids>
            <ValueOfPaids>string</ValueOfPaids>
            <NumberOfUnpaids>string</NumberOfUnpaids>
            <ValueOfUnpaids>string</ValueOfUnpaids>
            <CancelledDate>string</CancelledDate>
            <Type>string</Type>
            <Reason>string</Reason>
          </CancelledPayerRecordAPI>
        </CancelledPayerRecords>
      </GetCancelledPayerReportResult>
    </GetCancelledPayerReportResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: secure.api.emandates.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <UserAuthenticateHeader xmlns="https://www.emandates.co.uk/v3/">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserAuthenticateHeader>
  </soap12:Header>
  <soap12:Body>
    <GetCancelledPayerReport xmlns="https://www.emandates.co.uk/v3/">
      <clientSUN>string</clientSUN>
      <fromDate>string</fromDate>
      <toDate>string</toDate>
    </GetCancelledPayerReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetCancelledPayerReportResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetCancelledPayerReportResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <CancelledPayerRecords>
          <CancelledPayerRecordAPI>
            <Reference>string</Reference>
            <CreationDate>string</CreationDate>
            <NumberOfPayments>string</NumberOfPayments>
            <NumberOfPaids>string</NumberOfPaids>
            <ValueOfPaids>string</ValueOfPaids>
            <NumberOfUnpaids>string</NumberOfUnpaids>
            <ValueOfUnpaids>string</ValueOfUnpaids>
            <CancelledDate>string</CancelledDate>
            <Type>string</Type>
            <Reason>string</Reason>
          </CancelledPayerRecordAPI>
          <CancelledPayerRecordAPI>
            <Reference>string</Reference>
            <CreationDate>string</CreationDate>
            <NumberOfPayments>string</NumberOfPayments>
            <NumberOfPaids>string</NumberOfPaids>
            <ValueOfPaids>string</ValueOfPaids>
            <NumberOfUnpaids>string</NumberOfUnpaids>
            <ValueOfUnpaids>string</ValueOfUnpaids>
            <CancelledDate>string</CancelledDate>
            <Type>string</Type>
            <Reason>string</Reason>
          </CancelledPayerRecordAPI>
        </CancelledPayerRecords>
      </GetCancelledPayerReportResult>
    </GetCancelledPayerReportResponse>
  </soap12:Body>
</soap12:Envelope>