E-Payment Integrator 2020 Python Edition

Questions / Feedback?

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

class 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 gateway_url at this time.

Next, set the merchant_login (and for some gateways the merchant_password). 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:

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
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_account_classIndicates whether a personal or business account is used for this transaction.
bank_account_holder_nameAccount holder's name.
bank_account_numberBank account number for ACH transactions.
bank_account_typeIndicates whether a checking or savings account is used for this transaction.
bank_nameName of the account holder's bank.
bank_routing_numberRouting number for ACH transactions.
check_numberIndicates the check number to use for a transaction.
company_nameThe Company Name.
customer_addressCustomer's street address.
customer_address2A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
customer_aggregateThis property allows you to get or set an XML aggregate built from all of the Customer properties.
customer_cityCustomer's city.
customer_countryCustomer's country.
customer_emailCustomer's email address.
customer_faxCustomer's fax number.
customer_first_nameCustomer's first name.
customer_full_nameCustomer's full name.
customer_idMerchant-generated customer Id.
customer_last_nameCustomer's last name.
customer_phoneCustomer's phone number.
customer_stateCustomer's state.
customer_zipCustomer's zip code (or postal code if outside of the USA).
gatewayGateway to process transactions with.
gateway_urlDefault URL for a specific Gateway .
invoice_numberMerchant-generated invoice number.
license_dobCustomer's Date of Birth as indicated on his driver's license.
license_numberCustomer's drivers license number.
license_stateState in which customer's drivers license was issued.
merchant_loginMerchant's Gateway login.
merchant_passwordMerchant's Gateway password.
payment_typeThe type of check payment request (commonly referred to as SEC Code).
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the TCP port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use SSL for the connection to the proxy.
proxy_userThis property contains a user name, if authentication is to be used for the proxy.
response_approval_codeContains an authorization code when a transaction has been approved.
response_approvedIndicates the status of the last transaction.
response_approved_amountThe amount approved for the transaction, this is the amount actually charged to the credit card.
response_avs_resultContains the Address Verification System result code.
response_codeIndicates the status of the authorization request.
response_cvv_resultContains the returned CVV2 result code if it was requested.
response_dataThe entire response returned from the gateway processor.
response_error_codeAdditional error code returned by some gateways.
response_error_textAdditional error description returned by some gateways.
response_invoice_numberInvoice number submitted in authorization request (if applicable).
response_processor_codeResponse code from the underlying processor.
response_textText information that describes each response code.
response_transaction_idContains the Visa Transaction Identifier or MasterCard Reference Number.
special_field_countThe number of records in the SpecialField arrays.
special_field_nameName of special configuration property to submit in this transaction.
special_field_valueValue of special configuration property to submit in this transaction.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
tax_idCompany's Tax Id or a Customer's Social Security Number.
test_modeTurns test mode on and off for transactions sent to the current Gateway .
timeoutA timeout for the class.
transaction_amountPurchase amount for an authorization or retry transaction. Not used for reversals.
transaction_descDescription of goods purchased.
transaction_idMerchant-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.

add_special_fieldAdds a special field name and the corresponding value.
authorizeInitiates a check authorization transaction.
configSets or retrieves a configuration setting.
creditCredits a previous ACH transaction.
do_eventsProcesses events from the internal message queue.
get_response_varParses additional information out of the response.
interruptInterrupts the current action.
resetClears all properties to their default values.
reset_special_fieldsResets all special fields to the default settings.
void_transactionVoids 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.

on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows 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.

AccountTokenA token representing a bank account.
AmountFormatUsed to set the input format for TransactionAmount.
AuthCodeAuthorization code from a previous transaction.
AuthNetOpaqueDescriptorAn Authorize.Net opaque data descriptor.
AuthNetOpaqueValueAn Authorize.Net opaque data value.
BASYSCheckInfoKeyBASYS Gateway Check Info Key.
BASYSGovernmentCheckDetermines whether the check is a government Check.
BASYSProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
BlueSnapEnterpriseUdfsUser-Defined Fields (UDFs) to send with a BlueSnap Authorize request.
BlueSnapRetrieveTransactionRetrieves a BlueSnap transaction.
BlueSnapTransactionMetaDataTransaction metadata to send with a BlueSnap Authorize request.
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.
EscapeXMLAutomatically escape data within XML tags.
GoEMerchantUseGatewayIdIndicates whether to send a password or gateway Id for the GoEMerchant gateway.
HashSecretSecurity key used to generate a hash for gateways supporting such functionality.
HeartlandDeveloperIdOptional DeveloperId field used by the Heartland gateway.
HeartlandDeviceIdDeviceId field required by the Heartland gateway.
HeartlandLicenseIdLicenseId field required by the Heartland gateway.
HeartlandSecretAPIKeySpecifies the secret key to be used for authentication with Heartland.
HeartlandSiteIdSiteId field required by the Heartland gateway.
HeartlandSiteTraceOptional transaction identifier for the Heartland gateway.
HeartlandStoreIdStoreId for the Heartland (62) gateway.
HeartlandVersionNumberOptional VersionNumber field used by the Heartland gateway.
MerchantAliasAn additional merchant property used to specify an alias for the merchant.
MerchantCodeRequired field for the Litle 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.
PayerIPThe IP address of the payer.
PayFlowProInquirySubmits an Inquiry transaction to the PayFlowPro gateway.
PhoeniXGateCheckInfoKeyPhoeniXGate Gateway Check Info Key.
PhoeniXGateGovernmentCheckDetermines whether the check is a government Check.
PhoeniXGateProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
RawRequestReturns the data that was sent to the gateway.
RawResponseReturns the data that was received from the gateway.
RepayCheckInfoKeyRepay Gateway Check Info Key.
RepayGovernmentCheckDetermines whether the check is a government Check.
RepayProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
TerminalIdTerminal Id value sent in the transaction.
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.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
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.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
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.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class 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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
E-Payment Integrator 2020 Python Edition - Version 20.0 [Build 7941]