Set up and configure a Verifi Global payment gateway instance
Set up and configure a Verifi Global payment gateway instance by using the information in this article, including prerequisites, configuration procedure, descriptions of the configuration fields, and reference for testing the payment gateway.
Prerequisites
Enable the Verifi Global payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.
Procedure
Perform the following steps to set up and configure a Verifi Global payment gateway instance in Zuora:
- Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway.
- On the Configure Gateway Instance tab, select Verifi from the Gateway Type drop-down list.
- Click Create Gateway.
- On the gateway settings page, specify values for the configuration fields. See below for more information on the fields. Note that all the configuration fields do not support the vertical line character "|". For password fields, if your gateway assigns a password containing this character, Zuora will display a validation error. To resolve this issue, contact your gateway provider to request a new password without the unsupported character.
- Click Save Gateway Information.
Configuration fields
Common configuration fields
There are some common fields you must complete for every gateway configuration. We recommend reviewing our Setup Payment Gateway documentation for information on these common fields:
- Name
- Use Gateway Test Environment
- Cards Accepted
- Default Authorization Amount
- Verify new payment method (optional)
- Verify updated payment method (optional)
Default Authorization Amount
The Verifi gateway accepts only a $0.00 authorization amount, which Verifi will use to perform card validation. For $0.00 authorizations the Verifi validate()
is used to process a non-financial transaction against the credit card. This type of authorization will still return a response for both Address Verification Service (AVS) and Card Verification Value (CVV) Code. Verifi's API documentation states "some processing networks may return an invalid authorization code and this value should be ignored."
Since Zuora's payment gateway configuration allows you to define any authorization amount you want, we will use the Verifi auth()
if you configure the default authorization amount to be greater than $0.00. The auth()
does process a financial transaction against the credit card, but this transaction is immediately reversed using the void().
Credentials
In addition to the common fields, every gateway has unique requirements and information (such as credentials) that you must provide to configure the gateway in Zuora. For Verifi, you must enter a username, password, and product.
User Name
This is the username assigned to you (the merchant) by Verifi. It is a numeric 50 digit value that identifies you in the Verifi gateway.
Password
This is the password for the username.
Product
Zuora will default the product to "Subscription" but this field can be modified. The text in this field is passed into Verifi's Merchant Defined Field 3 (MDF3). See Overview of Verifi Global payment gateway for more information.
Test the configuration
For basic guidance on how to test payment gateway integrations within a sandbox environment, see Test payment gateway integration.
Accessing Your Gateway's Test Environment
Some payment gateways provide separate credentials for merchants to access their testing environment, some gateways use the same credentials for testing as for the production (live) environment but direct test transactions to a different URL, and other gateways do a little of both. Verifi provides credentials for their test environment in the Verifi API Documentation under the "Testing Information" section. See "Test Credit Cards and Testing Scenarios" below for more information on how to obtain this document.
Accessing the Gateway Test or Live Environment from Zuora
When configuring the Verifi payment gateway in Zuora, you can indicate whether you would like to use the Verifi test environment or the Verifi live environment.
- If Use Gateway Test Environment is selected, Zuora will direct payment transactions to your Verifi's test environment.
- If Use Gateway Test Environment is not selected (disabled), Zuora will direct payment transactions to the Verifi production environment.
Your credentials for the Test and Live Environments will be different. Obtain your Test credentials from the Verifi API Documentation (see "Testing Information").
Test Credit Cards and Testing Scenarios
Test credit card numbers and testing scenarios can be found in Verifi's API Documentation (see "Testing Information" on page 32). Zuora Global Support has a copy of this document which we can provide you, however, we recommend contacting your Verifi implementation manager, account manager, or the Verifi Support team for the latest version of this document. This guide provides specific credit card account numbers and data to include in your testing to generate specific gateway responses.
General Testing Information
Integration Testing
Zuora owns and manages the integration to Verifi on an ongoing basis, thoroughly testing the integration with every new release. The Verifi integration documentation is helpful if you are integrating Verifi directly with your website, however, you do not need to perform any integration or certification testing to submit transactions to Verifi via the Zuora application. The intended audience for the integration guides are technical integrators, however, these documents can be helpful to non-technical integrators who can refer to it for information on testing and troubleshooting gateway errors. Integration guides and all necessary documentation are provided to you by your Verifi implementation team.
Performance and Volume Testing
In general, gateway testing environments are intended to give merchants the opportunity to test their gateway and integrations to their gateway, in order to work out any bugs before going to the production environment. Some gateway test environments are shared amongst multiple merchants, and other gateways provide unique testing environments for each merchant. Additionally, gateway test environments (also referred to as certification or sandbox environments) do not have the same high availability or performance capability as production environments. As such, they are not intended for load testing. Merchants performing high volumes of load testing that puts a strain on a shared test environment may receive a warning from the gateway or have their access to the testing environment suspended
Troubleshoot Gateway Errors
There are several ways to obtain information about gateway errors:
- Look up the transaction by the transaction ID number (in the Zuora payment detail page, this is the Reference ID and Secondary Reference ID numbers) in your Verifi gateway virtual terminal to see if more information is provided; often you will see more than just the response (reasons) code and response message in Zuora.
- Review Verifi's API Documentation for transaction response codes and descriptions.
- For additional assistance or to obtain the Verifi API Documentation, you can contact the Verifi support team.
Make Sure You Are Not Re-Trying an Invalid Card Too Many Times
We recommend that you check the payment in Zuora to see how many times the same payment method has been re-tried for payment and failed. If there have been several retries, check the error messages from the beginning with the first failure and the more recent failures to determine if the error message is the same. If a merchant tries to process a payment against the same credit card too many times despite receiving errors, this could trigger warnings to the card issuing bank. The card issuing bank may place an alert on the account and not allow any further transactions from the merchant using that payment method. When a merchant has been flagged, the error received on the payment may not state the reason why, instead it might be a generic error decline error. In this case, the merchant (Zuora customer) should work with Verifi and/or your payment processor to see if they can identify the problem with the payment method. If the processor does not know, then the merchant and/or the cardholder can try calling their card issuing bank to look into the issue.
Duplicate Transaction Decline Error
If you receive an "Error Processing Transaction.300 Duplicate Transaction REFID: 326976199" it may be caused by a duplicate check by Verifi. The Verifi gateway checks for duplicates when orders are submitted within 20 minutes of each other and the same payment method, same dollar amount for the transaction, and same order ID are used for the transaction (see below for more information on order ID) are used for the transaction.