E-Payment Integrator V6 - Online Help
E-Payment Integrator V6
Questions / Feedback?

ECheck Bean

Properties   Methods   Events   Configuration Settings   Errors  

The ECheck component 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 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:

GatewayHome 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
Verisign 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/
Intuit Payment Solutions (17)http://payments.intuit.com/ (Formerly called ECHOnline)
TrustCommerce API (19)http://www.trustcommerce.com
PayFuse XML (ClearCommerce Engine) (21)http://www.firstnationalmerchants.com/
PayFlowLink (22)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
Chase Paymentech Orbital Gateway V5.6 (23)http://www.chasepaymentech.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
Payments Gateway AGI (36)https://www.paymentsgateway.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)http://payments.intuit.com/
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)http://www.business.hsbc.co.uk/1/2/business-banking/business-payment-processing/business-debit-and-credit-card-processing
BluePay 2.0 Post (67)http://www.bluepay.com
Adyen API Payments (68)http://www.adyen.com
PayTrace Payment Gateway (70)http://www.paytrace.com/
GoToBilling Gateway (73)http://www.gotobilling.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)http://www.fisglobal.com/products-government-governmentpayments
WorldPay US Link Gateway (87)http://www.worldpay.com/us
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)http://www.repayonline.com/

Property List


The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.

BankBank account and routing information for an electronic check transaction.
CheckNumberIndicates the check number to use for a transaction.
CompanyNameThe Company Name.
CustomerContains the customer's name, address, and other identifying information.
GatewayGateway to process transactions with.
GatewayURLDefault URL for a specific Gateway .
InvoiceNumberMerchant-generated invoice number.
LicenseDOBCustomer's Date of Birth as indicated on his driver's license.
LicenseNumberCustomer's drivers license number.
LicenseStateState in which customer's drivers license was issued.
MerchantLoginMerchant's Gateway login.
MerchantPasswordMerchant's Gateway password.
PaymentTypeThe type of check payment request (commonly referred to as SEC Code).
ProxyA set of properties related to proxy access.
ResponseContains the response to the authorization.
SpecialFieldsA list of additional fields to send in the request.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TaxIdCompany's Tax Id or a Customer's Social Security Number.
TestModeTurns test mode on and off for transactions sent to the current Gateway .
TimeoutA timeout for the component.
TransactionAmountPurchase amount for an authorization or retry transaction. Not used for reversals.
TransactionDescDescription of goods purchased.
TransactionIdMerchant-generated transaction Id used for all transactions.

Method List


The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.

addSpecialFieldAdds a special field name and the corresponding value.
authorizeInitiates a check authorization transaction.
configSets or retrieves a configuration setting .
creditCredits a previous ACH transaction.
getResponseVarParses additional information out of the response.
interruptInterrupts the current action.
resetClears all properties to their default values.
resetSpecialFieldsResets all special fields to the default settings.
voidTransactionVoids a previously authorized transaction.

Event List


The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.

AuthCodeAuthorization code from a previous transaction.
CheckRoutingNumberDetermines whether to perform a checksum test on the RoutingNumber.
CurrencyCodeCurrency code for the currency of the transaction.
CurrencyExponentCurrency exponent to be used in conjunction with the Currency code of the transaction.
CyberSourceXMLEscapeDetermines whether to XML escape the CyberSource gateway request field values.
HashSecretSecurity key used to generate a hash for gateways supporting such functionality.
MerchantAliasAn additional merchant property used to specify an alias for the merchant.
MerchantCodeRequired field for the Litle gateway.
RawRequestReturns the data that was sent to the gateway.
TerminalIdTerminal Id value sent in the transaction.
HeartlandStoreIdStoreId for the Heartland (62) gateway.
GoEMerchantUseGatewayIdIndicates whether to send a password or gateway Id for the GoEMerchant gateway.
MerchantPartnersLast4DigitsThe last 4 digits of the account number for a transaction processed via the MerchantPartners gateway.
MerchantPartnersProfileIdThe profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.
NetbanxAccountNumberAccount Number for the Netbanx gateway.
NetBillingVersionThe Version to be sent in the User-Agent heading of a NetBilling gateway request.
OrbitalConnectionPasswordOrbital Connection Password field used by the Orbital gateway.
OrbitalConnectionUsernameOrbital Connection Username field used by the Orbital gateway.
OrbitalCustomerProfileFromOrderIndCustomer Profile Number generation Options for the Orbital gateway.
OrbitalCustomerProfileOrderOverrideIndIndicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.
PayDirectConvenienceFeeThe total convenience fee charged when using the PayDirect gateway.
PayDirectMerchantAmountThe MerchantAmount used by the PayDirect gateway.
PayDirectSettleMerchantCodeThe Settle Merchant Code required for authorization when using the PayDirect gateway.
PayFlowProInquirySubmits an Inquiry transaction to the PayFlowPro gateway.
PhoeniXGateProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
PhoeniXGateCheckInfoKeyPhoeniXGate Gateway Check Info Key.
PhoeniXGateGovernmentCheckDetermines whether the check is a government Check.
RepayProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
RepayCheckInfoKeyRepay Gateway Check Info Key.
RepayGovernmentCheckDetermines whether the check is a government Check.
TerminalIdTerminal Id number for the BluePay gateways.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0