EBRServices

Click here for a complete list of operations.

GatewaysAvailable

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 /EBRServices.asmx HTTP/1.1
Host: distributortest.ebr.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ebr.webservices.org/external/GatewaysAvailable"

<?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>
    <GatewaysAvailable xmlns="http://ebr.webservices.org/external/">
      <distributorAccountId>int</distributorAccountId>
      <distributorAccountPin>string</distributorAccountPin>
    </GatewaysAvailable>
  </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>
    <GatewaysAvailableResponse xmlns="http://ebr.webservices.org/external/">
      <GatewaysAvailableResponse xmlns="http://ebr.webservices.org/external/responses">
        <GatewayList>
          <GatewayInfo>
            <Id>string</Id>
            <GatewayName>string</GatewayName>
            <Status>string</Status>
            <ProviderName>string</ProviderName>
            <ProviderId>int</ProviderId>
            <IsOpen>boolean</IsOpen>
            <NextOpen>string</NextOpen>
            <GatewayAvailability xsi:nil="true" />
            <GatewayService xsi:nil="true" />
          </GatewayInfo>
          <GatewayInfo>
            <Id>string</Id>
            <GatewayName>string</GatewayName>
            <Status>string</Status>
            <ProviderName>string</ProviderName>
            <ProviderId>int</ProviderId>
            <IsOpen>boolean</IsOpen>
            <NextOpen>string</NextOpen>
            <GatewayAvailability xsi:nil="true" />
            <GatewayService xsi:nil="true" />
          </GatewayInfo>
        </GatewayList>
      </GatewaysAvailableResponse>
    </GatewaysAvailableResponse>
  </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 /EBRServices.asmx HTTP/1.1
Host: distributortest.ebr.org
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>
    <GatewaysAvailable xmlns="http://ebr.webservices.org/external/">
      <distributorAccountId>int</distributorAccountId>
      <distributorAccountPin>string</distributorAccountPin>
    </GatewaysAvailable>
  </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>
    <GatewaysAvailableResponse xmlns="http://ebr.webservices.org/external/">
      <GatewaysAvailableResponse xmlns="http://ebr.webservices.org/external/responses">
        <GatewayList>
          <GatewayInfo>
            <Id>string</Id>
            <GatewayName>string</GatewayName>
            <Status>string</Status>
            <ProviderName>string</ProviderName>
            <ProviderId>int</ProviderId>
            <IsOpen>boolean</IsOpen>
            <NextOpen>string</NextOpen>
            <GatewayAvailability xsi:nil="true" />
            <GatewayService xsi:nil="true" />
          </GatewayInfo>
          <GatewayInfo>
            <Id>string</Id>
            <GatewayName>string</GatewayName>
            <Status>string</Status>
            <ProviderName>string</ProviderName>
            <ProviderId>int</ProviderId>
            <IsOpen>boolean</IsOpen>
            <NextOpen>string</NextOpen>
            <GatewayAvailability xsi:nil="true" />
            <GatewayService xsi:nil="true" />
          </GatewayInfo>
        </GatewayList>
      </GatewaysAvailableResponse>
    </GatewaysAvailableResponse>
  </soap12:Body>
</soap12:Envelope>