AppleTokenResponse Interface

Represents the response returned after a successful Apple Pay tokenization request.
It contains the card token required for payment processing, and optionally, the billing and shipping contact data if available from the Apple Wallet.

Watch Out!
The Apple Pay functionality is currently in a testing phase. It is only available for merchants in Chile 🇨🇱 and Peru 🇵🇪, and supports Visa and Mastercard cards.
Please note that this functionality is subject to change without prior notice.

Hierarchy

AppleTokenResponse

Properties

Property	Type	Description
`token`	`string`	The card token generated for use in the payment process.
`billingContact` (optional)	`ApplePayPaymentContact`	The billing contact information provided by the user’s Apple Wallet.
`shippingContact` (optional)	`ApplePayPaymentContact`	The shipping contact information provided by the user’s Apple Wallet.

token

Type: string
Description:
Unique card token generated by Kushki’s API, ready to be used in the payment process.
This token can be passed directly to Kushki’s charge endpoint to complete a transaction.

billingContact

Type: ApplePayPaymentContact
Description:
The billing contact information of the user as configured in their Apple Wallet.
Includes fields such as emailAddress, postalCode, countryCode, and others.

shippingContact

Type: ApplePayPaymentContact
Description:
The shipping contact information of the user as configured in their Apple Wallet.
Includes fields such as addressLines, locality, postalCode, and country.

Example

const appleTokenResponse: AppleTokenResponse = {
  token: "b9d7f9a6-5e4a-4a13-a8e2-99b6df4c17b3",
  billingContact: {
    givenName: "Jane",
    familyName: "Doe",
    emailAddress: "jane.doe@example.com",
    postalCode: "90210",
    countryCode: "US",
    country: "United States",
  },
  shippingContact: {
    givenName: "Jane",
    familyName: "Doe",
    addressLines: ["123 Main Street", "Apt 5B"],
    locality: "Los Angeles",
    administrativeArea: "CA",
    postalCode: "90210",
    country: "United States",
    countryCode: "US",
  },
};

This object illustrates a response containing a valid token, along with optional billingContact and shippingContact details from Apple Wallet.

Watch Out!#

Hierarchy#

Properties#

token#

billingContact#

shippingContact#