Procedure
Learn how to set up and configure a Worldpay 1.4 gateway instance, including selecting the gateway type, creating the gateway, and completing the necessary configuration fields.
Take the following steps to set up and configure a Worldpay 1.4 gateway instance:
- Click your username at the top right and navigate to Settings > Payments > Setup Payment Gateway .
- On the Configure Gateway Instance tab, select Worldpay 1.4 from the Gateway Type drop-down list.
- Click Create Gateway .
- Complete the configuration for the gateway instance. For more information about the configuration fields, see "Configuration fields" in the following section. 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 after entering the necessary information.
There are some common fields you must complete for every gateway configuration. We recommend reviewing Setting Up Payment Gateways for information on these fields:
-
Name : Choose a name that identifies this payment gateway. We recommend using a name that helps your users identify the gateway.
-
Use Gateway Test Environment : Select this check box if you want Billing to use the payment gateway's test service URL. This allows you to test payment transactions while you are setting up your Billing.
-
Cards Accepted : Worldpay accepts the following cards: Visa, MasterCard, American Express, Discover, Diner's and JCB.
-
Default Authorization Amount : Enter the minimum default amount used to process a payment. If the verify credit card checkboxes are selected, this amount will be used to validate the payment method by first authorizing the amount and then voiding the authorization when the amount is greater than zero..
-
Verify new payment method (optional): When you select either or both of the Verify new payment method and Verify updated payment method check boxes, Zuora Payments (within the Zuora Application and Zuora API) submits key information to the payment gateway to authorize all payment methods for authenticity and fraud prevention. For more information see Verifying the Credit Card Gateway Options .
-
Verify updated payment method (optional): See text above.
In addition to the common fields, every gateway has unique requirements and information (such as credentials and certain rules) that you must provide to configure the gateway in Zuora.
Your credentials should be obtained from Worldpay and configured in Zuora.
The Merchant Code is a unique value that identifies a merchant account in the Worldpay system. The code is submitted with every payment transaction sent from Zuora to Worldpay. Worldpay uses the same Merchant code for test and live transactions (but different XML passwords).
It is possible to have more than one merchant code under an administration code, which is a unique code that identifies a Worldpay merchant. The administration code is a reference under which all the merchant codes that a merchant has with the Worldpay payment service are stored, however it is not used in the API calls.
Merchant code switching is not supported. If you would like to process transactions for different types of customer interactions (e.g. e-commerce or moto) or to have multiple settlement currencies, then you need to create separate Worldpay gateway instances for each. Each gateway instance has its own unique Worldpay merchant code.
The password here is your XML password, used for making calls to the Worldpay API. It is not the password used for logging into the Merchant Interfaces.
For security reasons, the passwords for the live and test environments are different. Log in to the Worldpay Merchant Interface to find the XML password for the live environment, and log in to Worldpay Merchant Test Interface for the test environment.
The merchant ID is unique per each merchant code assigned to your merchant account by Worldpay.
This field is required if you want to enable 3D Secure 2.0. This is the identity associated with your merchant account for 3D Secure 2.0. Contact Worldpay Merchant Support to get this information.
This field is required if you want to enable 3D Secure 2.0. This is the identifier to indicate who is issuing the JWT for 3D Secure 2.0. Contact Worldpay Merchant Support to get this information.
This field is required if you want to enable 3D Secure 2.0. This is a base64url encoded hash value of the header and payload combined with a JWT MAC Key for 3D Secure 2.0. Contact Worldpay Merchant Support to get this information.
To enable 3D Secure 2.0 for Worldpay gateway integration, see Enable 3D Secure 2.0 for Worldpay gateway integration for more information.
With this setting enabled, tokens are generated and stored for Credit Card payment methods when processing payments through UI, API, or Payment Pages 2.0.
-
Enable gateway reconciliation (optional): Select this check box if you want to enable Gateway Reconciliation in this gateway instance.
-
Enable DART Reports for Reconciliation (Optional): Enable this setting if you want to use DART reports for reconciliation. With this check box selected, Zuora will retrieve DART reports from Worldpay. Note that DART reports are available only if you are on Worldpay's NAP platform and your Worldpay merchant account is set up correctly.
-
Enable Transfer Batch Report for Reconciliation (Optional): Enable this setting if you want to use the Transfer Batch report for reconciliation. With this check box selected, Zuora will retrieve the Transfer Batch report from Worldpay. Note that the Transfer Batch report is available only if you are using Worldpay service level M and this report is set up for your merchant account.
-
Admin code (optional): The Admin Code assigned to your merchant account by Worldpay.
-
Merchant Acronym (optional): The Merchant Acronym assigned to your merchant account by Worldpay.
See Configuring Worldpay Gateway Reconciliation for more information.