Express Docs v0.1.0

---

Express Docs / AdyenApplePayOptions

Interface: AdyenApplePayOptions

Defined in: src/types.ts:556

Options for the Adyen Apple Pay provider (Adyen:ApplePay).

Remarks

Uses the Adyen API-only integration with native ApplePaySession. The Apple Pay JS SDK is loaded automatically. totalAmount and currencyCode are required.

Example

const adyenApplePay: ProviderButtonConfig<'Adyen:ApplePay'> = {
  providerProtocolType: 'Adyen',
  paymentMethodType: 'ApplePay',
  container: '#adyen-applepay-container',
  style: { buttonstyle: 'black', type: 'buy' },
  options: {
    totalAmount: 1000,
    currencyCode: 'EUR',
    countryCode: 'DE',
  },
};

Extends

• CheckoutFlowFlags

Properties

countryCode?

optional countryCode?: string

Defined in: src/types.ts:564

ISO 3166-1 alpha-2 country code for the merchant (e.g. 'US', 'DE'). Defaults to 'DE'.

---

currencyCode

currencyCode: string

Defined in: src/types.ts:562

ISO 4217 currency code (e.g. 'EUR', 'USD').

---

isBillingCustomerDataRequired?

optional isBillingCustomerDataRequired?: boolean

Defined in: src/types.ts:592

When true, the integrator's backend already supplies the customer's billing address and Apple Pay should not request it from the payer. When false or unset (default), Apple Pay collects the billing address.

Maps (inverted) to the W3C Payment Request requestBillingAddress option: requestBillingAddress = !isBillingCustomerDataRequired.

Default Value

false — Apple Pay collects billing address

Overrides

CheckoutFlowFlags.isBillingCustomerDataRequired

---

isShippingCustomerDataRequired?

optional isShippingCustomerDataRequired?: boolean

Defined in: src/types.ts:606

When true, the integrator's backend already supplies the customer's shipping address and Apple Pay should not request it from the payer. When false or unset (default), Apple Pay collects the shipping address and payer contact (name, email, phone).

Maps (inverted) to the W3C Payment Request requestShipping option: requestShipping = !isShippingCustomerDataRequired. Payer contact fields (name, email, phone) are collected automatically when either address is collected by Apple Pay.

Default Value

false — Apple Pay collects shipping address and payer contact

Overrides

CheckoutFlowFlags.isShippingCustomerDataRequired

---

merchantDisplayName?

optional merchantDisplayName?: string

Defined in: src/types.ts:581

Optional merchant name shown as the payment line item label in the Apple Pay sheet.

Remarks

When set here, this value takes precedence over the displayName returned in the Adyen Apple Pay session, which itself originates from the Adyen ProviderAccount configuration in collana pay. Use this to override the server-side default on a per-integration basis without changing the ProviderAccount setup.

If omitted, the SDK falls back to the session's displayName and, as a last resort, to 'Merchant'.

---

nativeOnly?

optional nativeOnly?: boolean

Defined in: src/types.ts:631

If true, the Apple Pay button is only rendered when the browser supports Apple Pay natively (i.e. Safari on macOS/iOS). In non-native browsers the provider skips loading the Apple Pay JS polyfill and the render promise rejects with an APPLE_PAY_UNAVAILABLE error which is routed to the integrator's global onError handler.

Disables the cross-device "Scan with iPhone" QR handoff that the polyfill enables on Chrome/Edge/Firefox. Apple offers no API-level switch to suppress the QR flow on its own, so the entire provider is gated on native support.

Default Value

false

---

pspAutoCaptureEnabled

pspAutoCaptureEnabled: boolean

Defined in: src/types.ts:262

When true (default), the payment is captured immediately after authorization. When false, the payment is authorized only and must be captured separately.

Remarks

This flag is mapped to the provider-native concept:

• PayPal / Braintree / Adyen PayPal → intent: 'capture' (true) / 'authorize' (false)
• Stripe → captureMethod: 'automatic' (true) / 'manual' (false)

Inherited from

CheckoutFlowFlags.pspAutoCaptureEnabled

---

supportedNetworks?

optional supportedNetworks?: string[]

Defined in: src/types.ts:566

Card networks accepted by the merchant.

Default Value

['amex', 'discover', 'masterCard', 'visa']

---

supportedShippingCountries?

optional supportedShippingCountries?: string[]

Defined in: src/types.ts:616

List of ISO 3166-1 alpha-2 country codes to which the merchant ships. When set and non-empty, the Apple Pay sheet validates the selected shipping country against this list and displays an error if it is not included. When omitted or set to an empty array, all countries are accepted.

Example

`['DE', 'AT', 'CH']` — restrict to DACH region

Default Value

undefined — all countries accepted

---

totalAmount

totalAmount: number

Defined in: src/types.ts:560

Transaction amount in minor units (e.g. 1000 = €10.00).