eCheck Web Service

eCheck

Click here for a complete list of operations.

GetCustomers

Retrieve all of your Customer List entries

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
Client_ID:
ApiPassword:
x_delim_data:
x_delim_char:

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 /eCheck.asmx HTTP/1.1
Host: www.greenbyphone.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "CheckProcessing/GetCustomers"

<?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>
    <GetCustomers xmlns="CheckProcessing">
      <Client_ID>string</Client_ID>
      <ApiPassword>string</ApiPassword>
      <x_delim_data>string</x_delim_data>
      <x_delim_char>string</x_delim_char>
    </GetCustomers>
  </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>
    <GetCustomersResponse xmlns="CheckProcessing">
      <GetCustomersResult>
        <Customers>
          <Customer>
            <Customer_ID>long</Customer_ID>
            <Client_ID>long</Client_ID>
            <NickName>string</NickName>
            <PhoneWork>string</PhoneWork>
            <PhoneWorkExtension>string</PhoneWorkExtension>
            <EmailAddress>string</EmailAddress>
            <MerchantAccountNumber>string</MerchantAccountNumber>
            <NameFirst>string</NameFirst>
            <NameLast>string</NameLast>
            <BankAccountCompanyName>string</BankAccountCompanyName>
            <BankAccountAddress1>string</BankAccountAddress1>
            <BankAccountAddress2>string</BankAccountAddress2>
            <BankAccountCity>string</BankAccountCity>
            <BankAccountState>string</BankAccountState>
            <BankAccountZip>string</BankAccountZip>
            <BankAccountCountry>string</BankAccountCountry>
            <DefaultMemo>string</DefaultMemo>
            <BankName>string</BankName>
            <RoutingHash>string</RoutingHash>
            <AccountHash>string</AccountHash>
            <FullAccountHash>string</FullAccountHash>
            <Note>string</Note>
            <UserName>string</UserName>
            <userUpdated>long</userUpdated>
            <timeUpdated>dateTime</timeUpdated>
            <timeCreated>dateTime</timeCreated>
            <deleted>boolean</deleted>
            <RoutingNumberSafe>string</RoutingNumberSafe>
            <AccountNumberSafe>string</AccountNumberSafe>
          </Customer>
          <Customer>
            <Customer_ID>long</Customer_ID>
            <Client_ID>long</Client_ID>
            <NickName>string</NickName>
            <PhoneWork>string</PhoneWork>
            <PhoneWorkExtension>string</PhoneWorkExtension>
            <EmailAddress>string</EmailAddress>
            <MerchantAccountNumber>string</MerchantAccountNumber>
            <NameFirst>string</NameFirst>
            <NameLast>string</NameLast>
            <BankAccountCompanyName>string</BankAccountCompanyName>
            <BankAccountAddress1>string</BankAccountAddress1>
            <BankAccountAddress2>string</BankAccountAddress2>
            <BankAccountCity>string</BankAccountCity>
            <BankAccountState>string</BankAccountState>
            <BankAccountZip>string</BankAccountZip>
            <BankAccountCountry>string</BankAccountCountry>
            <DefaultMemo>string</DefaultMemo>
            <BankName>string</BankName>
            <RoutingHash>string</RoutingHash>
            <AccountHash>string</AccountHash>
            <FullAccountHash>string</FullAccountHash>
            <Note>string</Note>
            <UserName>string</UserName>
            <userUpdated>long</userUpdated>
            <timeUpdated>dateTime</timeUpdated>
            <timeCreated>dateTime</timeCreated>
            <deleted>boolean</deleted>
            <RoutingNumberSafe>string</RoutingNumberSafe>
            <AccountNumberSafe>string</AccountNumberSafe>
          </Customer>
        </Customers>
      </GetCustomersResult>
    </GetCustomersResponse>
  </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 /eCheck.asmx HTTP/1.1
Host: www.greenbyphone.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>
    <GetCustomers xmlns="CheckProcessing">
      <Client_ID>string</Client_ID>
      <ApiPassword>string</ApiPassword>
      <x_delim_data>string</x_delim_data>
      <x_delim_char>string</x_delim_char>
    </GetCustomers>
  </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>
    <GetCustomersResponse xmlns="CheckProcessing">
      <GetCustomersResult>
        <Customers>
          <Customer>
            <Customer_ID>long</Customer_ID>
            <Client_ID>long</Client_ID>
            <NickName>string</NickName>
            <PhoneWork>string</PhoneWork>
            <PhoneWorkExtension>string</PhoneWorkExtension>
            <EmailAddress>string</EmailAddress>
            <MerchantAccountNumber>string</MerchantAccountNumber>
            <NameFirst>string</NameFirst>
            <NameLast>string</NameLast>
            <BankAccountCompanyName>string</BankAccountCompanyName>
            <BankAccountAddress1>string</BankAccountAddress1>
            <BankAccountAddress2>string</BankAccountAddress2>
            <BankAccountCity>string</BankAccountCity>
            <BankAccountState>string</BankAccountState>
            <BankAccountZip>string</BankAccountZip>
            <BankAccountCountry>string</BankAccountCountry>
            <DefaultMemo>string</DefaultMemo>
            <BankName>string</BankName>
            <RoutingHash>string</RoutingHash>
            <AccountHash>string</AccountHash>
            <FullAccountHash>string</FullAccountHash>
            <Note>string</Note>
            <UserName>string</UserName>
            <userUpdated>long</userUpdated>
            <timeUpdated>dateTime</timeUpdated>
            <timeCreated>dateTime</timeCreated>
            <deleted>boolean</deleted>
            <RoutingNumberSafe>string</RoutingNumberSafe>
            <AccountNumberSafe>string</AccountNumberSafe>
          </Customer>
          <Customer>
            <Customer_ID>long</Customer_ID>
            <Client_ID>long</Client_ID>
            <NickName>string</NickName>
            <PhoneWork>string</PhoneWork>
            <PhoneWorkExtension>string</PhoneWorkExtension>
            <EmailAddress>string</EmailAddress>
            <MerchantAccountNumber>string</MerchantAccountNumber>
            <NameFirst>string</NameFirst>
            <NameLast>string</NameLast>
            <BankAccountCompanyName>string</BankAccountCompanyName>
            <BankAccountAddress1>string</BankAccountAddress1>
            <BankAccountAddress2>string</BankAccountAddress2>
            <BankAccountCity>string</BankAccountCity>
            <BankAccountState>string</BankAccountState>
            <BankAccountZip>string</BankAccountZip>
            <BankAccountCountry>string</BankAccountCountry>
            <DefaultMemo>string</DefaultMemo>
            <BankName>string</BankName>
            <RoutingHash>string</RoutingHash>
            <AccountHash>string</AccountHash>
            <FullAccountHash>string</FullAccountHash>
            <Note>string</Note>
            <UserName>string</UserName>
            <userUpdated>long</userUpdated>
            <timeUpdated>dateTime</timeUpdated>
            <timeCreated>dateTime</timeCreated>
            <deleted>boolean</deleted>
            <RoutingNumberSafe>string</RoutingNumberSafe>
            <AccountNumberSafe>string</AccountNumberSafe>
          </Customer>
        </Customers>
      </GetCustomersResult>
    </GetCustomersResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /eCheck.asmx/GetCustomers?Client_ID=string&ApiPassword=string&x_delim_data=string&x_delim_char=string HTTP/1.1
Host: www.greenbyphone.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CustomerCollectionResult xmlns="CheckProcessing">
  <Customers>
    <Customer>
      <Customer_ID>long</Customer_ID>
      <Client_ID>long</Client_ID>
      <NickName>string</NickName>
      <PhoneWork>string</PhoneWork>
      <PhoneWorkExtension>string</PhoneWorkExtension>
      <EmailAddress>string</EmailAddress>
      <MerchantAccountNumber>string</MerchantAccountNumber>
      <NameFirst>string</NameFirst>
      <NameLast>string</NameLast>
      <BankAccountCompanyName>string</BankAccountCompanyName>
      <BankAccountAddress1>string</BankAccountAddress1>
      <BankAccountAddress2>string</BankAccountAddress2>
      <BankAccountCity>string</BankAccountCity>
      <BankAccountState>string</BankAccountState>
      <BankAccountZip>string</BankAccountZip>
      <BankAccountCountry>string</BankAccountCountry>
      <DefaultMemo>string</DefaultMemo>
      <BankName>string</BankName>
      <RoutingHash>string</RoutingHash>
      <AccountHash>string</AccountHash>
      <FullAccountHash>string</FullAccountHash>
      <Note>string</Note>
      <UserName>string</UserName>
      <userUpdated>long</userUpdated>
      <timeUpdated>dateTime</timeUpdated>
      <timeCreated>dateTime</timeCreated>
      <deleted>boolean</deleted>
      <RoutingNumberSafe>string</RoutingNumberSafe>
      <AccountNumberSafe>string</AccountNumberSafe>
    </Customer>
    <Customer>
      <Customer_ID>long</Customer_ID>
      <Client_ID>long</Client_ID>
      <NickName>string</NickName>
      <PhoneWork>string</PhoneWork>
      <PhoneWorkExtension>string</PhoneWorkExtension>
      <EmailAddress>string</EmailAddress>
      <MerchantAccountNumber>string</MerchantAccountNumber>
      <NameFirst>string</NameFirst>
      <NameLast>string</NameLast>
      <BankAccountCompanyName>string</BankAccountCompanyName>
      <BankAccountAddress1>string</BankAccountAddress1>
      <BankAccountAddress2>string</BankAccountAddress2>
      <BankAccountCity>string</BankAccountCity>
      <BankAccountState>string</BankAccountState>
      <BankAccountZip>string</BankAccountZip>
      <BankAccountCountry>string</BankAccountCountry>
      <DefaultMemo>string</DefaultMemo>
      <BankName>string</BankName>
      <RoutingHash>string</RoutingHash>
      <AccountHash>string</AccountHash>
      <FullAccountHash>string</FullAccountHash>
      <Note>string</Note>
      <UserName>string</UserName>
      <userUpdated>long</userUpdated>
      <timeUpdated>dateTime</timeUpdated>
      <timeCreated>dateTime</timeCreated>
      <deleted>boolean</deleted>
      <RoutingNumberSafe>string</RoutingNumberSafe>
      <AccountNumberSafe>string</AccountNumberSafe>
    </Customer>
  </Customers>
</CustomerCollectionResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /eCheck.asmx/GetCustomers HTTP/1.1
Host: www.greenbyphone.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Client_ID=string&ApiPassword=string&x_delim_data=string&x_delim_char=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CustomerCollectionResult xmlns="CheckProcessing">
  <Customers>
    <Customer>
      <Customer_ID>long</Customer_ID>
      <Client_ID>long</Client_ID>
      <NickName>string</NickName>
      <PhoneWork>string</PhoneWork>
      <PhoneWorkExtension>string</PhoneWorkExtension>
      <EmailAddress>string</EmailAddress>
      <MerchantAccountNumber>string</MerchantAccountNumber>
      <NameFirst>string</NameFirst>
      <NameLast>string</NameLast>
      <BankAccountCompanyName>string</BankAccountCompanyName>
      <BankAccountAddress1>string</BankAccountAddress1>
      <BankAccountAddress2>string</BankAccountAddress2>
      <BankAccountCity>string</BankAccountCity>
      <BankAccountState>string</BankAccountState>
      <BankAccountZip>string</BankAccountZip>
      <BankAccountCountry>string</BankAccountCountry>
      <DefaultMemo>string</DefaultMemo>
      <BankName>string</BankName>
      <RoutingHash>string</RoutingHash>
      <AccountHash>string</AccountHash>
      <FullAccountHash>string</FullAccountHash>
      <Note>string</Note>
      <UserName>string</UserName>
      <userUpdated>long</userUpdated>
      <timeUpdated>dateTime</timeUpdated>
      <timeCreated>dateTime</timeCreated>
      <deleted>boolean</deleted>
      <RoutingNumberSafe>string</RoutingNumberSafe>
      <AccountNumberSafe>string</AccountNumberSafe>
    </Customer>
    <Customer>
      <Customer_ID>long</Customer_ID>
      <Client_ID>long</Client_ID>
      <NickName>string</NickName>
      <PhoneWork>string</PhoneWork>
      <PhoneWorkExtension>string</PhoneWorkExtension>
      <EmailAddress>string</EmailAddress>
      <MerchantAccountNumber>string</MerchantAccountNumber>
      <NameFirst>string</NameFirst>
      <NameLast>string</NameLast>
      <BankAccountCompanyName>string</BankAccountCompanyName>
      <BankAccountAddress1>string</BankAccountAddress1>
      <BankAccountAddress2>string</BankAccountAddress2>
      <BankAccountCity>string</BankAccountCity>
      <BankAccountState>string</BankAccountState>
      <BankAccountZip>string</BankAccountZip>
      <BankAccountCountry>string</BankAccountCountry>
      <DefaultMemo>string</DefaultMemo>
      <BankName>string</BankName>
      <RoutingHash>string</RoutingHash>
      <AccountHash>string</AccountHash>
      <FullAccountHash>string</FullAccountHash>
      <Note>string</Note>
      <UserName>string</UserName>
      <userUpdated>long</userUpdated>
      <timeUpdated>dateTime</timeUpdated>
      <timeCreated>dateTime</timeCreated>
      <deleted>boolean</deleted>
      <RoutingNumberSafe>string</RoutingNumberSafe>
      <AccountNumberSafe>string</AccountNumberSafe>
    </Customer>
  </Customers>
</CustomerCollectionResult>