Apple Pay via WorldPay
This feature is currently a Private Beta release. Contact Chargebee Support to enable Apple Pay via WorldPay for your live and test sites.
Apple Pay is a digital wallet that lets customers pay with cards stored in Apple Wallet. Chargebee supports Apple Pay through your WorldPay Direct (Worldwide Payment Gateway) account across Chargebee's API, hosted pages, and Chargebee.js.
Note
Apple Pay in Chargebee can be enabled for only one payment gateway at a time. Disable Apple Pay on any other gateway before you enable it for WorldPay.
Supported countries and currencies
Apple Pay via WorldPay is available when your business is located in one of the following countries:
AT, AU, AE, BE, BG, CH, CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HK, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SA, SE, SG, SI, SK, and US.
Use currencies that both Chargebee and WorldPay support for your site. See Currencies supported by Chargebee and confirm currency enablement with WorldPay for your WorldPay account.
Integration options
Apple Pay via WorldPay 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 Direct payment gateway in Chargebee. If it is already configured, continue to the next prerequisite.
- Set up Apple Pay in your Apple Developer account and prepare the required Apple Pay ID, certificates, key, and domain association file before you configure Apple Pay in Chargebee. Follow Apple's Apple Pay setup documentation.
Configure Apple Pay in Chargebee
Follow these steps to configure Apple Pay payments via WorldPay:
- Click Settings > Configure Chargebee > Payment Gateways > WorldPay.
- Enable Apple Pay.
- Enter your Business Name.
- Enter your Merchant ID. Follow these steps to create or retrieve this value.
- Select the Merchant Country Code. This is the country or region where the payment is processed.
- Upload your Merchant Identity Certificate (
.pem). Follow these steps to create or retrieve this file. - Upload your Merchant Identity Key (
.key). Follow these steps to create or retrieve this file. - Upload your Domain Association File (
.txt). Follow these steps to get this file. - Under Choose mandatory information to collect from customers, select one or more of Shipping Address, Billing Address, or Email and Phone if you want Chargebee to require this information from Apple Pay.
- Click Save to complete the configuration.
Configure Smart Routing
When you enable Apple Pay via WorldPay, configure Smart Routing so WorldPay is the preferred gateway for Apple Pay. If another gateway is already configured for Apple Pay, update the routing preferences on the Smart Routing page.
- 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 gateway instance on your Chargebee site that has Apple Pay enabled.
- Click Save.
Note
Apple Pay domain validation allows only one payment gateway to actively support Apple Pay at a time. Disable Apple Pay on other gateways such as Stripe or Braintree before you route Apple Pay to WorldPay.
Checkout flow
The following steps describe what the customer does when they pay with Apple Pay in Chargebee checkout:
- Click Proceed to Checkout from the Your Order page to start the 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.
- After the payment succeeds, the customer returns to Chargebee and the payment method is linked to the customer. Recurring payments use the selected card in Apple Pay.
Supported token formats
This section applies if you are building a custom checkout or migrating payment methods from another provider to WorldPay.
| 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 |
Payment features
The following table summarizes features for this integration:
| Feature | Description | Supported | Default state | Configuration / behavior |
|---|---|---|---|---|
| Integration sync mode | Defines how payment requests are processed and statuses are communicated between Chargebee and WorldPay. | Yes (Synchronous) | Synchronous | WorldPay 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. |
| 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 business-initiated (MIT). | Yes | Supported | The initial payment is customer-initiated through the Apple Pay wallet. Subsequent recurring payments are business-initiated (MIT). |
| Error intelligence | Provides standardized categorization of payment failures. | Yes | Enabled | Available via WorldPay 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. |
Testing
Testing in sandbox
Use your WorldPay test account linked to your Chargebee test site to validate the Apple Pay integration before you go live.
- Apple Pay is available only on iOS devices or the Safari browser on macOS. Run your tests on a supported device.
- Add a test card to Apple Wallet using the Apple Pay sandbox testing guide, then complete a test checkout to validate the end-to-end flow.
Testing in production
Before you move to live:
- Ensure Apple Pay is fully configured in WorldPay and Chargebee.
- Perform end-to-end testing with a real card to validate the complete payment flow.
Limitations and important points
- Apple Pay via WorldPay is a Private Beta feature and must be enabled by Chargebee Support.
- Only one gateway on a Chargebee site can have Apple Pay enabled at a time because of Apple domain validation.
- You cannot add an Apple Pay payment method from the Chargebee dashboard; the customer must authorize the wallet.
- Apple Pay checkout testing requires a supported Apple device or Safari on macOS.
Was this article helpful?