ECheck Gateway Setup and Required Properties
This page contains the available methods, properties, and additional setup information for each gateway.
5th Dimension Logistics (gw5thDimension)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
The merchant_login property corresponds to the 5th Dimension field "mkey".
ACH Federal (gwACHFederal)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
ACH Payments (gwACHPayments)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Adyen (gwAdyen)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
The merchant_login property maps to the Webservice User, and the password is the password given to that user. These values are accessible from the Adyen's online management console (located at https://ca-live.adyen.com/ or https://ca-test.adyen.com/).
You must also set the "TerminalId" configuration setting with the name of your merchant account.
This gateway also requires that the "shopperIP" field be added via add_special_field method..
You may need to set the "CurrencyCode" config depending on your locale.
Authorize.NET (gwAuthorizeNet)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
This gateway has a unique security feature. To use it, you must add the secret hash value provided by the Authorize.Net merchant web interface to the "HashSecret" configuration setting (via the Config method). Both of these values are provided by the Authorize.Net merchant web interface, which is used to set up your account. For example; Config("HashSecret=myhashvalue"). If no hash secret is supplied in the config method, the hash value returned by the server will NOT be checked.
BASYS Gateway (gwBASYS)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Other fields can also be set by calling add_special_field.
For Government Checks, set "BASYSGovernmentCheck" configuration setting to True.
This Gateway does not have a test URL. Transactions will be processed using the production server.
To process Recurring Billing Checks, "BASYSProcessRecurringCheck" configuration setting must be set to True. Also "BASYSCheckInfoKey" must be set to the Check Info Key obtained from RecurringBilling class at the time the payment record was created, and "MerchantCode" configuration setting must be set to the Merchant ID, which is also known as Merchant Number or RPNum.
Bluefin (gwBluefin)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
BluePay (gwBluePay)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are:
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
BlueSnap (gwBlueSnap)
Supported Methods:
merchant_login and merchant_password are required properties.
The transaction_amount should be represented as dollars and cents with a decimal point. For example, "1.00".
test_mode is supported and when set to "True" test transactions can be sent using a sandbox account that will not be captured and settled.
When using the authorize method, there are a number of combinations of request fields that BlueSnap will accept. Please refer to BlueSnap's Payment API JSON documentation for more information about which fields to use for your use-case. You can then use the following table to determine how you should specify each BlueSnap field supported by the ECheck class.
The BlueSnapRetrieveTransaction configuration setting can be used to make the class retrieve a previously created transaction. After retrieving the transaction, the class will automatically populate its properties, special fields, and configuration settings based on the retrieved transaction's data.
| BlueSnap Field Name | ECheck Equivalent |
| amount | transaction_amount property. |
| authorizedByShopper | Ensure that the payment_type property is set to ptWEB (0). |
| currency | CurrencyCode configuration setting. |
| ecpTransaction object fields | bank_account_number, bank_routing_number, bank_account_class, and bank_account_type properties. |
| merchantTransactionId | invoice_number property. |
| payerInfo object fields | Customer* and company_name properties, and special field personalIdentificationNumber. |
| softDescriptor | transaction_desc property. |
| transactionFraudInfo object fields | Special fields fraudSessionId, company, and enterpriseSiteId, and the PayerIP configuration setting. |
| transactionFraudInfo.enterpriseUdfs content | BlueSnapEnterpriseUdfs configuration setting. |
| transactionFraudInfo.shippingContactInfo object fields | Special fields shipFirstName, shipLastName, shipAddress1, shipAddress2, shipCity, shipState, shipZip, and shipCountry. |
| transactionMetaData content | BlueSnapTransactionMetaData configuration setting. |
| vaultedShopperId | Special field vaultedShopperId. |
| vendorInfo object fields | Special fields vendorId, commissionPercent, and commissionAmount. |
Note: The RecurringBilling class can be used to create and update vaulted shopper profiles.
When using the credit method to refund, both the transactionId and the creditAmount parameters are relevant (though the latter is optional, and can be left empty to refund the whole amount captured). You may also specify a refund reason or a vendor amount by adding special fields with the names reason and vendoramount, respectively.
BrainTree (gwBrainTree)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Chase (gwChase)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Your merchant_login will be the "Store Number" provided by Linkpoint. This gateway requires a client certificate, which can be set using the
SSL Certificate properties. Void transactions with this gateway require a transaction timestamp. This timestamp can be retrieved from the original
auth_only response through the get_response_var; method.
Example:
icharge.AuthOnly();
String tdate = icharge.GetResponseVar("/root/r_tdate");
This value can be set for the void_transaction with the add_special_field method. Example:
icharge.AddSpecialField("tdate","YourDate");
icharge.VoidTransaction("TransactionId");
CyberSource (gwCyberSource)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
ECX (gwECX)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
This gateway requires the same setup as the Authorize.Net (1) gateway.
eProcessing (gwEprocessing)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Fast Transact (gwFastTransact)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id
test_mode is not supported and when set to "True" an exception will be thrown by the component.
First Data PayPoint (gwFirstDataPayPoint)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, tax_id
test_mode is not supported and when set to "True" an exception will be thrown by the component.
GoEMerchant (gwGoEMerchant)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
OmniFund / GoToBilling (gwOmniFund)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
Additional check-relevant properties supported are: check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
The Customer's Name or the CompanyName must be set. If not, an error will occur.
Heartland (gwHeartland)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
test_mode is not supported and when set to "True" an exception will be thrown by the component.
This gateway requires you set the following configuration settings with the values supplied by Heartland: "HeartlandLicenseId", "HeartlandSiteId", and "HeartlandDeviceId". In addition, you may optionally set the "HeartlandSiteTrace", "HeartlandDeveloperId", and "HeartlandVersionNumber" configuration settings for this gateway.
Our implementation supports Heartland's Tokenization implementation via the "HeartlandTokenMapping" and "HeartlandTokenValue" configuration settings (it is not required that you use tokenization). Note: Heartland's Tokenization implementation requires that your merchant account is properly configured to support tokenization. In addition to the account configurations, there are special pricing considerations for merchants in the production environment. Therefore merchants who wish to use tokenization should contact their Relationship Manager for more details and to configure their account appropriately.
Heartland Portico (gwHeartlandPortico)
Supported Methods:
merchant_login and merchant_password are required properties.
This gateway requires you set the following configuration settings with the values supplied by Heartland: "HeartlandLicenseId", "HeartlandSiteId", and "HeartlandDeviceId". In addition, you may optionally set the "HeartlandSiteTrace", "HeartlandDeveloperId", and "HeartlandVersionNumber" configuration settings for this gateway.
Alternatively, if Heartland has provided you with a secret API key you can specify only the "HeartlandSecretAPIKey" configuration setting.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
HSBC (gwHSBC)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are: check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
The user's "Name" maps to merchant_login, and "password" maps to merchant_password.
Note: The test_mode property can be overridden by using the
add_special_field method to add the "Mode" field.
ICharge1.AddSpecialField("Mode", "Y");
ITransact (gwITransact)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
JetPay XML (gwJetPay)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
merchant_login must be set to the "TerminalId" JetPay field.
invoice_number is required for all transactions.
auth_code is required when performing void_transaction transactions.
LinkPoint (gwLinkPoint)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Your merchant_login will be the "Store Number" provided by Linkpoint. This gateway requires a client certificate, which can be set using the
SSL Certificate properties. Void transactions with this gateway require a transaction timestamp. This timestamp can be retrieved from the original
auth_only response through the get_response_var; method.
Example:
icharge.AuthOnly();
String tdate = icharge.GetResponseVar("/root/r_tdate");
This value can be set for the void_transaction with the add_special_field method. Example:
icharge.AddSpecialField("tdate","YourDate");
icharge.VoidTransaction("TransactionId");
Litle (gwLitle)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
This gateway uses the transaction_desc property to place transactions in different categories. If transaction_desc is left blank the transaction will fail.
This gateway also requires you set the "MerchantCode" configuration setting with the Merchant Id supplied to you by Litle.
Merchant Anywhere (gwMerchantAnywhere)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Use the "RegKey" provided by MerchantAnywhere as your merchant_password.
Merchant Partners (gwMerchantPartners)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
MPCS (gwMPCS)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
This gateway requires the same setup as the Authorize.Net (1) gateway.
Netbanx (gwNetbanx)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
In addition to your merchant login and password, the Netbanx Gateway also requires an additional "accountNum" field, which must be added using "NetbanxAccountNumber" config.
BankName and CheckNumber are both required for all transactions.
NetBilling (gwNetBilling)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Network Merchants (gwNetworkMerchants)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
NexCommerce (gwNexCommerce)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Orbital (gwOrbital)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
To configure this gateway please note that your merchant/group Id is your merchant_login, and your Bank Id (BIN) will be your merchant_password. The Terminal Id is defaulted to "001" (but can be changed via in config).
Pay Direct (gwPayDirect)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
This gateway requires PayDirectSettleMerchantCode to be set as it is used in authorization.
In addition to transaction_amount the amount details are required to be set using PayDirectConvenienceFee and PayDirectMerchantAmount. If these fields are not set, the component will internally set the fields. Please see the config definitions for further details.
Pay Flow Link (gwPayFlowLink)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
PayFlow Pro (gwPayFlowPro)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_dob, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
The default "Partner" special field is set to "PayPal". You may be required to change it depending on your account setup. If your User Id and Vendor Id (Merchant Login Id) are different, supply the Vendor Id to merchant_login and add the User Id like so: AddSpecialField("USER","User Id Value").
PayFuse (gwPayFuse)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are: check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
The user's "Name" maps to merchant_login, and "password" maps to merchant_password.
Note: The test_mode property can be overridden by using the
add_special_field method to add the "Mode" field.
ICharge1.AddSpecialField("Mode", "Y");
Forte (gwForte)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Payscape (gwPayscape)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
PayTrace (gwPayTrace)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are:
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
PhoeniXGate (gwPhoeniXGate)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Other fields can also be set by calling add_special_field.
For Government Checks, set "PhoeniXGateGovernmentCheck" configuration setting to True.
This Gateway does not have a test URL. Transactions will be processed using the production server.
To process Recurring Billing Checks, "PhoeniXGateProcessRecurringCheck" configuration setting must be set to True. Also "PhoeniXGateCheckInfoKey" must be set to the Check Info Key obtained from RecurringBilling class at the time the payment record was created, and "MerchantCode" configuration setting must be set to the Merchant ID, which is also known as Merchant Number or RPNum.
Planet Payment (gwPlanetPayment)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
This gateway requires you to set the "TerminalId" configuration setting. merchant_login maps to the company KEY, and merchant_password maps to the PIN.
PlugNPay (gwPlugNPay)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
PRIGate (gwPRIGate)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Use the "RegKey" provided by PRIGate as your merchant_password.
QuickBooks Merchant Services (gwQBMS)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
For the QBMS gateway, your Application Name is used for the merchant_login, and the Connection Ticket for the merchant_password. (Using the Application Id in the merchant_login property will cause an error).
transaction_id is required for all transactions.
QuickBooks Payments (gwQBPayments)
Supported Methods:
merchant_login is a required property, and should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.
The transaction_amount should be represented as dollars and cents with a decimal point. For example, "1.00".
| QB Payments Field Name | ECheck Equivalent |
| Request-Id | transaction_id property. |
| amount | transaction_amount property. |
| description | transaction_desc property. |
| checkNumber | check_number property. |
| context.deviceinfo fields | SpecialField properties. |
| bankAccount.name | BankAccountHolderName property. |
| bankAccount.accountNumber | BankAccountNumber property. |
| bankAccount.phone | CustomerPhone property. |
| bankAccount.accountType | BankAccountClass and BankAccountType properties. |
| bankAccount.routingNumber | BankRoutingNumber property. |
| bankAccount.country | CustomerCountry property. |
| token | AccountToken configuration setting. |
test_mode is not supported and when set to "True" an exception will be thrown by the component.
transaction_id is required for all transactions.
Repay Gateway (gwRepay)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Other fields can also be set by calling add_special_field.
For Government Checks, set "RepayGovernmentCheck" configuration setting to True.
This Gateway does not have a test URL. Transactions will be processed using the production server.
To process Recurring Billing Checks, "RepayProcessRecurringCheck" configuration setting must be set to True. Also "RepayCheckInfoKey" must be set to the Check Info Key obtained from RecurringBilling class at the time the payment record was created, and "MerchantCode" configuration setting must be set to the Merchant ID, which is also known as Merchant Number or RPNum.
RTWare (gwRTWare)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
This gateway requires the same setup as the Authorize.Net (1) gateway.
Sage Payments (gwSagePayments)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Sterling XML (gwSterling)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
merchant_login must be set to the "SECURENETID" field of the Sterling XML gateway.
Additionally, transaction_id is required for all transactions.
Transaction Central (gwTransactionCentral)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Use the "RegKey" provided by Transaction Central as your merchant_password.
TransFirst (gwTransFirst)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, license_dob, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
TransNational Bankcard (gwTransNationalBankcard)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Trust Commerce (gwTrustCommerce)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount is required to be represented as cents without a decimal point. For example, a dollar value of "1.00" would equate to "100" for this gateway.
Additional check-relevant properties supported are:
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
USAePay (gwUSAePay)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Verifi (gwVerifi)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount can represented as either cents without a decimal point or dollars and cents with a decimal point. For example, a value of "100" would equate to "$1.00" while a value of "100.00" would equate to "$100.00" for this gateway.
Additional check-relevant properties supported are:
test_mode is not supported and when set to "True" an exception will be thrown by the component.
WorldPay US Link (gwWorldPayLink)
Supported Methods:
merchant_login and merchant_password are required properties.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, tax_id, check_number
test_mode is not supported and when set to "True" an exception will be thrown by the component.
Your Pay (gwYourPay)
Supported Methods:
merchant_login is a required property. merchant_password is not applicable.
The TransactionAmount should be represented as dollars and cents with a decimal point. For example, "1.00".
Additional check-relevant properties supported are: license_number, license_state, tax_id, check_number
test_mode is supported and when set to "True" test transactions can be sent using a live account that will not be captured and settled.
Your merchant_login will be the "Store Number" provided by Linkpoint. This gateway requires a client certificate, which can be set using the
SSL Certificate properties. Void transactions with this gateway require a transaction timestamp. This timestamp can be retrieved from the original
auth_only response through the get_response_var; method.
Example:
icharge.AuthOnly();
String tdate = icharge.GetResponseVar("/root/r_tdate");
This value can be set for the void_transaction with the add_special_field method. Example:
icharge.AddSpecialField("tdate","YourDate");
icharge.VoidTransaction("TransactionId");