collana pay JS Docs / AdyenApplePayOptions
Interface: AdyenApplePayOptions
Defined in: types.ts:493
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.
Your onClick callback must return checkoutData containing:
merchantValidationUrl: backend endpoint that handles Apple Pay merchant session validation (supports both Adyen and own certificate flows).returnUrl: backend endpoint that receives the Base64-encoded Apple Pay token and calls Adyen's/paymentsAPI.
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',
},
};Properties
countryCode?
optionalcountryCode?:string
Defined in: types.ts:501
ISO 3166-1 alpha-2 country code for the merchant (e.g. 'US', 'DE'). Defaults to 'DE'.
currencyCode
currencyCode:
string
Defined in: types.ts:499
ISO 4217 currency code (e.g. 'EUR', 'USD').
requiredBillingContactFields?
optionalrequiredBillingContactFields?:string[]
Defined in: types.ts:512
Apple Pay contact fields required for billing (e.g. ['postalAddress', 'phone', 'email']).
requiredShippingContactFields?
optionalrequiredShippingContactFields?:string[]
Defined in: types.ts:510
Apple Pay contact fields required for shipping (e.g. ['postalAddress', 'phone', 'email']).
Remarks
Only relevant when the merchant needs shipping information.
supportedCountries?
optionalsupportedCountries?:string[]
Defined in: types.ts:520
ISO 3166-1 alpha-2 country codes that are valid for shipping.
Remarks
When provided, onshippingcontactselected will reject addresses from countries not in this list with an Apple Pay error.
supportedNetworks?
optionalsupportedNetworks?:string[]
Defined in: types.ts:503
Card networks accepted by the merchant.
Default Value
['amex', 'discover', 'masterCard', 'visa']
totalAmount
totalAmount:
number
Defined in: types.ts:497
Transaction amount in minor units (e.g. 1000 = €10.00).
