API Web Service

API

Click here for a complete list of operations.

GetPaymentHistoryAllPayersWithBACS

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: uat.api.emandates.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.emandates.co.uk/v3/GetPaymentHistoryAllPayersWithBACS"

<?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>
    <GetPaymentHistoryAllPayersWithBACS xmlns="https://www.emandates.co.uk/v3/">
      <clientID>string</clientID>
      <clientSUN>string</clientSUN>
    </GetPaymentHistoryAllPayersWithBACS>
  </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>
    <GetPaymentHistoryAllPayersWithBACSResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetPaymentHistoryAllPayersWithBACSResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <Payments>
          <PaymentAPI>
            <PayerName>string</PayerName>
            <ClientName>string</ClientName>
            <PayerReference>string</PayerReference>
            <Amount>string</Amount>
            <CollectionDate>string</CollectionDate>
            <DueDate>string</DueDate>
            <Type>string</Type>
            <AlternateKey>string</AlternateKey>
            <Comments>string</Comments>
            <ProductName>string</ProductName>
            <SubProductName>string</SubProductName>
            <PayerAccountNumber>string</PayerAccountNumber>
            <PayerSortCode>string</PayerSortCode>
            <PayerAccountHoldersName>string</PayerAccountHoldersName>
            <Status>string</Status>
            <YourRef>string</YourRef>
          </PaymentAPI>
          <PaymentAPI>
            <PayerName>string</PayerName>
            <ClientName>string</ClientName>
            <PayerReference>string</PayerReference>
            <Amount>string</Amount>
            <CollectionDate>string</CollectionDate>
            <DueDate>string</DueDate>
            <Type>string</Type>
            <AlternateKey>string</AlternateKey>
            <Comments>string</Comments>
            <ProductName>string</ProductName>
            <SubProductName>string</SubProductName>
            <PayerAccountNumber>string</PayerAccountNumber>
            <PayerSortCode>string</PayerSortCode>
            <PayerAccountHoldersName>string</PayerAccountHoldersName>
            <Status>string</Status>
            <YourRef>string</YourRef>
          </PaymentAPI>
        </Payments>
        <BACS>
          <BACSMessageAPI>
            <PayerReference>string</PayerReference>
            <BacsCode>string</BacsCode>
            <BacsType>string</BacsType>
            <BacsNarrative>string</BacsNarrative>
            <BacsDownloadDate>string</BacsDownloadDate>
            <BacsDueDate>string</BacsDueDate>
          </BACSMessageAPI>
          <BACSMessageAPI>
            <PayerReference>string</PayerReference>
            <BacsCode>string</BacsCode>
            <BacsType>string</BacsType>
            <BacsNarrative>string</BacsNarrative>
            <BacsDownloadDate>string</BacsDownloadDate>
            <BacsDueDate>string</BacsDueDate>
          </BACSMessageAPI>
        </BACS>
      </GetPaymentHistoryAllPayersWithBACSResult>
    </GetPaymentHistoryAllPayersWithBACSResponse>
  </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: uat.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>
    <GetPaymentHistoryAllPayersWithBACS xmlns="https://www.emandates.co.uk/v3/">
      <clientID>string</clientID>
      <clientSUN>string</clientSUN>
    </GetPaymentHistoryAllPayersWithBACS>
  </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>
    <GetPaymentHistoryAllPayersWithBACSResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetPaymentHistoryAllPayersWithBACSResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <Payments>
          <PaymentAPI>
            <PayerName>string</PayerName>
            <ClientName>string</ClientName>
            <PayerReference>string</PayerReference>
            <Amount>string</Amount>
            <CollectionDate>string</CollectionDate>
            <DueDate>string</DueDate>
            <Type>string</Type>
            <AlternateKey>string</AlternateKey>
            <Comments>string</Comments>
            <ProductName>string</ProductName>
            <SubProductName>string</SubProductName>
            <PayerAccountNumber>string</PayerAccountNumber>
            <PayerSortCode>string</PayerSortCode>
            <PayerAccountHoldersName>string</PayerAccountHoldersName>
            <Status>string</Status>
            <YourRef>string</YourRef>
          </PaymentAPI>
          <PaymentAPI>
            <PayerName>string</PayerName>
            <ClientName>string</ClientName>
            <PayerReference>string</PayerReference>
            <Amount>string</Amount>
            <CollectionDate>string</CollectionDate>
            <DueDate>string</DueDate>
            <Type>string</Type>
            <AlternateKey>string</AlternateKey>
            <Comments>string</Comments>
            <ProductName>string</ProductName>
            <SubProductName>string</SubProductName>
            <PayerAccountNumber>string</PayerAccountNumber>
            <PayerSortCode>string</PayerSortCode>
            <PayerAccountHoldersName>string</PayerAccountHoldersName>
            <Status>string</Status>
            <YourRef>string</YourRef>
          </PaymentAPI>
        </Payments>
        <BACS>
          <BACSMessageAPI>
            <PayerReference>string</PayerReference>
            <BacsCode>string</BacsCode>
            <BacsType>string</BacsType>
            <BacsNarrative>string</BacsNarrative>
            <BacsDownloadDate>string</BacsDownloadDate>
            <BacsDueDate>string</BacsDueDate>
          </BACSMessageAPI>
          <BACSMessageAPI>
            <PayerReference>string</PayerReference>
            <BacsCode>string</BacsCode>
            <BacsType>string</BacsType>
            <BacsNarrative>string</BacsNarrative>
            <BacsDownloadDate>string</BacsDownloadDate>
            <BacsDueDate>string</BacsDueDate>
          </BACSMessageAPI>
        </BACS>
      </GetPaymentHistoryAllPayersWithBACSResult>
    </GetPaymentHistoryAllPayersWithBACSResponse>
  </soap12:Body>
</soap12:Envelope>