This article will guide you on upgrading your existing Litle/Vantiv payment processing platform to the latest version. Please contact your WorldPay Support Representative to setup and get the approval to use this New WorldPay SDK for your existing merchant account.
Once approval is granted, your WorldPay Support Representative will give you a new Vantiv Username and Password to connect to your existing Merchant Account.
The next step will be to update your existing Litle ac_payment_gateway to set gtw_assembly="netForumProcessorVantiv" (replacing “netForumProcessorLitle”) and gtw_type_name="Avectra.netForum.Integration.Vantiv.VantivPaymentVaultProcessor" (replacing “Avectra.netForum.Integration.Litle.LitlePaymentVaultProcessor “).
After updating the Payment Gateway record, update the existing Litle merchant account to set the Username and Password to the new credentials supplied by Worldpay. You can also delete the “knownhostsFile” Merchant Account Setting since it is not required for the new WorldPay SDK.
Note: At this point any Stored Payment Information that previously used the old “netForumProcessorLitle” will now process transactions using the new “netForumProcessorVantiv”. The transaction requests are still sent to your existing Merchant Account but using the new WorldPay SDK.
Note: One of the main differences with this new Vantiv SDK is that any transactions referencing a previous transaction (e.g., Capture, Void, Credit) will 'always return APPROVED' even if it actually failed. You need to check the ‘Declined Transaction Report’ in the Vantiv portal on a daily basis and make any required adjustments in your iWeb application for failed transactions. Under normal circumstances, these Capture/Void/Credit transactions would not fail, unlike PreAuthorizations which can be declined for all the normal reasons. Vantiv made this change as part of their introduction of support for “Multi-Site Processing”. Contact your WorldPay support representative for more details.
Adding a New Merchant Account
To add Merchant Account information in the Merchant Account child form, complete the following steps.
- Go to Accounting module> Overview > Accounting Setup.
- On the Accounting Setup page, go to Payment Gateways child form and click the Go To icon on the newly added ‘Vantiv’ payment gateway line item.
- From the Payment Gateway Profile page, click the Add button on the left of the Merchant Accounts.
The Add Merchant Account form will display.
- Add a desired name to the merchant account in the merchant account name field. Select the check boxes as appropriate, then click Save button.
- Clicking the merchant account is frozen? check box will freeze the merchant account. Freezing a merchant account means the merchant account is no longer available to process new transactions but is still able to process existing transactions that use this merchant account.
- Click the supports processing of level 2 transaction data? check box to enable processing of level 2 transaction data. If this check box is checked, the supports processing of level 3 transaction data check box appears.
- Click the supports processing of level 3 transaction data? check box to enable processing of level 3 transaction data. Level 3 transaction data processing can only be enabled if level 2 processing is also enabled.
To add Vantiv as a Payment Method in your Business Unit, complete the following steps:
- On the Business Unit Profile page, click the Payment method tab.
- On the Payment methods child form, click the Add button. The Add Payment Method form will display.
- Enter the name of the Payment Method. This is what will appear in the drop-down when users select a payment method.
- Select ACH from the Payment Type drop-down list (these list items are hard coded).
- Select a business unit from the Business Unit drop-down list and Cash Account as appropriate.
- Select the Available Internally, Available Externally, and/or Available On Centralized Shopping Cart check boxes as appropriate (optional).
- Selected from the Gateway / Merchant Account drop-down list.
- Enter a Batch Suffix (optional).
- Click Save.
- Repeat the steps to add information for Credit Card payment method.
Adding the Vantiv Merchant Account Settings
Modules>Accounting> Overview> Accounting Setup> Payment Gateways>Payment Gateway Profile>Merchant Account Profile>Merchant Account Settings Profile
Merchant Account Settings for netForumProcessorVantiv
These Merchant Account Settings are essentially the same as the netForumProcessorLitle except for:
- Logfile name (Give an appropriate name, example: Vantiv.log). This setting is only relevant if you have logging turned on by setting the “printxml” setting to “true”.
- Username and Password. These are associated with the version of SDK they are allowed to use. You will need to contact your WorldPay support representative to obtain a new Username and Password that will work with the new WorldPay SDK.
- The latest version of Vantiv does not need the KnownhostsFile setting since the new SDK uses the sftpUsername/sftpPassword to connect.
- Version (changes from 8.25 to 12.30).
To enter merchant account settings for Vantiv payment gateway, complete the following steps:
Note: These steps must be completed for each merchant account associated to the Vantiv payment gateway.
- Go to the Merchant Account Profile for the Vantiv payment gateway.
- Complete the steps outlined in the Adding Merchant Account Settings article. You must repeat these steps for each code that is to be entered for Vantiv.
- Enter each code listed below. You must add every code listed below for the Vantiv payment gateway to function properly. A short description of the code and an example value for each code are provided below:
The following merchant account settings must be used for Gateways configured to use netForumProcessorVantiv.
| Code | Description | Example Value |
| url | The URL that corresponds to the environment for Vantiv: Test, Pre-live or Live. Check with your implementation specialist for actual URLs. | https://payments.vantivprelive.com/vap/communicator/online |
| version | The version of the SDK you are using. | 12.30 |
| merchantId | The merchant id given to you by Vantiv. | 12345678 |
| username | The username given to you by Vantiv. | NFECB12 |
| password | The password given to you by Vantiv. | P@ssWord!123 |
| maxAuthAgeInDays |
This is an optional merchant account setting to override the Vantiv authorization expiry and will helps you to add a maximum age limit (in number of days) for a previously obtained auth to remain valid. Following values can be set for this setting: 0 = expired immediately n = number of days before auth is considered expired if this setting is missing, the system will treat it as “1” |
1 |
| proxyHost | If a proxy is required, this setting indicates the host to make calls to the Vantiv service in the SDK. If a proxy is not required, leave these settings blank. | |
| proxyPort | If a proxy is required, this setting indicates the port to make calls to the Vantiv service in the SDK. If a proxy is not required, leave these settings blank. | |
| printxml |
This setting determines if logging should be enabled or not. If the value is true, Vantiv SDK will write to the file found in the logFile setting. Values: true|false. |
true |
| reportGroup | The reporting group name used for the Vantiv back-end reporting features. | Default Report Group |
| sftpUsername | The username used to connect to the Vantiv secure FTP site. | NFEFTPUser |
| sftpPassword | The password used to connect to the Vantiv secure FTP site. | P@ssword!123 |
| sftpUrl | The secure FTP URL to send and receive files from Vantiv. This URL varies based on environment. Check with your implementation specialist for the actual URLs. | batch.vantivprelive.com |
| responseDirectory | This is the directory the SDK uses to store response files downloaded from the Vantiv secure FTP site. | Outbound |
| requestDirectory | This is the directory the SDK uses to build request files to send to the Vantiv secure FTP site. | Inbound |
| timeout | Note: Timeout setting is required only when the System Option BatchPaymentsForProcessingInRecurringProcesses = true. | 65 |
| logFile |
The file logs all requests and responses to the Vantiv web service made through the SDK. The logging is only active if “printxml” is set to “true” Note: If you want to add a logFile, then contact NetForum for guidance. You must ensure that the path for the log file is within the site folder of the application. Or you must ensure that the service account running the NetForum application pool is part of the Administration group on the server. |
C:\vantivlog.log |
| neuterAccountNums |
A setting that masks sensitive information like account and credit card numbers in the requests and responses during logging. True: mask account information in the log file False: show account information in plain text in the log file |
true |
| verificationEnabled |
Enter the code verificationEnabled with the value true to enable the eCheckVerification feature. Note: If this option is present and set true, then when saving ACH info to the vault, the system first sends it to Vantiv for validation. If for example, the Name on Check only contains a single word (e.g., “John”), the save will fail with the error “First Name and Last Name required for eCheck Verifications”. If this setting is false or just missing completely, the system will not do this validation check and you will be allowed to save the ACH info without a first/last name. (The verification validates other data, not just the name.) |
true |
Batched Payment Processing
This functionality works same as it does for the netForumProcessorLitle.
When the system option BatchPaymentsForProcessingInRecurringProcesses is set true, when running the Installment Payments or Recurring Gifts scheduled tasks, any payments using netForumProcessorVantiv or netForumProcessorLitle will be processed as batches.
NetForum system gathers all the requests into a single file and sends to Vantive sFTP site then receives a single file back containing all the responses. These files are found on the server in the folders specified by the Merchant Account Settings "requestDirectory" and "responseDirectory".
NetForum system then processes through the response file creating the payment records (ac_payment, ac_payment_detail, ac_payment_info), updating the invoices, etc.
For more information, refer the following related articles: