ECheck Component [E-Payment Integrator V5]
Properties
Methods
Events
Configuration Settings
The ECheck component is used to process Electronic Check (ACH) transactions through Internet Payment services such as the Authorize.Net eCheck.Net service.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
Remarks
The ECheck component allows you to use multiple Internet Payment Gateways through one interface and one component. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.
The ECheck component allows your website to securely process electronic checks without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the component's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.
The first thing you must do is select one of the gateways supported by the ECheck component, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the ECheck component.
To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.
Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.
Now you are ready to process transactions. Not all gateways process ACH or eCheck transactions the same way. While all gateways require a bank routing and account number, some require additional information such as a driver's license number, bank name, or the account type (checking or savings). The gateways and their required properties are listed in the Gateway property.
Once all your properties are set, simply call the Authorize method. If your gateway supports it, you may also credit bank accounts with the Credit method.
The following gateways are supported by the ECheck component:
| |
| Gateway | Home page |
| No Gateway (0) | n/a |
| Authorize.Net AIM(1) | http://www.authorize.net |
| iTransact RediCharge HTML (8) | http://www.itransact.com |
| NetBilling DirectMode(9) | http://www.netbilling.com |
| USA ePay CGI Transaction Gateway(13) | http://www.usaepay.com |
| Planet Payment iPay(15) | http://planetpayment.com/ |
| MPCS (16) | http://merchantcommerce.net/ |
| RTWare (17) | http://www.rtware.net/ |
| ECX (18) | http://www.ecx.com |
| Merchant Anywhere (Transaction Central) (21) | http://www.merchantanywhere.com/ |
| ECHOnline NVP API(23) | http://www.echo-inc.com |
| TrustCommerce API(25) | http://www.trustcommerce.com |
| Fast Transact VeloCT (Direct Mode) (33) | http://www.fasttransact.com/ |
| TransFirst Transaction Central Classic (formerly PRIGate) (37) | www.transfirst.com |
| Merchant Partners (Transaction Engine) (40) | http://www.merchantpartners.com/ |
| ACH Payments AGI(44) | http://www.ach-payments.com |
| Payments Gateway AGI(45) | https://www.paymentsgateway.net/ |
| Cyber Source SOAP API(46) | http://www.cybersource.com |
| TransFirst eLink(50) | http://www.transfirst.com |
| Thompson Merchant Services NexCommerce (iTransact mode)(53) | http://www.thompsonmerchant.com |
| TransFirst Transaction Central (55) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
| Verifi Direct-Post API(66) | http://www.verifi.com |
| Sterling XML Gateway(78) | http://www.securenet.com |
| PayTrace Payment Gateway (84) | http://www.paytrace.com/ |
Property List
The following is the full list of the properties of the component with short
descriptions. Click on the links for further details.
Method List
The following is the full list of the methods of the component with short
descriptions. Click on the links for further details.
| |
| AddSpecialField | Adds a special field name and the corresponding value. |
| Authorize | Initiates a check authorization transaction. |
| Config | Sets or retrieves a configuration setting. |
| Credit | Credits a previous ACH transaction. |
| GetResponseVar | Parses additional information out of the response. |
| Interrupt | Interrupts the current action. |
| Reset | Clears all properties to their default values. |
| ResetSpecialFields | Resets all special fields to the default settings. |
Event List
The following is the full list of the events fired by the component with short
descriptions. Click on the links for further details.
| |
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
| |
| TransactionId | TransactionId for the SterlingXML gateways. |
| TerminalId | Terminal Id number for the BluePay gateways. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| Authorization | The Authorization string to be sent to the server. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
