Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Summary

EngageIP integrates with a significant number of processing vendors. This article contains information on integrating the various gateways, testing, trouble shooting and common issues encountered

...

  • 3DSI EC-Linx

  • ACH Payments

  • Adyen

  • Authorize.Net

  • Bank Of America

  • Barclay

  • BeanStream

  • BluePay

  • BrainTree DirectPost (Server-to-Server)

  • Chase Merchant Services

  • Concord EFSNET (no longer Supported as of EngageIP 8.5.25.0)

  • CyberCash

  • CyberSource

  • DPI Link (no longer Supported as of EngageIP 8.5.25.0)

  • ECHOnline (no longer Supported as of EngageIP 8.5.25.0)

  • ECX QuickCommerce

  • eProcessing

  • eWay

  • Fast Transact

  • FirstData / Cardservice Int.

  • goEmerchant

  • GoRealTime (Full-pass) (no longer Supported as of EngageIP 8.5.25.0)

  • Heartland POS

  • HSBC XML

  • Innovative Gateway

  • Intellipay ExpertLink

  • Intuit QuickBooks Merchant Services (QBMS)

  • Iongate (no longer Supported as of EngageIP 8.5.25.0)

  • iTransact RediCharge HTML

  • JetPay

  • Landmark

  • LinkPoint

  • Litle Online

  • Merchant Anywhere

  • Merchant E-Solutions

  • Merchant Partners

  • Moneris

  • MPCS Weblink

  • NetBilling

  • Network Merchants\

  • NexCommerce

  • NOVA's My Virtual Merchant

  • NOVA's Viaklix (no longer Supported as of EngageIP 8.5.25.0)

  • OGONE

  • Optimal Payments (no longer Supported as of EngageIP 8.5.25.0)

  • PayFlow Link

  • PayFlow Pro

  • PayFuse - First National MS

  • Paygea (no longer Supported as of EngageIP 8.5.25.0)

  • PayJunction Trinity

  • PayLeap Web Services API

  • Paymentech - Orbital

  • Payment Express

  • Payments Gateway

  • PayPoint

  • Payready Link (no longer Supported as of EngageIP 8.5.25.0)

  • PayStream (no longer Supported as of EngageIP 8.5.25.0)

  • PayTrace

  • Planet Payment

  • Plug 'n Pay

  • PSIGate

  • RTWare WebLink

  • SagePay Direct

  • SECPay

  • SecurePay

  • SkipJack

  • Sterling

  • Sterling XML

  • SurePay / YourPay

  • TransFirst eLink

  • TransFirst Transaction Central Classic

  • TrustCommerce

  • USA ePay

  • uSight

  • Verifi

  • Verisign PayFlow Pro

  • WorldPay Select Junior Invisible

  • WorldPay XML

  • YourPay

  • and more ...

...

According to nSoftware, these gateways should work in the UK or overseas however you would need to check with each gateway to confirm they work in your region:

  • Any of the Authorize.NET gateways (1), (85), (96)

  • Ogone DirectLink (29)

  • SagePay Direct (Previously Protx) (55)

  • WorldPay Select Junior Invisible (43)

...

Now you are ready to process transactions. Not all gateways process ACH or eCheck 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.

Canadian ECheck Companies (CAD and ECheck capabilities)

Info

Note: make sure to call and confirm that these will work for you before proceeding

From the list below:

  • ACH Payments

  • Trustcommerce via Global Payments

  • Cybersource via Firstdata

...

  • For a credit card to run as part of an automated bill run, it must be set as the default payment method (bolded under payment methods on Tools tab page of an account)

  • Credit cards will be processed if the 'Credit Card' check box and the 'Enabled' check box are selected on Bill Run configuration page

  • Credit card Tokens or E Check Tokens will be processed if 'Run E Check Token' or 'Run Credit Card Token' are selected on the Bill Run configuration page

  • Expired credit cards are not attempted. EngageIP will review existing cards and if expired, will not attempt to charge them during the bill run
    In EngageIP 8.5.14.0 the option 'Process Expired Credit Card' was added. When this option is checked expired credit card information will be sent to the processor gateway allowing the gateway to auto-renew, send expiry notifications or take some other action (depending on the capabilities and configuration of the gateway)

  • Cancelled accounts will NOT be attempted during a credit card bill run. Note that cancelled relates to the back end account status type, see the Account Status Types link on the Setup tab page for the status types that you have defined in the EngageIP AdminPortal

  • No information is stored in EngageIP for one-off payments (Tools tab -> page / One-off Credit Card Payment). This means any one-off payment refunds must be handled manually (logging into your CC gateway vs. using the 'Credit Card / Credit Card Token Refund' functionality on the Tools tab) and then once refunded the payment must also be reversed in EngageIP.  For instructions on reversing payments see the Managing Transactions article

...

  1. Go to the proper owner account

  2. Click Setup tab

  3. Click Card Processors

  4. Click Add

  5. Enter the Name

  6. Select the Card Gateway

  7. Enter the Merchant Login and Merchant Password

  8. Enter any other configuration specific to your processor (if Tier sync or multiple branded owners is in use, select any existing configuration options that are in place for the same card processor on the other owner)

  9. Enable the option Process Expired Credit Card if you want payments to be processed for cards that have expired (most payment gateways should process payments for expired cards). Typically this option should be enabled

  10. Click Save

  11. Click Setup tab

  12. Click Card Types

  13. Assign any card types you'll be using to that processor. i.e. Visa, MasterCard, etc. (again, where other configs exist, you can copy similar naming and config here)

...

First the Credit Card Token Processor must be setup, to do so follow the steps below:

  1. Access the owner account

  2. Click the Click Setup tab

  3. Click Credit Card Token Processors

  4. Click Add

  5. Populate the fields presented (required fields are in red)

    • Name - this is simply an identifier can be any value you wish to describe the Card Processor

    • Credit Card Token Gateway - select the appropriate supported gateway from the list

    • Merchant Login - enter your merchant account username, login or ID information supplied by your Gateway

    • Merchant Password - enter you merchant account password supplied by your Gateway

    • Test Mode - if selected, will allow you to run test Bill Run processing simulations on your accounts before going live. All Credit Cards whether real or fake will receive a successful response when using this check box. This should be used if you simply want to confirm that billing is attempting to process cards and should NOT be used in a production system scenario

    • Gateway URL - allows you to override the Gateway URL. This can also be used to post to a test gateway

    • Attribute - allows you to specify additional attributes specific to the gateway.

    • Configuration - allows you to enter uncommon configuration settings for the gateway, see the SSL Certificate Field Definitions section below for more information

    • Threshold Amount - enter a threshold value that will prevent credit card charges if the payment amount is less than the threshold value

    • Process Expired Credit Card Tokens - enable this option if you want the payment gateway to charge cards that have expired, typically this should be enabled

  6. Click Save to save the Card Token Processor, or Save/New to save to processor and create another

...

The Credit Card Token Processor must be associated with a Payment Type. To setup the Payment Type follow the steps below:

  1. Click the Click Setup tab

  2. Click Payment Types

  3. Click the Add button

  4. Fill out the Fields shown in the image as indicated in the list below:

    • Name - this is simply an identifier can be any value you wish (e.g. Credit Card Token)

    • Payment Type - enter Credit Card Token

    • Disbursement Type - select the Disbursement Type to use when a payment is made using this type (for example Automatic)

    • General Ledger - select the General Ledger (optional) to associate with the payment type

    • Payment Code - select the Payment Code (optional) to associate with the payment type (for instance 'Online Payment')

    • E Check Processor - used with E Check Payment Types (leave empty)

    • E Check Token Processor - used with E Check Token Payment Types (leave empty)

    • Credit Card Token Processor - select the correct Credit Card Token Processor

    • Default Detail Message - message that can be used if the payment details field is left empty by the user on the Add Payment page

  5. Click Save

  6. Process a Credit Card to test if the configuration is in order (see the Processing Credit Cards section below)

...

  1. Add a token card processor

  2. Add a regular card processor by clicking 'Card Processors' link.

    1. Name it 'Token Processor'

    2. Select any gateway - as this is not used during token processing

    3. Click Save

  3. Add a card type by clicking 'Card Types'

    1. Click Add

    2. Enter Visa, or MasterCard, etc. as needed. If using a regular processor AND a token processor, you could name them 'Token Visa' or 'Token Mastercard'

    3. Select your 'Token Processor' option as was done in step #2

  4. Add a 'Payment Type' and associate it to the token card processor added in step #1

  5. Go to an account and add the payment method to the account by doing the following.

    1. Click Tools

    2. Click Payment Method

    3. Click Add

    4. Select the payment type name that is associated to the token processor

    5. Enter the information required and select the card type associated to your token processor

    6. Click Save

...

The ECheck Token Processor configuration can be added by going to the Setup tab >  ECheck Token Processors page.

The ECheck Token Processor setup is identical to the Credit Card Token Processor Setup (detailed above).

When Configuring the Payment Type the following Details should be used:

...

Any processing errors will appear in the Event Log under the Reports tab. Refer to the Troubleshooting section at the bottom of this article for assistance troubleshooting if errors are found in the log.

...

This gateway requires special configuration due to the extra security measures implemented in the 3.1 (AIM) protocol. You will need to add your Transaction Key ("x_Tran_Key") value with the AddSpecialField method. You must also add the secret hash value with the Config method. Both of these values are provided by the Authorize.Net merchant web interface, which is used to set up your account.

...

You can now set a TEST GatewayUrl, a special field and a Config setting. Please note that all these are required for http://authorizePayment processing: Accept payments anywhere | Authorize.net AIM 3.1 to work properly

You must have your portal HASH in the Config Field.

...

Configure a processor under 'Card Processor' on the setup tab page according to the example in the image.

Production URL: https https://orbital1.chasepaymentech.com/authorize

Testing URL: https https://orbitalvar1.chasepaymentech.com/authorize

Configuration

  • Merchant Login: 6 number value, called MID that Orbital provides

  • Merchant Password: Normally 000001 known as a BIN number (BIN 000001 is for Stratus and BIN 000002 is for Tandem)

  • Gateway: Prod or test URL as required above

  • Attribute: not required

  • Configuration: (replace xxx, below is wrapped using space so remove spaces to use one single line for this) :  OrbitalConnectionUsername=PBxxxx; OrbitalConnectionPassword=Pxxxxxx; TerminalId=002; SSLEnabledProtocols=3072; OrbitalCustomerProfileFromOrderInd=A; AllowPartialAuths=False

...

AuthorizeNet eCheck Configuration

  1. On the Setup tab select click ECheck Processors

  2. Add a new processor by clicking the Add button

  3. Enter the required information

    • Name

    • Select the AuthorizeNet gateway

    • Enter your username and password

    • You may or may NOT need an X Trans key, If you do, it needs to be the same as the password you entered above in the configuration. Merchant password = X Trans Key

  4. Go back to the Setup tab

  5. Under the Accounting heading click Payment Types. The following are available options for payment type. Step 6 and 7 need to be completed for each added: Savings, Checking, BusinessChecking

  6. Click on the 'Check' payment type

  7. Select the E Check Processor that you've just added from the dropdown

  8. Click the Save button

  9. Click on the same payment type and confirm that the status types that you wish to be able to process for are selected under the Allow Payment To Only These Status Types heading

  10. Test the ECheck processor as needed.

...

x_email_customer,True  (the first x)email_customer is the option that AuthorizeNet recognizes, and the 'True' item is the value assigned to the option that they recognize. So the format is option,value.

  • Follow the steps at the bottom here to enabled AVS so that the information is sent up to the processor

...

To setup a demo account with Payeezy reference this url: https://support.payeezy.com/hc/en-us/articles/203730579-Payeezy-Gateway-Demo-Accounts

  1. On the Setup tab and load Card Processors

    1. Enter a Name for the Processor, e.g. First Data / Payeezy

    2. Under Card Gateway select FirstDataGlobalGatewayE4

    3. Under Merchant Login enter your Payeezy provided GatewayID

    4. Under Merchant Password enter your Payeezy provided Gateway password

    5. Under Gateway URL enter the URL supplied by Payeezy

    6. Under Configuration enter the Hash and DMSKeyId value provided by Payeezy (HashSecret=xxxxxxxxxxxx;FDMSKeyId=xxxxxx)

  2. Click Save

  3. Test processing a payment

...

  1. Load the Setup tab

  2. Click Card Processors

  3. Click Add

  4. Under the Card Gateway field type or select "IPPay"

  5. Set the Merchant Login to "TESTTERMINAL"

  6. Set the Merchant Password to any value (it's a required field in EngageIP but IPPAY doesn't use / require it, it will not be sent to them, effectively what you enter is a place holder)

  7. Set the Gateway URL to "https://test1.jetpay.com/jetpay/"

  8. If you need to disable TLS add SSLEnabledProtocols=3072 to the Configuration field

...

  • Update the Merchant Login (this should be the Merchant ID, likely 15 numbers long)

  • Set password as per above (anything entered will do as a password)

  • Enter specified / provided Gateway URL (Currently: https://gtwy.ippay.com/ippay).

The fields currently sent by EngageIP to IPPAY are as follows:

...

ACH Processing: For testing ACH, use MerchantLogin=TESTMERCHANT" and Gateway URL: "https://test1.jetpay.com/jetpay/"
and select E Check Gateway = IPPay.

Info

Note: Accepted account types are: CHECKING, SAVINGS, BUSINESSCK

SEC Sending:

  • CHECKING = PPD

  • SAVINGS = PPD

  • BUSINESSCK = PPD (if you want this to be sending CCD, setup a role profile question called 'ACH SEC code' per image below, data type of text, and set its value per account that needs it to ccd. This tells the system to send CCD instead of PPD when a business checking account is processed


    1. Add eCheck Processor
    2. Enter merchant login as above
    3. Enter password = merchant processor - password is not required or sent to gateway so bogus
    password should be entered
    4. Enter gateway URL as specified by IPPAY
    5. Ensure that you have configured your 'Payment Type' on setup to point the ACH/Echeck option to
    the IPPAY processor
    6. To test, add ACH info to an account, then go to tools and click make payment and save
    7. Review payment or payment decline reports for more info

...

The configuration for eSelectPlus is the same process as for regular processors, except for the addition of the Attribute and Configuration items that need to be entered. These should be found in the gateways interface page.

Warning

AlertDO NOT test this processor on a test / development system as processing refunds may cause money to be refunded to an incorrect card if this account (user and password) have been used on a live server before. This is due to a requirement specific to the eSelectPlus integration that requires EngageIP to send a unique ID to them to process refunds.

Moneris Test Configuration

...

Password: test

Gateway URL:  esqa.moneris.com

Attribute: store3

Configuration: yesguy

...

Password: yyyyyyyy

Gateway URL:  www3.moneris.com

Attribute: (Store Name)

Configuration: (API Key from Settings Menu)

...

Password: Vendor password which was created and used to login to PayPal Manager interface

TEST Gateway URL: https https://pilot-payflowpro.paypal.com

If you want to specify a different partner other than 'PayPal' which is the hardcoded partner, enter the below in the attribute field:

...

USER,MySecondaryUser;PARTNER,MyPartnerName

Test URL: https https://pilot-payflowpro.paypal.com

YourPay

  1. Select the gateway as YourPay

  2. Enter the merchant number and password (not your username)

  3. Convert your .PEM file as downloaded from the FirstData website to a .PFX file - Instructions here

  4. Enter the direct harddrive path to the .pfx files in SSL Cert Store.

  5. Enter the number 2 in the cert store type (references the use of .PFX file instead of the unix file type)

  6. Enter the SSL Cert Store Password = password

  7. Enter asterisk in the subject section (this is as specified by YourPay / LinkPoint)

  8. Click Save

  9. Attempt to process a credit card

  10. Review from the YourPay webbased interface and the payment process reports on the reports tab page in EngageIP

WorldPay Configuration

...

Worldpay Gateway Examplehttps://www.nsoftware.com/kb/xml/01191001.rst#worldpayxml  

...

SSL Certificate Field Definitions

...

This gateway requires the same setup as the LinkPoint gateway.

Info

Note: the EWay gateway does note support TransactionTypes like the other gateways do. Instead, eWay defines different GatewayURLs for each of the actions they support. The following table shows all of the supported actions for the eWay Gateway.

GatewayURL

Description

https://www.eway.com.au/gateway/xmlpayment.asp

Sale transactions without CardCVV2Data.

https://www.eway.com.au/gateway_cvn/xmlpayment.asp

Sale transactions with CardCVV2Data.

https://www.eway.com.au/gateway/xmlstored.asp

Authorization Only transactions without CardCVV2Data.

https://www.eway.com.au/gateway/xmltest/TestPage.asp

Test transactions without CardCVV2Data.

https://www.eway.com.au/gateway_cvn/xmltest/TestPage.asp

Test transactions with CardCVV2Data.

 

More Info IBiz E-Payment Integrator V3 .NET Edition. -For more info, please visit our website at http://www.nsoftware.com.

Configuring Your System to Email Receipts to Customers

Info

Note: receipts on card charges are an option in your processing gateway, NOT in EngageIP. An example of a gateway that supports this is AuthorizeNET.

  1. The email box on the bottom of the credit card add / edit screen needs to be completed as well as address as this will be what is sent to your cc processor

  2. On the Setup tab page configure your Card Types

    • Check Enable AVS - this prompts EngageIP to actually send the data to the processor

    • Click Save

  3. Enable  Enable / configure the option on the processors gateway website or merchant configuration page

  4. Test by charging a credit card for a small amount to confirm the email is being sent and if not, that the data, email and address is being sent up to the processor. You can see this detail on the transactions detail on your processors website.

Credit Card Expiry Email

Expiry emails can be configured on the Email Settings screen on the setup tab. It consists of selecting an email template (from the Email Message link on the setup) which you want to send customers when their credit card is close to expiring. 1 month prior to the expiry of a credit card, the system will email out the template you have configured on ‘Email Settings’ to the email address stamped on the billing contact of the associated account. This email will only be sent out once and is sent out via the Event Manager service as it checks its daily jobs.

Full detail and images are in this kbarticlehttps://kblogisense.logisense.com/?p=2699#Automatic_Expiry_Email_atlassian.net/wiki/spaces/CUKB/pages/1878884363/Credit+Card+Processing+-+Processing+Refunds+Testing+and+Expiry+Emails#Automatic-Expiry-Email-Notification

Troubleshooting

The below provides some common errors when attempting to process cards.  You can find errors in several places:

...

when processing a card, you may receive a message initially about needing to register iBiz software. If it is not already registered, this needs to be done by LogiSense Customer Support on your billing server. If you see the issue occur after that on desktops of CSRs, the ASP.Net user on the Webserver may need extra permissions so that IIS can read the registry and know that the iBiz software is already registered.

...

Credit Card return messages and errors will show in the EngageIP event log and are common among all processors compatible with the iBiz processor module. Some of the most common errors - Credit Card Response Errors:

159    Invalid form variable index (out of range).

501    Data field invalid length.

502    Data field invalid format.

503    Data field out of range.

504    Luhn digit check failed.

505    Card date invalid.

506    Card expired.

507    Card type unknown.

510    No gateway specified.

511    Invalid data entered.

512    Truncated response.

513    Invalid response.

514    A Special Field is required for this transaction type.

542    Error computing MD5 hash for Authorize.Net

 

SSL Response Errors:

270    Cannot load specified security library.

271    Cannot open certificate store.

272    Cannot find specified certificate.

273    Cannot acquire security credentials.

274    Cannot find certificate chain.

275    Cannot verify certificate chain.

276    Error during handshake.

280    Error verifying certificate.

281    Could not find client certificate.

282    Could not find server certificate.

283    Error encrypting data.

284    Error decrypting data.

For further information, refer to the iBiz documentation on troubleshooting and errors or you can request assistance by emailing support@logisense.com.

...