Service Web Service

Service

Click here for a complete list of operations.

GetAccountBalance

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: envoytx.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://merchantapi.envoyservices.com/GetAccountBalance"

<?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>
    <GetAccountBalance xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <domainId>string</domainId>
      <accountNumber>string</accountNumber>
      <currency>string</currency>
    </GetAccountBalance>
  </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>
    <GetAccountBalanceResponse xmlns="http://merchantapi.envoyservices.com">
      <GetAccountBalanceResult>
        <DomainId>string</DomainId>
        <AccountNumber>string</AccountNumber>
        <ClearedBalance>decimal</ClearedBalance>
        <UnclearedBalance>decimal</UnclearedBalance>
        <DisplayName>string</DisplayName>
        <Currency>string</Currency>
        <StatusCode>int</StatusCode>
        <StatusMessage>string</StatusMessage>
      </GetAccountBalanceResult>
    </GetAccountBalanceResponse>
  </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: 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>
    <GetAccountBalance xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <domainId>string</domainId>
      <accountNumber>string</accountNumber>
      <currency>string</currency>
    </GetAccountBalance>
  </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>
    <GetAccountBalanceResponse xmlns="http://merchantapi.envoyservices.com">
      <GetAccountBalanceResult>
        <DomainId>string</DomainId>
        <AccountNumber>string</AccountNumber>
        <ClearedBalance>decimal</ClearedBalance>
        <UnclearedBalance>decimal</UnclearedBalance>
        <DisplayName>string</DisplayName>
        <Currency>string</Currency>
        <StatusCode>int</StatusCode>
        <StatusMessage>string</StatusMessage>
      </GetAccountBalanceResult>
    </GetAccountBalanceResponse>
  </soap12:Body>
</soap12:Envelope>