Interface ApplePayInput

Parameters for initiating Apple Pay. The application may override merchantIdentifier via configuration.

interface ApplePayInput {
    countryCode: string;
    currencyCode: string;
    summaryItems: ApplePaySummaryItem[];
    supportedNetworks?: string[];
    merchantCapabilities?: string[];
    requiredShippingContactFields?: string[];
    requiredBillingContactFields?: string[];
    shippingMethods?: ApplePayShippingMethod[];
}

Properties

countryCode currencyCode summaryItems supportedNetworks? merchantCapabilities? requiredShippingContactFields? requiredBillingContactFields? shippingMethods?

Properties

countryCode

countryCode: string

Required: ISO 3166-1 alpha-2 country code (e.g., "BR", "US").

currencyCode

currencyCode: string

Required: ISO 4217 currency code (e.g., "BRL", "USD").

summaryItems

summaryItems: ApplePaySummaryItem[]

Required: Summary items displayed in the Apple Pay sheet. Amounts must be provided in integer cents.

OptionalsupportedNetworks

supportedNetworks?: string[]

Optional: Accepted card networks. Case-insensitive. Unknown values are ignored.

Available values include:

[
  "visa", "masterCard", "amex", "discover", "interac", "privateLabel", "cartesBancaires", "maestro", "eftpos", "elo", "mada"
]

All recognized values are available when omitted.

OptionalmerchantCapabilities

merchantCapabilities?: string[]

Optional: Merchant capabilities. Case-insensitive. Available values:

 ["3DS", "emv", "credit", "debit"]

Default: ["3DS"] when omitted.

OptionalrequiredShippingContactFields

requiredShippingContactFields?: string[]

Optional: Required shipping contact fields. Case-insensitive. Available values:

[
  "address", "email", "name", "phone", "phoneticName"
]

Default: none.

OptionalrequiredBillingContactFields

requiredBillingContactFields?: string[]

Optional: Required billing contact fields. Same options as shipping. Default: none.

OptionalshippingMethods

shippingMethods?: ApplePayShippingMethod[]

Optional: Available shipping methods (amounts in integer cents).

Settings

Member Visibility

On This Page

Properties