validate Web Service

validate

Click here for a complete list of operations.

getCccDetails

Returns cheque clearing information for the FI at a particular sortcode.

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 /validate/validate.asmx HTTP/1.1
Host: validate.paygateservice.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://validate.paygate.cloud/validate/getCccDetails"

<?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>
    <getCccDetails xmlns="https://validate.paygate.cloud/validate/">
      <keyCode>string</keyCode>
      <sortcode>string</sortcode>
    </getCccDetails>
  </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>
    <getCccDetailsResponse xmlns="https://validate.paygate.cloud/validate/">
      <getCccDetailsResult>
        <cccStatus>string</cccStatus>
        <cccDateLastChanged>string</cccDateLastChanged>
        <cccDateClosed>string</cccDateClosed>
        <cccSettlementBank>string</cccSettlementBank>
        <cccDebitAgencySortCode>string</cccDebitAgencySortCode>
        <cccReturnIndicator>string</cccReturnIndicator>
        <cccGBNIndicator>string</cccGBNIndicator>
        <errorCode>string</errorCode>
        <errorText>string</errorText>
      </getCccDetailsResult>
    </getCccDetailsResponse>
  </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 /validate/validate.asmx HTTP/1.1
Host: validate.paygateservice.com
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>
    <getCccDetails xmlns="https://validate.paygate.cloud/validate/">
      <keyCode>string</keyCode>
      <sortcode>string</sortcode>
    </getCccDetails>
  </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>
    <getCccDetailsResponse xmlns="https://validate.paygate.cloud/validate/">
      <getCccDetailsResult>
        <cccStatus>string</cccStatus>
        <cccDateLastChanged>string</cccDateLastChanged>
        <cccDateClosed>string</cccDateClosed>
        <cccSettlementBank>string</cccSettlementBank>
        <cccDebitAgencySortCode>string</cccDebitAgencySortCode>
        <cccReturnIndicator>string</cccReturnIndicator>
        <cccGBNIndicator>string</cccGBNIndicator>
        <errorCode>string</errorCode>
        <errorText>string</errorText>
      </getCccDetailsResult>
    </getCccDetailsResponse>
  </soap12:Body>
</soap12:Envelope>