ApplePay

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.

Platform	Availability
Safari (macOS)	Yes
Safari (iOS)	Yes
Chrome/Firefox/Edge	No
iOS apps	Yes
Android	No

const available = await engine.checkAvailability();
if (available.includes('ApplePay')) {
  // Show Apple Pay button
}

Requirements

ApplePay requires:

A payment gateway (PSP) account from one of our supported payment gateways, configured in Orchestra Portal
An Apple Developer account with ApplePay enabled (see ApplePay Setup), configured as an ApplePay eWallet account in Orchestra Portal

// Server-side session creation
const session = {
  operation: 'CHARGE',
  paymentGatewayAccountId: 'yourPspAccount',
  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

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

Supported Operations

Operation	Supported	Description
`CHARGE`	Yes	Process payment immediately
`TOKENIZE`	Yes	Store payment method for future use
`CHARGE_AND_TOKENIZE`	Yes	Process 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);

Apple Pay Setup

Domain verification and merchant setup

Result Handling

Parse payment results

Start Here

Beyond the Quickstart

Concepts

Orchestra Payments Library Guides

Orchestra REST API Guides

Utilities

Merchant Account Setup

Support

Changelog

Availability

Requirements

Button Setup

How It Works

Supported Operations

3D Secure

Address Collection

Apple Pay Setup

Result Handling

​Availability

​Requirements

​Button Setup

​How It Works

​Supported Operations

​3D Secure

​Address Collection

​Related

Apple Pay Setup

Result Handling

Availability

Requirements

Button Setup

How It Works

Supported Operations

3D Secure

Address Collection

Related