Apple Pay via Worldpay US eCom (Vantiv)
This feature is currently a Private Beta release. Contact Chargebee Support to enable Apple Pay via Worldpay US eCom (Vantiv Litle) for your live and test sites.
Introduction
Worldpay US eCom (formerly Vantiv Litle) lets you accept payments through multiple payment methods, on any device that supports Apple Pay.
You can configure your Chargebee site to accept Apple Pay using your Worldpay US eCom (Vantiv Litle) account. Apple Pay via Worldpay US eCom is supported by Chargebee's API, hosted pages, and Chargebee JS.
Apple Pay in Chargebee can be enabled for only one payment gateway at a time. Make sure you disable it from any other gateway to enable it for your desired gateway.
Integration options
Apple Pay via Worldpay US eCom (Vantiv Litle) is supported across the following Chargebee integration options:
| Integration method | Description | Supported |
|---|---|---|
| Chargebee API | Integrate directly with the Chargebee API to accept Apple Pay payments. | Yes |
| Chargebee hosted pages | Accept Apple Pay through Chargebee's hosted checkout pages. | Yes |
| Chargebee JS | Build a custom checkout that accepts Apple Pay using Chargebee JS. | Yes |
Prerequisites
- Configure your Worldpay US eCom (Vantiv Litle) payment gateway in Chargebee. If already configured, move to the next step.
- Set up Apple Pay in your Apple Developer account and prepare the required files before integrating Apple Pay in Chargebee.
Configuring Apple Pay
Follow these steps to configure your Chargebee account to accept Apple Pay payments via Worldpay US eCom (Vantiv Litle):
- Click Settings > Configure Chargebee > Payment Gateway > Worldpay US eCom (Vantiv Litle).
- Enable Apple Pay.
- Enter your Business Name.
- Enter your Merchant ID. Follow these steps to learn how to create or retrieve your Merchant ID.
- Select the Merchant Country Code. This is the country or the region where the payment will be processed.
- Upload your Merchant Identity Certificate (
.pem) and Merchant Identity Key (.key). Follow these steps to learn how to create or retrieve these files. - Upload your Domain Association File (
.txt). Follow these steps to learn how to get this file. - Upload your Apple Pay Payment Processing Certificate (
.pem). Follow these steps to learn how to create or retrieve this file. - Upload your Apple Pay Payment Processing Key (
.key). Follow these steps to learn how to create or retrieve this file. - Under Choose mandatory information to collect from customers, select one or multiple options—Shipping Address, Billing Address, or Email and Phone—if you want to collect this information mandatorily from customers. You can copy these mandatory details for customers from Apple Pay, if already available.
- Click Save to complete the configuration.
Unlike some other gateways, Worldpay US eCom (Vantiv Litle) requires you to upload the Apple Pay Payment Processing Certificate (.pem) and Apple Pay Payment Processing Key (.key) directly in this form before you click Save.
Configure Smart Routing
When you enable Apple Pay via Worldpay US eCom (Vantiv Litle), configure Smart Routing to set it as the preferred gateway for Apple Pay. If another gateway is already configured for Apple Pay, you can update the routing preferences on the Smart Routing page.
Follow these steps to modify the Smart Routing settings:
- In your Chargebee Billing site, go to Settings > Configure Chargebee > Payment Gateways.
- Click Manage Rules under Smart Routing.
- Go to the Apple Pay section and click Add a Gateway (or the Edit icon) for the relevant currency.
- From the Choose a payment gateway dropdown, select the Worldpay US eCom (Vantiv Litle) gateway instance from your Chargebee site with Apple Pay enabled.
- Click Save.
The domain validation requirements of Apple Pay restrict the configuration to only one payment gateway that can actively support Apple Pay at a time. Therefore, the option to enable Apple Pay via other payment gateways such as Stripe or Braintree must be disabled.
Payment workflow
The following steps are involved in the customer's payment flow when they select Apple Pay using Chargebee's checkout:
- Click Proceed to Checkout from the Your Order page to initiate a purchase.
- Click the Apple Pay button.
- The Apple Pay sheet appears. The customer authenticates with Face ID, Touch ID, or their passcode and selects a card to complete the payment.
- Once the payment is made, the customer is redirected to Chargebee and the payment method is successfully linked to the customer. Recurring payments are made using the selected card in Apple Pay.
Payment features
The following are the features for this integration and details about them:
| Feature | Description | Supported | Default state | Configuration / behavior |
|---|---|---|---|---|
| Integration sync mode | Defines how payment requests are processed and statuses are communicated between Chargebee and Worldpay US eCom. | Yes (Synchronous) | Synchronous | Worldpay US eCom processes Apple Pay payments synchronously. Chargebee receives the payment status in the gateway response. |
| Capture settings | Payment processing involves two stages: Authorization and Capture. Capture settings determine when funds are collected after authorization. | Yes | Auto capture | Auto capture is the default and only supported capture setting for Worldpay US eCom. No additional configuration is required. |
| Verification modes | Defines how payment methods are verified before processing. | Yes | Enabled | The Apple Pay token is verified during payment processing. No additional configuration is required. |
| Statement descriptor | Displays the business name on the customer's bank or card statement, helping them recognize charges and reducing disputes. | Yes | Disabled | Configure this under Settings > Configure Chargebee > Transaction Descriptor. |
| Chargeback management | Handles chargeback events and applies configured actions on invoices and subscriptions. | Yes | Disabled | Enable Chargeback Management under Settings > Configure Chargebee > Billing LogIQ > Payments > Chargeback Management. |
| Fraud management | Uses gateway fraud signals to identify and flag high-risk transactions. | No | NA | No Apple Pay-specific fraud configuration is available in Chargebee. |
| Transaction initiation type | Identifies whether a transaction is customer-initiated (CIT) or merchant-initiated (MIT). | Yes | Supported | The initial payment is customer-initiated through the Apple Pay wallet. Subsequent recurring payments are merchant-initiated. |
| Error intelligence | Provides standardized categorization of payment failures. | Yes | Enabled | Available via Worldpay US eCom response codes. No configuration is required. |
| Gateway transaction details | Provides access to raw gateway responses for transactions. | Yes | Enabled | Available on the transaction page under Error details. No configuration is required. |
| Addition of payment methods in Chargebee dashboard | Allows a payment method to be added in Chargebee when details are collected outside the platform. | No | NA | Apple Pay requires customer authorization through the wallet and cannot be added through the Chargebee dashboard. |
Supported token formats
This section is relevant if you are building a custom checkout or migrating payment methods from another provider to Worldpay US eCom.
| Token type | Description | Supported | Token field | Token format |
|---|---|---|---|---|
| Chargebee Payment Intent | Recommended token format when building a custom checkout using Chargebee JS. | Yes | payment_intent[id] | payment_intent_id |
| Chargebee token | Legacy token format supported for selected payment methods and gateways with Chargebee JS. Not recommended for new implementations. | No | token_id | NA |
| Gateway permanent token | Permanent reference provided by the gateway and used for future recurring payments or migrations from another PSP. | Yes | payment_method[reference_id] | customer_id/payment_source_id |
Testing
Testing in sandbox
Use your Worldpay US eCom (Vantiv Litle) Pre-live account linked to your Chargebee test site to validate the Apple Pay integration before going live.
- Apple Pay is available only on iOS devices or the Safari browser on macOS. Run your tests on a supported device.
- Add a card to Apple Wallet on the test device, then complete a test checkout to validate the end-to-end flow.
Testing in production
Before moving to live:
- Ensure Apple Pay is fully configured in Worldpay US eCom (Vantiv Litle) and Chargebee.
- Perform end-to-end testing using a real card to validate the complete payment flow.