API Web Service

API

Click here for a complete list of operations.

GetPayer

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/GetPayer"

<?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>
    <GetPayer xmlns="https://www.emandates.co.uk/v3/">
      <reference>string</reference>
      <clientSUN>string</clientSUN>
    </GetPayer>
  </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>
    <GetPayerResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetPayerResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <PayerWithAnswers>
          <Payer>
            <ID>string</ID>
            <Title>string</Title>
            <Firstname>string</Firstname>
            <Surname>string</Surname>
            <ClientName>string</ClientName>
            <PayerReference>string</PayerReference>
            <PostCode>string</PostCode>
            <Town>string</Town>
            <DOB>string</DOB>
            <ProductName>string</ProductName>
            <SubProductName>string</SubProductName>
            <Email>string</Email>
            <HomeTel>string</HomeTel>
            <MobileTel>string</MobileTel>
            <FullAddress>string</FullAddress>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <AccountNumber>string</AccountNumber>
            <SortCode>string</SortCode>
            <AccountHoldersName>string</AccountHoldersName>
            <Status>string</Status>
            <CreationDate>string</CreationDate>
            <PayerPaymentPlanId>string</PayerPaymentPlanId>
          </Payer>
          <Answers>
            <PayerAnswerAPI xsi:nil="true" />
            <PayerAnswerAPI xsi:nil="true" />
          </Answers>
        </PayerWithAnswers>
      </GetPayerResult>
    </GetPayerResponse>
  </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>
    <GetPayer xmlns="https://www.emandates.co.uk/v3/">
      <reference>string</reference>
      <clientSUN>string</clientSUN>
    </GetPayer>
  </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>
    <GetPayerResponse xmlns="https://www.emandates.co.uk/v3/">
      <GetPayerResult>
        <OverallStatus>boolean</OverallStatus>
        <AuthStatus>boolean</AuthStatus>
        <StatusCode>string</StatusCode>
        <StatusMessage>string</StatusMessage>
        <PayerWithAnswers>
          <Payer>
            <ID>string</ID>
            <Title>string</Title>
            <Firstname>string</Firstname>
            <Surname>string</Surname>
            <ClientName>string</ClientName>
            <PayerReference>string</PayerReference>
            <PostCode>string</PostCode>
            <Town>string</Town>
            <DOB>string</DOB>
            <ProductName>string</ProductName>
            <SubProductName>string</SubProductName>
            <Email>string</Email>
            <HomeTel>string</HomeTel>
            <MobileTel>string</MobileTel>
            <FullAddress>string</FullAddress>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <AccountNumber>string</AccountNumber>
            <SortCode>string</SortCode>
            <AccountHoldersName>string</AccountHoldersName>
            <Status>string</Status>
            <CreationDate>string</CreationDate>
            <PayerPaymentPlanId>string</PayerPaymentPlanId>
          </Payer>
          <Answers>
            <PayerAnswerAPI xsi:nil="true" />
            <PayerAnswerAPI xsi:nil="true" />
          </Answers>
        </PayerWithAnswers>
      </GetPayerResult>
    </GetPayerResponse>
  </soap12:Body>
</soap12:Envelope>