As of Release 4.4, Engaging Networks supports Vantiv version XML 12. With this upgrade, earlier test gateway credentials will no longer work. *Please let your Vantiv relationship manager or client success rep know you need a Pre-Live account setup for VAP XML Version 12. No additional action is needed on the live gateway.
Overview
In order to integrate with the Vantiv gateway, you will need to have a Vantiv merchant account set up through them. Then you will need to obtain your API credentials (username and password) in order to link Engaging Networks donation pages to your Vantiv Payments account. Once you’ve obtained your API credentials, please contact an Engaging Networks team member in order to have the gateway added into your account.
| Field | Description |
| Reference name |
A unique name for the gateway. It is a good idea for the name to include the type of gateway (eg. Vantiv), and whether it is a live or test gateway. |
| Select gateway |
Select ‘Vantiv’. |
| Username |
This is our API username. You will need to obtain this from Engaging Networks support. |
| Password |
This is our API password. You will need to obtain this from Engaging Networks support. |
| Merchant ID |
Vantiv uses a Merchant ID (MID) in order to correctly process the payments. |
| Test mode |
Should be checked for a test gateway, must be unchecked for a gateway that will accept live donations. |
Required form fields
The following fields need to be set up in the default supporter record and then added to the form in ‘build’.
Basic required fields:
| Form Field | Value type |
Comments |
| Email Address | Alphanumeric |
Email address identifying the supporter record |
| First Name | Alpha |
Supporter’s first name. 25 character limit |
| Last Name | Alpha |
Supporter’s last name. 25 character limit |
| Address 1 | Alphanumeric |
Supporter’s street address. 35 character limit |
| City | Alpha |
Supporter’s City. 35 character limit. |
| Region | Alpha |
2-letter ISO code is required for US. All other countries can use an 2 letter value of your choice. Example: NA |
| Postal code | Alphanumeric |
Supporter’s Postal or ZIP Code |
| Payment Type | Alpha |
For payment methods, one of the following values should be passed in (case sensitive): Visa = VI |
| Donation Amount | Numeric |
Must be entered as a whole number or number with two decimals only. Eg. 50 dollars needs to be entered as ’50’ or ‘50.00’. You can apply a form field validator to check for numbers only in the field. |
Additional fields required for card payments
Not required for “pay via paypal”.
| Form Field | Value type | Description |
| Credit Card Number | Integer |
Credit card number w/o spaces |
| Credit Card Expiration | Date |
Format must be MMYY. e.g. 0515. It is strongly recommended that you use the ‘split select’ field type for this form field. |
|
Credit Card Verification value (CVV2 or CVC2) |
Numeric | The additional Card Verification Value printed on the card, used for fraud checks. |
Credit card number and credit card verification values are not stored in the default supporter record.
Additional Fields for ACH (e-Check) Payments
| Form Field | Value |
Description |
| Bank Account Type | Alpha |
Checking or Savings |
| Bank Routing Transit Number | Numeric |
The bank routing number |
| Bank Account Number | Numeric |
The bank account number |
As of Release 4.4, an optional e-check validation service is available to leverage. *Please reach out to Vantiv to request that e-check Verification be enabled for your merchant processing account, and then let Engaging Networks know so we can complete the setup.
You’ll also need to include the PHONE NUMBER field for this service to work.
Additional Fields for Recurring Payments
Please be sure to enable tokenization through Vantiv for recurring processing.
| Form Field | Value |
Description |
| Recurring Payment | Alpha |
Submitting ‘Y’ will flag the transaction as a recurring payment. Any other value will result in a single payment. |
| Recurring Frequency | Alpha |
Permitted values are MONTHLY, QUARTERLY, SEMI_ANNUAL and ANNUAL. Please see the notes below on ‘select’ field types for details of ways of presenting these fields to supporters. |
| Recurring Day | Numeric |
The day of the month on which the recurring payment should be taken. This can be defaulted to the day the initial donation was made. |
Testing Vantiv payments donation pages
It is always recommended that you test your new forms using a ‘Test Gateway’. This ensures that the proper values are being submitted to the gateway and that the page is processing correctly. Once tested, you can make the page live, switch to the live gateway, and test an actual donation using a real credit card.
As of the update from Vantiv 9 – Vantiv 12, We are no longer able to provide a Vantiv/Worldpay test gateway. *Please let your Vantiv relationship manager or client success rep know you need a Pre-Live account setup for VAP XML Version 12.
This is their support article on doing that: http://support.worldpay.com/support/CNP-API/content/preliveenv.htm
**Vantiv doesn’t turn on tokenization by default on test accounts, if this is something you need for testing, you will need to ask for tokenization to be enabled.
Do not use test credit card information on a live gateway and do not use real credit card information on a test gateway.
The following credit card information can be used to test the Vantiv gateway.
Payment Type = Visa Card Number = 4100200300011001 Card Expiration = Any future date CVV Code = 463
The following bank information can be used to test the Vantiv gateway.
Payment Type = ACH Bank Account Type = Checking Routing Number = 011075150 Bank Account Number = 1099999999