ApplePayOptions Interface

Watch Out!

The Apple Pay functionality is currently in a testing phase. It is only available for merchants in Chile 🇨🇱, Mexico 🇲🇽, and Peru 🇵🇪, and supports Visa and Mastercard cards.

Please note that this functionality is subject to change without prior notice.

Hierarchy

ApplePayOptions

Properties

Property	Type	Description
`style`	`"black"` \| `"white"`	Defines the color style of the Apple Pay button.
`locale`	`"en-US"` \| `"es-ES"` \| `"es-MX"` \| `"pt-BR"`	Defines the locale used for the Apple Pay label text.
`type`	`"add-money"` \| `"book"` \| `"buy"` \| `"check-out"` \| `"continue"` \| `"contribute"` \| `"donate"` \| `"order"` \| `"pay"` \| `"plain"` \| `"reload"` \| `"rent"` \| `"set-up"` \| `"subscribe"` \| `"support"` \| `"tip"` \| `"top-up"`	Specifies the label type displayed on the Apple Pay button.

style

Type: "black" | "white"
Description: Determines the button color. Use "black" for dark-themed layouts or "white" for light-themed layouts.

locale

Type: "en-US" | "es-ES" | "es-MX" | "pt-BR"
Description: Sets the locale of the Apple Pay button label, adapting language and regional display.

type

"add-money" | "book" | "buy" | "check-out" | "continue" | "contribute" | "donate" | "order" | "pay" | "plain" | "reload" | "rent" | "set-up" | "subscribe" | "support" | "tip" | "top-up"

Type: Union of supported Apple Pay button labels.
Description: Determines the label text displayed on the Apple Pay button, matching the intended user action.

Examples:

"buy" → Displays "Buy with Apple Pay"

"subscribe" → Displays "Subscribe with Apple Pay"

"donate" → Displays "Donate with Apple Pay"

Example

This configuration creates a black Apple Pay button with the "Comprar con Apple Pay" label for the Mexico (es-MX) locale.

Got a suggestion on this documentation? Contact us.

Hierarchy#

Properties#

style#

locale#