Skip to main content
This page is part of Supported Payment Methods. View all payment methods →
Apple Pay enables one-tap payments on Apple devices using Face ID, Touch ID, or passcode authentication. Customers pay with cards stored in their Apple Wallet.

Availability

Apple Pay is only available on Apple devices with Safari browser or in native iOS apps.
PlatformAvailability
Safari (macOS)Yes
Safari (iOS)Yes
Chrome/Firefox/EdgeNo
iOS appsYes
AndroidNo
const available = await engine.checkAvailability();
if (available.includes('ApplePay')) {
  // Show Apple Pay button
}

Requirements

ApplePay requires:
// Server-side session creation
const session = {
  operation: 'CHARGE',
  paymentGatewayAccountId: 'your-psp-account',
  allowedeWalletAccountIds: ['your-applepay-account'],
  allowedBrands: ['VISA', 'MASTERCARD', 'AMEX'],
  amount: 25.00,
  currencyCode: 'USD',
  countryCode: 'US',
  mode: 'LIVE'
};

Button Setup

<div id="applepay-button"></div>
engine.payBy(
  [{ name: 'ApplePay', domEntitySelector: '#applepay-button' }],
  handleResult,
  { color: 'Dark', text: 'Pay' }
);
The Apple Pay button renders with Apple’s official styling. The color and text options customize the appearance within Apple’s guidelines.

How It Works

  1. Customer clicks the Apple Pay button
  2. Apple Pay sheet appears with saved cards
  3. Customer selects a card and authenticates with Face ID, Touch ID, or passcode
  4. Apple returns encrypted payment data to Orchestra
  5. Orchestra processes the payment through your PSP
  6. On completion, the popup closes and results are returned to the client, ready to be sent to your server for validation

Supported Operations

OperationSupportedDescription
CHARGEYesProcess payment immediately
TOKENIZEYesStore payment method for future use
CHARGE_AND_TOKENIZEYesProcess payment and store for future

3D Secure

All ApplePay transactions are 3DS-enabled. ApplePay uses two-factor authentication (Face ID, Touch ID, or passcode) to verify the cardholder before the transaction is processed. Orchestra automatically passes the 3DS authentication data to your PSP if the Orchestra integration to your PSP supports 3DS.

Address Collection

Apple Pay can collect billing and shipping addresses from the customer’s Apple Wallet:
const requiredAncillaryInfo = {
  billingInfo: {
    phoneRequired: true,
    emailAddressRequired: true,
    details: 'FULL'
  },
  shippingInfo: {
    phoneRequired: false,
    emailAddressRequired: false
  }
};

const engine = new eWallet.Engine(sessionToken, requiredAncillaryInfo);