Interface ApplePayOutput

Result of a successful Apple Pay authorization.

interface ApplePayOutput {
    ephemeralPublicKey?: string;
    paymentData: string;
    paymentMethod: ApplePayPaymentMethodInfo;
    transactionIdentifier: string;
    walletKey?: string;
}

Properties

ephemeralPublicKey? paymentData paymentMethod transactionIdentifier walletKey?

Properties

OptionalephemeralPublicKey

ephemeralPublicKey?: string

Optional: The ephemeral public key used to derive the token's encryption key, extracted from the token header. Required by connectors alongside walletKey. Undefined when the token payload cannot be decoded; paymentData remains available as a fallback.

paymentData

paymentData: string

Base64-encoded opaque token blob returned by Apple Pay. Send to your backend for validation/processing. Security: Do not log or persist this value on-device beyond the payment flow requirements.

paymentMethod

paymentMethod: ApplePayPaymentMethodInfo

Metadata describing the payment instrument used.

transactionIdentifier

transactionIdentifier: string

A string identifier for the transaction. Use for tracing and reconciliation as needed.

OptionalwalletKey

walletKey?: string

Optional: The encrypted payment ciphertext, extracted from the token's data field. Payment connectors commonly require this as a discrete value (e.g., VTEX/Cielo WalletKey). Undefined when the token payload cannot be decoded; paymentData remains available as a fallback. Security: Do not log or persist this value on-device beyond the payment flow requirements.

Settings

Member Visibility

On This Page

Properties