Welcome to Zuora Product Documentation

Explore our rich library of product information

Set up Apple Pay

Explore how Apple Pay integrates with various payment gateways, offering a secure and private payment method for iOS and web applications.

Apple Pay is a mobile payment service that allows users to make payments in iOS apps, watchOS apps, and websites on Safari and, on supported macOS devices, in Chrome and Edge. It replaces physical cards and cash with an easier, more secure, and private payment method.

When a customer adds a bank card to their Wallet with Apple Pay, the actual card number is not stored on the device nor on the Apple server. Instead, a unique Device Account Number is assigned, encrypted and securely stored in the Secure Element on the iPhone or Apple Watch of the customer. Instead of using the security code from the back of the card, Apple Pay creates a dynamic security code to securely validate each transaction.

Apple Pay is provided by Apple and use of Apple Pay on the Web is subject to the Apple Pay Platform Web Merchant Terms and Conditions. By leveraging the Apple Pay Platform, you must monitor for potentially fraudulent patterns of behavior on an ongoing basis. These patterns of behavior might include but are not limited to average chargeback rates (excluding adjustments and merchandise returns) exceeding two percent (2%) over a thirty (30) day moving period. You must report such potentially fraudulent activity to Zuora. Continuous and/or excessive chargeback rates might be grounds for removal from the Apple Pay program.

For the latest browser and device requirements for Apple Pay on the web, see Apple's documentation. See Getting Started with Apple Pay for more information.

Zuora supports setting up Apple Pay on the following payment gateway integrations through either the JavaScript SDK or the API approach. The following sections describe how to set up Apple Pay by using either the JavaScript SDK or the API approach. For information on setting up Apple Pay through Payment Form, see Payment Form.

Payment Gateway Integration

Supported Approach

Adyen Integration v2.0

Braintree v2.0

JavaScript SDK

Chase Paymentech Orbital (Latest version)

Checkout.com

CyberSource, Payment API v2.0

Fat Zebra

Vantiv (Now Worldpay) Gateway

Stripe v2

Worldpay 1.4

PayPal Complete Payments Gateway

Chase Paymentech (Orbital) Gateway 7.0.1 Integration

"Create a payment method" REST API operation REST API operation

Creation of Apple Pay payment methods is not supported through the Zuora UI or Payments Page 2.0.

Supported credit card types

The following credit card types are supported by Zuora to create Apple Pay payment methods and process Apple Pay transactions:

  • VISA
  • Mastercard
  • American Express
  • Discover
  • JCB

Apple Pay token types in Zuora

Zuora identifies Apple Pay payment methods as either DPAN or MPAN.

  • DPAN is a device-specific Apple Pay token.

  • MPAN is a merchant-specific Apple Pay token that is better suited for recurring billing because it is not tied to a single customer device.

Zuora recommends configuring Apple Pay to use MPAN for recurring billing, because MPAN tokens remain valid even if customers change devices.

To receive MPAN tokens, your Apple Pay integration must send a recurring payment request that includes at least the following fields:

  • paymentDescription
  • regularBilling.label
  • regularBilling.amount
  • regularBilling.paymentTiming = recurring
  • managementURL

Zuora determines the token type when an Apple Pay payment method is created and stores that information with the payment method.Customers can use this information to understand whether an Apple Pay payment method is more resilient for recurring payments and to analyze Apple Pay payment-method coverage across their tenants.Zuora exposes Apple Pay token-type information in the following places:
  • the payment method details in the Zuora UI
  • payment method API responses
  • reporting surfaces that use the Payment Method object

For reporting, use the following Payment Method fields:
  • Network Token Provider
  • Network Token Type

For Apple Pay payment methods, these fields can show:
  • Network Token Provider = ApplePay
  • Network Token Type = MPAN or DPAN

Older Apple Pay payment methods that were created before this enhancement might not display these values in reporting. Zuora does not retroactively backfill token-type values for older payment methods.Zuora recommends configuring Apple Pay to return MPAN for recurring billing flows whenever possible.

To integrate with Zuora's JavaScript SDK for Apple Pay setup, complete all of the following tasks:

Apple Pay payment methods created through Zuora’s Apple Pay flow

When a shopper selects billing details in the Apple Pay sheet, Zuora now stores the shopper’s billing name, billing address, email address, and phone number on newly created Apple Pay payment methods by default.

This helps reduce duplicate address collection during checkout and improves the accuracy of the customer billing details stored with the payment method.

If some billing fields are not provided through Apple Pay, Zuora uses the billing account contact only to fill in any remaining blank fields. Apple Pay values are not overwritten.

No action is required to use this behavior when billing details are already included in the Apple Pay request.

This change applies only to newly created Apple Pay payment methods. Existing Apple Pay payment methods are not updated retroactively.