ECheck Class
Properties Methods Events Configuration Settings Errors
The ECheck class is used to process Electronic Check (ACH) transactions through Internet Payment services such as the Authorize.Net eCheck.Net service.
Syntax
inpay.Echeck
Remarks
The ECheck class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.
The ECheck class 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 class'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 class, 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 class.
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 class:
| Gateway | Home page |
| No Gateway (0) | n/a |
| Authorize.Net AIM(1) | http://www.authorize.net |
| eProcessing Transparent Database Engine(2) | http://www.eProcessingNetwork.com |
| iTransact RediCharge HTML (4) | http://www.itransact.com |
| NetBilling DirectMode (5) | http://www.netbilling.com |
| PayFlow Pro (6) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
| USA ePay CGI Transaction Gateway (7) | http://www.usaepay.com |
| Plug 'n Pay (8) | http://www.plugnpay.com |
| Planet Payment iPay(9) | http://planetpayment.com/ |
| MPCS (10) | http://merchantcommerce.net/ |
| RTWare (11) | http://www.rtware.net/ |
| ECX (12) | http://www.ecx.com |
| Merchant Anywhere (Transaction Central) (15) | http://www.merchantanywhere.com/ |
| TrustCommerce API (19) | http://www.trustcommerce.com |
| PayFuse XML (ClearCommerce Engine) (21) | http://www.firstnationalmerchants.com/ |
| PayFlow Link (22) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
| Chase Paymentech Orbital Gateway (23) | https://merchantservices.chase.com/ |
| LinkPoint (24) | http://www.linkpoint.com |
| Fast Transact VeloCT (Direct Mode) (27) | http://www.fasttransact.com/ |
| NetworkMerchants Direct-Post API (28) | http://www.nmi.com/ |
| TransFirst Transaction Central Classic (formerly PRIGate) (30) | www.transfirst.com |
| Merchant Partners (Transaction Engine) (31) | http://www.merchantpartners.com/ |
| CyberCash (32) | https://www.paypal.com/cybercash |
| First Data Global Gateway (Linkpoint) (33) | http://www.firstdata.com |
| YourPay (34) (Linkpoint) | http://www.yourpay.com |
| ACH Payments AGI (35) | http://www.ach-payments.com |
| Forte AGI / Payments Gateway AGI(36) | https://www.forte.net/ |
| Cyber Source SOAP API (37) | http://www.cybersource.com |
| goEmerchant XML (39) | http://www.goemerchant.com/ |
| TransFirst eLink (40) | http://www.transfirst.com |
| Chase Merchant Services (Linkpoint) (41) | http://www.chase.com |
| Thompson Merchant Services NexCommerce (iTransact mode) (42) | http://www.thompsonmerchant.com |
| TransFirst Transaction Central (44) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
| Sterling SPOT XML API (HTTPS POST) (45) | http://www.sterlingpayment.com |
| Sage Payment Solutions (Bankcard HTTPS Post protocol) (50) | http://www.sagepayments.com |
| Verifi Direct-Post API (54) | http://www.verifi.com |
| Intuit QuickBooks Merchant Services (QBMS) (61) | This gateway is no longer in service. It has been replaced by Quickbooks Payments (113). |
| Heartland POS Gateway (62) | http://www.heartlandpaymentsystems.com/ |
| Litle Online Gateway (63) | http://www.litle.com/ |
| BrainTree DirectPost (Server-to-Server) Gateway (64) | http://www.braintreepaymentsolutions.com/ |
| JetPay Gateway (65) | http://www.jetpay.com/ |
| HSBC XML API (ClearCommerce Engine) (66) | https://www.business.hsbc.uk/en-gb/payments/business-card |
| BluePay 2.0 Post (67) | http://www.bluepay.com |
| Adyen API Payments (68) | http://www.adyen.com |
| PayTrace Payment Gateway (70) | https://www.paytrace.net/ |
| OmniFund HTTP API / GoToBilling(73) | http://omnifund.com/ |
| TransNational Bankcard (74) | http://www.tnbci.com/ |
| Netbanx (75) | http://www.netbanx.com/ |
| ACH Federal (78) | http://www.achfederal.com/ |
| Bluefin (82) | http://www.bluefin.com/ |
| Payscape (83) | http://www.payscape.com |
| Pay Direct (Link2Gov) (84) | https://www.fisglobal.com/solutions/other/government/ |
| WorldPay US Link Gateway (87) | https://www.worldpay.com/en-us/index |
| First Data PayPoint (90) | https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html |
| PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
| Repay Gateway (98) | https://www.repay.com/ |
| BlueSnap Gateway (104) | https://home.bluesnap.com/ |
| BASYS Gateway (106) | https://basyspro.com/ |
| Quickbooks Payments (113) | https://quickbooks.intuit.com/payments/ |
| Heartland Portico Gateway (116) | http://www.heartlandpaymentsystems.com/ |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| Bank | Bank account and routing information for an electronic check transaction. |
| CheckNumber | Indicates the check number to use for a transaction. |
| CompanyName | The Company Name. |
| Customer | Contains the customer's name, address, and other identifying information. |
| Gateway | Gateway to process transactions with. |
| GatewayURL | Default URL for a specific Gateway . |
| InvoiceNumber | Merchant-generated invoice number. |
| LicenseDOB | Customer's Date of Birth as indicated on his driver's license. |
| LicenseNumber | Customer's drivers license number. |
| LicenseState | State in which customer's drivers license was issued. |
| MerchantLogin | Merchant's Gateway login. |
| MerchantPassword | Merchant's Gateway password. |
| PaymentType | The type of check payment request (commonly referred to as SEC Code). |
| Proxy | A set of properties related to proxy access. |
| Response | Contains the response to the authorization. |
| SpecialFields | A list of additional fields to send in the request. |
| SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| TaxId | Company's Tax Id or a Customer's Social Security Number. |
| TestMode | Turns test mode on and off for transactions sent to the current Gateway . |
| Timeout | A timeout for the class. |
| TransactionAmount | Purchase amount for an authorization or retry transaction. Not used for reversals. |
| TransactionDesc | Description of goods purchased. |
| TransactionId | Merchant-generated transaction Id used for all transactions. |
Method List
The following is the full list of the methods of the class 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. |
| DoEvents | Processes events from the internal message queue. |
| 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. |
| VoidTransaction | Voids a previously authorized transaction. |
Event List
The following is the full list of the events fired by the class 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 class with short descriptions. Click on the links for further details.
| AccountToken | A token representing a bank account. |
| AmountFormat | Used to set the input format for TransactionAmount. |
| AuthCode | Authorization code from a previous transaction. |
| AuthNetOpaqueDescriptor | An Authorize.Net opaque data descriptor. |
| AuthNetOpaqueValue | An Authorize.Net opaque data value. |
| BASYSCheckInfoKey | BASYS Gateway Check Info Key. |
| BASYSGovernmentCheck | Determines whether the check is a government Check. |
| BASYSProcessRecurringCheck | Determines whether to process the transaction using Check Info Key. |
| BlueSnapEnterpriseUdfs | User-Defined Fields (UDFs) to send with a BlueSnap Authorize request. |
| BlueSnapRetrieveTransaction | Retrieves a BlueSnap transaction. |
| BlueSnapTransactionMetaData | Transaction metadata to send with a BlueSnap Authorize request. |
| CheckRoutingNumber | Determines whether to perform a checksum test on the RoutingNumber. |
| CurrencyCode | Currency code for the currency of the transaction. |
| CurrencyExponent | Currency exponent to be used in conjunction with the Currency code of the transaction. |
| CyberSourceXMLEscape | Determines whether to XML escape the CyberSource gateway request field values. |
| EscapeXML | Automatically escape data within XML tags. |
| GoEMerchantUseGatewayId | Indicates whether to send a password or gateway Id for the GoEMerchant gateway. |
| HashSecret | Security key used to generate a hash for gateways supporting such functionality. |
| HeartlandDeveloperId | Optional DeveloperId field used by the Heartland gateway. |
| HeartlandDeviceId | DeviceId field required by the Heartland gateway. |
| HeartlandLicenseId | LicenseId field required by the Heartland gateway. |
| HeartlandSecretAPIKey | Specifies the secret key to be used for authentication with Heartland. |
| HeartlandSiteId | SiteId field required by the Heartland gateway. |
| HeartlandSiteTrace | Optional transaction identifier for the Heartland gateway. |
| HeartlandStoreId | StoreId for the Heartland (62) gateway. |
| HeartlandVersionNumber | Optional VersionNumber field used by the Heartland gateway. |
| MerchantAlias | An additional merchant property used to specify an alias for the merchant. |
| MerchantCode | Required field for the Litle gateway. |
| MerchantPartnersLast4Digits | The last 4 digits of the account number for a transaction processed via the MerchantPartners gateway. |
| MerchantPartnersProfileId | The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways. |
| NetbanxAccountNumber | Account Number for the Netbanx gateway. |
| NetBillingVersion | The Version to be sent in the User-Agent heading of a NetBilling gateway request. |
| OrbitalConnectionPassword | Orbital Connection Password field used by the Orbital gateway. |
| OrbitalConnectionUsername | Orbital Connection Username field used by the Orbital gateway. |
| OrbitalCustomerProfileFromOrderInd | Customer Profile Number generation Options for the Orbital gateway. |
| OrbitalCustomerProfileOrderOverrideInd | Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway. |
| PayDirectConvenienceFee | The total convenience fee charged when using the PayDirect gateway. |
| PayDirectMerchantAmount | The MerchantAmount used by the PayDirect gateway. |
| PayDirectSettleMerchantCode | The Settle Merchant Code required for authorization when using the PayDirect gateway. |
| PayerIP | The IP address of the payer. |
| PayFlowProInquiry | Submits an Inquiry transaction to the PayFlowPro gateway. |
| PhoeniXGateCheckInfoKey | PhoeniXGate Gateway Check Info Key. |
| PhoeniXGateGovernmentCheck | Determines whether the check is a government Check. |
| PhoeniXGateProcessRecurringCheck | Determines whether to process the transaction using Check Info Key. |
| RawRequest | Returns the data that was sent to the gateway. |
| RawResponse | Returns the data that was received from the gateway. |
| RepayCheckInfoKey | Repay Gateway Check Info Key. |
| RepayGovernmentCheck | Determines whether the check is a government Check. |
| RepayProcessRecurringCheck | Determines whether to process the transaction using Check Info Key. |
| TerminalId | Terminal Id value sent in the transaction. |
| 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. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the class will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the class. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxHeaders | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| 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. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class 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 class 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;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| UseNTLMv2 | Whether to use NTLM V2. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLContextProtocol | The protocol used when getting an SSLContext instance. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLProvider | The name of the security provider to use. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| 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. |
| BuildInfo | Information about the product's build. |
| GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
| LicenseInfo | Information about the current license. |
| UseDaemonThreads | Whether threads created by the class are daemon threads. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |