Overview of Worldpay payment gateway integration

Supported features

The following table provides a quick reference for the supported features. For details about each feature, see the later sections in this article.

Feature	Worldpay 1.4 (recommended version)	Access Worldpay
Development status	Active	Active
Supported payment methods	Credit Card/Prepaid Card/Gift Card Visa MasterCard American Express Discover JCB Diners Club Debit Cards Credit Card Reference SEPA Apple Pay Google Pay	Credit Card/Prepaid Card/Gift Card Visa MasterCard American Express Discover JCB Diners Club Credit Card Reference ACH
Support 3D Secure 2.0	Yes	Yes
Support Delayed Capture	Yes (For Credit Card, Apple Pay, and Google Pay)	No
Support Level 2 and Level 3 card data	No	No
Support stored credential transactions	Yes	Yes
Support Gateway Options fields	No	No
Gateway provider’s API version	paymentServiceVersion: 1.4	N/A
Worldpay production endpoint used for Zuora gateway integration service	`https://secure.worldpay.com/jsp/merchant/xml/paymentService.jsp`	`https://access.worldpay.com`
Support Gateway Reconciliation	Yes	Yes
Worldpay production endpoint used for Gateway Reconciliation service	`sftp://MFG_MTCPZUOR@mfg.Worldpay.com(195.35.90.22)`
Support Payment Method Updater	Yes (Visa, MasterCard)
Worldpay production endpoint used for Zuora PMU service	`https://trx3.wpstn.com/stlinkbatch/stlinkbatch.dll`

Supported payment methods

This section provides more information about some of the supported payment method types.

Apple Pay

The Worldpay 1.4 payment gateway integration supports Apple Pay. You can set up Apple Pay through any of the following approaches:

Payment Form: Use Zuora's Payment Form feature to add Apple Pay to your hosted payment form.
Zuora JavaScript SDK: Add Apple Pay to your checkout flow and process payments by integrating with a JavaScript SDK provided by Zuora.
"Create an Apple Pay payment method" API operation: Create an Apple Pay payment method and you need to implement your own UI and payment processing integration.

The created Apple Pay payment method is shown as a Credit Card payment method in Zuora.

For more information on the implementation instructions, see the following articles:

Google Pay

The Worldpay 1.4 payment gateway integration supports Google Pay. You can set up Google Pay through either of the following approaches:

Payment Form: Use Zuora's Payment Form feature to add Google Pay to your hosted payment form.
Zuora JavaScript SDK: Add Google Pay to your checkout flow and process payments by integrating with a JavaScript SDK provided by Zuora.

The created Google Pay payment method is shown as a Credit Card payment method in Zuora.

For more information on the implementation instructions, see the following articles:

Credit Card

You can create non-tokenized Credit Card payment methods with card information through the UI, API operation, Payment Pages 2.0, or Payment Form. For more information about setting up payment methods in Zuora, see Define and set up payment methods.

Additionally, you can save any combination of a Worldpay token and clear PAN data for Credit Card payment methods. You can also request Worldpay tokens for existing cards on file. See Tokenize Credit Card payment methods on Worldpay 1.4 for more information.

Credit Card Reference Transaction

For Credit Card Reference Transaction (CCRef) payment methods, Zuora uses the shopper token but not the merchant token. The following operations are supported by CCRef payment methods:

Credit token
Verify a token - The Token ID and Second Token ID fields in Zuora are required by Worldpay in order to verify a token.
Capture a payment using a token
Refund payment

To enable the Credit Card Reference Transaction payment methods, contact Zuora Global Support.

Mandate creation

The following table lists the support for mandate creation on each Worldpay integration version:

	Worldpay 1.4	Access Worldpay
Mandate creation	Among the supported payment methods, Zuora supports mandate creation for SEPA payment methods. Zuora will generate and pass the mandate to the gateway.	Not Supported

Supported payment operations

The following payment operations are supported for Credit Card and ACH payment methods respectively:

Credit Card	Authorization and verification Full and partial payment capture Referenced and non-referenced refunds or partial refunds (Worldpay 1.4 supports external non-referenced refunds) Payment cancel (void)
ACH	Payment Payment cancel (void)
Apple Pay	Validation of Apple Pay payment method Process a payment Authorize and capture a payment Payment cancel (void) Referenced refund
Google Pay	Validation of Google Pay payment method Process a payment Authorize and capture a payment Payment cancel (void) Referenced refund

The following table describes the functional mapping between the Zuora API and the Worldpay API.

Zuora API	Worldpay API
Payment Method creation by passing in Credit Card information	Submitting an order with a Credit Card, and then issue a ‘cancelOrRefund’ type of order modification on the same order.
Payment Creation	Authorize an order with credit card, and issue a ‘capture’ type of order modification.
Void the Authorization	Issue a ‘cancelOrRefund’ type of order modification on the payment order.
Void the Payment	Issue a ‘cancel’ type of order modification on the payment order.
Refund Creation	Issue a ‘refund’ type of order modification on the payment order.
Payment Inquiry	Inquiry on the payment order.

Support for 3D Secure 2.0

Worldpay 1.4 and Access Worldpay support 3D Secure 2.0 (3DS2) feature. See the following articles for more information:

Support for Delayed Capture

The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. The Worldpay 1.4 payment gateway integration supports Delayed Capture for Credit Card, Apple Pay, and Google Pay payment methods, which involves the use of the following API operations:

Create authorization
Create a payment to capture the payment or Cancel authorization

Worldpay always returns a positive result for a capture request, causing Zuora to create a processed payment. To maintain accurate payment statuses, Zuora updates the payment status based on the reconciliation result. Make sure Batch Gateway Reconciliation is enabled.

Multiple captures are not supported for a single authorization request with WorldPay 1.4. In your Worldpay merchant account, ensure that the setting for multiple captures is turned off.

Zuora also supports capturing authorizations that were generated externally by using Zuora's Create authorization API operation.

Support for stored credential profiles

Worldpay 1.4 and Access Worldpay include support for the Stored Credential Transactions framework and the sharing NTI feature. For details, see Support for stored credential transactions overview.

Support for Gateway Reconciliation

To enable and configure Gateway Reconciliation on Worldpay 1.4 or Access Worldpay, see Configure Worldpay Gateway Reconciliation for more information.

Support for Payment Method Updater

To set up the Worldpay Payment Method Updater service in Zuora, see Configure Worldpay Payment Method Updater for more information.

Additional gateway information

Order Number

If an order ID is passed in a Zuora API call, this ID has to be unique for each payment. If no ID is passed in, Zuora will generate a 32-character random alphanumeric value for Payment Method creation, or use our internal IDs (constructed as tenant ID + payment number) for Payment creation requests, to ensure uniqueness.

Reverting a Payment

It’s recommended to use the void payment option within 15 minutes of the payment request, and only use the refund option after 90 minutes has elapsed. Worldpay doesn’t indicate if an order qualifies for void or refund in the void/refund response, so Zuora marks the void/refund request as processed to indicate the gateway received the request, regardless of whether the request will succeed or fail later on.

Email Notifications

Worldpay supports sending order notifications and financial reports by email to the merchant. This feature is implemented and maintained by Worldpay.

Limitations

For Access Worldpay:

JCB, Diners Club, and Discover credit cards are available only for US transactions. Access Worldpay has acquiring capabilities for US domestic for only these 3 card types.
JCB and Diners Club cards do not currently support the $0 default authorization amount.
3DS2 offering will fallback to 3DS1 if the card issuer does not yet support 3DS2 or the deviceData.collectionReference value is not included in the authentication request.
Payouts (credit transactions) are only supported by Visa and Mastercard card brands.
A delay of up to 15 minutes is applicable after you successfully verify a payment method before you can actually make a payment. Attempting to create a payment immediately after verifying a payment method will result in a 404 error. Similarly, this delay is also applicable between successfully submitting a payment and attempting to immediately refund or cancel the payment.
Your Access Worldpay credentials must have Fast Access supported to enable the Fast Access payouts feature. Fast Access allows payouts or credit operations to be received within 30 minutes for supported payment methods. Payment methods that do not support Fast Access will default to Standard Payouts which process within 3-5 days. To find out if your credentials are enabled for Fast Access, contact an implementation manager for Access Worldpay.