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.
initApplePayButton.Hierarchy#
Methods#
onCancel#
This event is triggered when the Apple Pay token process is canceled.Parameters#
| Name | Type | Description |
|---|
callback | () => void | Function executed when the tokenization process is canceled. |
Returns#
Example#
The cardApplePay instance must be previously initialized with initApplePayButton.
onClick#
This event is triggered when the user clicks on the Apple Pay button.Parameters#
| Name | Type | Description |
|---|
callback | () => void | Function executed when the Apple Pay button is clicked. |
Returns#
Example#
The cardApplePay instance must be previously initialized with initApplePayButton.
requestApplePayToken#
Starts the Apple Pay payment flow and requests a Kushki card token.This token is already processed and ready to be used in Kushki's API to perform a charge or create a subscription.This method requires that initApplePayButton has been successfully initialized and uses a valid ICardApplePay instance.
Parameters#
| Name | Type | Description |
|---|
options | ApplePayGetTokenOptions | Configuration options for the Apple Pay payment request. |
ApplePayGetTokenOptions fields:| Field | Type | Description |
|---|
amount | number | Transaction amount. |
countryCode | string | Merchant's country (e.g., "BR", "CL", "CO", "CR", "EC", "SV", "GT", "HN", "MX", "NI", "PA", "PE"). |
currencyCode | string | Currency for the transaction (e.g., "USD", "COP", "CLP", "UF", "PEN", "MXN", "BRL", "CRC", "GTQ", "HNL", "NIO"). |
displayName | string | The merchant name displayed in the Apple Pay sheet. |
isSubscription | boolean (optional) | When true, generates a subscription token instead of a one-time payment token. Default: false. |
optionalApplePayFields | object (optional) | Additional Apple Pay configuration fields following Apple's official specification. Allows merchants to customize the checkout experience (e.g., required shipping methods, billing address, etc.). |
Returns#
Promise<AppleTokenResponse> — A promise that resolves with the tokenized payment response.Throws#
| Code | Description |
|---|
ERRORS.E025 | Apple Pay payments are not available. |
ERRORS.E026 | Apple Pay token process fails. |
ERRORS.E027 | Apple Pay token process canceled. |
Example — One-time payment#
Use this when you need a token to perform a single charge.Example — Subscription payment#
Set isSubscription: true to generate a subscription token. This token is used to create a recurring charge via Kushki's subscription API.Example — Required billing and shipping data#
Got a suggestion on this documentation? Contact us.
