eCheck
Click here for a complete list of operations.
RecurringInvoice
Create an invoice that will send to the payee via email that once signed will start a recurring draft series into your merchant account
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/RecurringInvoice" <?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> <RecurringInvoice xmlns="CheckProcessing"> <Client_ID>string</Client_ID> <ApiPassword>string</ApiPassword> <CustomerName>string</CustomerName> <EmailAddress>string</EmailAddress> <ItemName>string</ItemName> <ItemDescription>string</ItemDescription> <Amount>string</Amount> <PaymentDate>string</PaymentDate> <RecurringType>string</RecurringType> <RecurringOffset>string</RecurringOffset> <RecurringPayments>string</RecurringPayments> <x_delim_data>string</x_delim_data> <x_delim_char>string</x_delim_char> </RecurringInvoice> </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> <RecurringInvoiceResponse xmlns="CheckProcessing"> <RecurringInvoiceResult> <PaymentResult>string</PaymentResult> <PaymentResultDescription>string</PaymentResultDescription> <Invoice_ID>string</Invoice_ID> <Check_ID>string</Check_ID> </RecurringInvoiceResult> </RecurringInvoiceResponse> </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> <RecurringInvoice xmlns="CheckProcessing"> <Client_ID>string</Client_ID> <ApiPassword>string</ApiPassword> <CustomerName>string</CustomerName> <EmailAddress>string</EmailAddress> <ItemName>string</ItemName> <ItemDescription>string</ItemDescription> <Amount>string</Amount> <PaymentDate>string</PaymentDate> <RecurringType>string</RecurringType> <RecurringOffset>string</RecurringOffset> <RecurringPayments>string</RecurringPayments> <x_delim_data>string</x_delim_data> <x_delim_char>string</x_delim_char> </RecurringInvoice> </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> <RecurringInvoiceResponse xmlns="CheckProcessing"> <RecurringInvoiceResult> <PaymentResult>string</PaymentResult> <PaymentResultDescription>string</PaymentResultDescription> <Invoice_ID>string</Invoice_ID> <Check_ID>string</Check_ID> </RecurringInvoiceResult> </RecurringInvoiceResponse> </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/RecurringInvoice?Client_ID=string&ApiPassword=string&CustomerName=string&EmailAddress=string&ItemName=string&ItemDescription=string&Amount=string&PaymentDate=string&RecurringType=string&RecurringOffset=string&RecurringPayments=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"?> <InvoiceResult xmlns="CheckProcessing"> <PaymentResult>string</PaymentResult> <PaymentResultDescription>string</PaymentResultDescription> <Invoice_ID>string</Invoice_ID> <Check_ID>string</Check_ID> </InvoiceResult>
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/RecurringInvoice HTTP/1.1 Host: www.greenbyphone.com Content-Type: application/x-www-form-urlencoded Content-Length: length Client_ID=string&ApiPassword=string&CustomerName=string&EmailAddress=string&ItemName=string&ItemDescription=string&Amount=string&PaymentDate=string&RecurringType=string&RecurringOffset=string&RecurringPayments=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"?> <InvoiceResult xmlns="CheckProcessing"> <PaymentResult>string</PaymentResult> <PaymentResultDescription>string</PaymentResultDescription> <Invoice_ID>string</Invoice_ID> <Check_ID>string</Check_ID> </InvoiceResult>