Apple Pay integration

Apple Pay lets customers authorize payments with cards stored in Apple Wallet. Card details are replaced by a device-specific account number and a transaction-specific cryptogram; SUNBAY processes the encrypted payment data returned by Apple Pay.

Follow Apple’s requirements: Before offering Apple Pay, review the Apple Pay on the Web Acceptable Use Guidelines and the latest Apple Pay marketing guidelines . Use only Apple-provided buttons and assets.

Basics

This section covers the Apple Pay availability and card-network support shared across SUNBAY integrations. Integration-specific setup is described under each path below.

Integration scope

This guide covers Apple Pay on the Web. The customer must use an Apple Pay-capable device and browser, have an eligible card in Wallet, and be in a region where Apple Pay is available.

Availability varies by device, browser, Wallet setup, issuer, card network, and country or region. Always keep another payment option available.

Supported card networks

SUNBAY supports the following Apple Pay network identifiers:

visa
masterCard
amex
discover
jcb
chinaUnionPay

The default list is visa, masterCard, amex, discover, and jcb. chinaUnionPay is available when UnionPay is enabled in the channel-routing configuration. The exact networks available to a customer depend on the SUNBAY merchant and channel configuration, as well as Apple Pay availability in that customer’s country or region.

Two integration paths

Choose based on how much payment UI and Apple Pay setup you want to own.

Option 1 · Low code

Hosted Payment Page

SUNBAY hosts the payment UI; create a session and redirect to checkoutUrl—no custom Apple Pay front end or merchant validation.

View steps →

Option 2 · Full front-end control

API Only (Not yet supported)

Apple Pay is not currently supported through the API Only path. Use the Hosted Payment Page for Apple Pay today; this section will be updated once API Only support becomes available.

Apple Pay is currently available only through the Hosted Payment Page. API Only support for Apple Pay is not yet available—this guide will be updated once it is released.

Hosted Payment Page

On the SUNBAY Hosted Payment Page (HPP), Apple Pay appears only after the Partner enables an Apple Pay-capable payment channel for the merchant in SUNBAY Copilot and when Apple Pay is available on the customer’s device and browser.

Integration steps

SUNBAY handles Apple Pay front-end functionality on the Hosted Payment Page, so the Partner or merchant does not need to develop it.

Sign in to SUNBAY Copilot with your Partner account and enable a payment channel that supports Apple Pay for the merchant.
After the channel configuration is active, the merchant backend calls Create checkout session and receives checkoutUrl.
Redirect the browser to checkoutUrl, then verify on an eligible device and browser that the customer can select Apple Pay and authorize.
Handle the merchantReturnUrl return and notifyUrl Webhook according to the Hosted Payment Page guidance.

For complete session fields, redirect behavior, and result handling, see:

Hosted Payment Page

API Only integration

Not yet supported: Apple Pay is not currently available through the API Only integration path. Please use the Hosted Payment Page for Apple Pay today. This section will be published once API Only support for Apple Pay is released—check back later or contact SUNBAY for the latest availability.

References

Resource	Link
Apple Pay developer overview	developer.apple.com/apple-pay
Apple Pay on the Web	Apple Pay on the Web documentation
Configure Apple Pay on the web	Certificates, Merchant IDs, and domain verification
Acceptable Use Guidelines	Apple Pay on the Web Acceptable Use Guidelines
Human Interface Guidelines	Apple Pay design guidance
Marketing guidelines	Apple Pay marketing