ApplePayGetTokenOptions 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

ApplePayGetTokenOptions

Properties

Property	Type	Description
`amount`	`number`	Transaction amount.
`countryCode`	`"BR"` \| `"CL"` \| `"CO"` \| `"CR"` \| `"EC"` \| `"SV"` \| `"GT"` \| `"HN"` \| `"MX"` \| `"NI"` \| `"PA"` \| `"PE"`	Merchant's country code.
`currencyCode`	`"USD"` \| `"COP"` \| `"CLP"` \| `"UF"` \| `"PEN"` \| `"MXN"` \| `"BRL"` \| `"CRC"` \| `"GTQ"` \| `"HNL"` \| `"NIO"`	Currency code used for the transaction.
`displayName`	`string`	The merchant name displayed in the Apple Pay sheet.
`isSubscription` (optional)	`boolean`	Indicates whether the generated token is for a subscription.
`optionalApplePayFields` (optional)	`{ [k: string]: any }`	Additional Apple Pay configuration fields following Apple's specification.

amount

Type: number
Description: The total transaction amount to be charged.

countryCode

"BR" | "CL" | "CO" | "CR" | "EC" | "SV" | "GT" | "HN" | "MX" | "NI" | "PA" | "PE"

Type: Union of ISO country codes.
Description: Supported merchant country codes.

currencyCode

"USD" | "COP" | "CLP" | "UF" | "PEN" | "MXN" | "BRL" | "CRC" | "GTQ" | "HNL" | "NIO"

Type: Union of ISO currency codes.
Description: Supported transaction currencies.

displayName

Type: string
Description: The merchant name that appears on the Apple Pay checkout sheet.

isSubscription

Type: boolean
Description: Indicates whether the token generated by this request is intended for a subscription (recurring payment).

true — Generates a subscription token. Use this token to create a subscription via Kushki's recurring charge API.

false (default) — Generates a one-time payment token.

When omitted, the default behavior is equivalent to false.

optionalApplePayFields

Type: object
Description: Additional Apple Pay configuration fields compliant with Apple's Web API specification. These fields can be used to customize the checkout experience, such as requiring billing or shipping contact details.

Got a suggestion on this documentation? Contact us.

Hierarchy#

Properties#

amount#

countryCode#

currencyCode#

displayName#

isSubscription#

optionalApplePayFields#