Service Web Service

Service

Click here for a complete list of operations.

pollPayments

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 /MerchantAPI.asmx HTTP/1.1
Host: test.envoytx.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://merchantapi.envoyservices.com/pollPayments"

<?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>
    <pollPayments xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <requestReference>string</requestReference>
      <filter>
        <currencyCode>string</currencyCode>
      </filter>
    </pollPayments>
  </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>
    <pollPaymentsResponse xmlns="http://merchantapi.envoyservices.com">
      <pollPaymentsResult>
        <requestReference>string</requestReference>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <payments>
          <payment>
            <uniqueReference>string</uniqueReference>
            <merchantReference>string</merchantReference>
            <epacsReference>string</epacsReference>
            <postingDate>dateTime</postingDate>
            <bankCurrency>string</bankCurrency>
            <bankAmount>double</bankAmount>
            <appliedCurrency>string</appliedCurrency>
            <appliedAmount>double</appliedAmount>
            <countryCode>string</countryCode>
            <bankInformation>string</bankInformation>
          </payment>
          <payment>
            <uniqueReference>string</uniqueReference>
            <merchantReference>string</merchantReference>
            <epacsReference>string</epacsReference>
            <postingDate>dateTime</postingDate>
            <bankCurrency>string</bankCurrency>
            <bankAmount>double</bankAmount>
            <appliedCurrency>string</appliedCurrency>
            <appliedAmount>double</appliedAmount>
            <countryCode>string</countryCode>
            <bankInformation>string</bankInformation>
          </payment>
        </payments>
      </pollPaymentsResult>
    </pollPaymentsResponse>
  </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 /MerchantAPI.asmx HTTP/1.1
Host: test.envoytx.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>
    <pollPayments xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <requestReference>string</requestReference>
      <filter>
        <currencyCode>string</currencyCode>
      </filter>
    </pollPayments>
  </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>
    <pollPaymentsResponse xmlns="http://merchantapi.envoyservices.com">
      <pollPaymentsResult>
        <requestReference>string</requestReference>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <payments>
          <payment>
            <uniqueReference>string</uniqueReference>
            <merchantReference>string</merchantReference>
            <epacsReference>string</epacsReference>
            <postingDate>dateTime</postingDate>
            <bankCurrency>string</bankCurrency>
            <bankAmount>double</bankAmount>
            <appliedCurrency>string</appliedCurrency>
            <appliedAmount>double</appliedAmount>
            <countryCode>string</countryCode>
            <bankInformation>string</bankInformation>
          </payment>
          <payment>
            <uniqueReference>string</uniqueReference>
            <merchantReference>string</merchantReference>
            <epacsReference>string</epacsReference>
            <postingDate>dateTime</postingDate>
            <bankCurrency>string</bankCurrency>
            <bankAmount>double</bankAmount>
            <appliedCurrency>string</appliedCurrency>
            <appliedAmount>double</appliedAmount>
            <countryCode>string</countryCode>
            <bankInformation>string</bankInformation>
          </payment>
        </payments>
      </pollPaymentsResult>
    </pollPaymentsResponse>
  </soap12:Body>
</soap12:Envelope>