Type Alias ApplePayBaseParams

ApplePayBaseParams: {
    merchantCountryCode: string;
    currencyCode: string;
    additionalEnabledNetworks?: string[];
    cartItems: PlatformPay.CartSummaryItem[];
    requiredShippingAddressFields?: ContactField[];
    requiredBillingContactFields?: ContactField[];
    shippingMethods?: ShippingMethod[];
    merchantCapabilities?: ApplePayMerchantCapability[];
    shippingType?: ApplePayShippingType;
    supportedCountries?: string[];
}

Type declaration

  • merchantCountryCode: string

    ISO 3166-1 alpha-2 country code where the transaction is processed.

  • currencyCode: string

    ISO 4217 alphabetic currency code.

  • OptionaladditionalEnabledNetworks?: string[]

    The SDK accepts Amex, Mastercard, Visa, and Discover for Apple Pay by default. Set this property to enable other card networks, for example: ["JCB", "barcode", "chinaUnionPay"]. A full list of possible networks can be found at https://developer.apple.com/documentation/passkit/pkpaymentnetwork.

  • cartItems: PlatformPay.CartSummaryItem[]

    The list of items that describe a purchase. For example: total, tax, discount, and grand total. The final item should represent your company and the total; it'll be prepended with the word "Pay" (for example, "Pay Example Company $50").

  • OptionalrequiredShippingAddressFields?: ContactField[]

    The list of fields that you need for a shipping contact in order to process the transaction. If you include ContactField.PostalAddress in this array, you must implement the PlatformPayButton component's onShippingContactSelected callback and call updatePlatformPaySheet from there.

  • OptionalrequiredBillingContactFields?: ContactField[]

    The list of fields that you need for a billing contact in order to process the transaction.

  • OptionalshippingMethods?: ShippingMethod[]

    An array of shipping method objects that describe the supported shipping methods. If provided, you must implement the PlatformPayButton component's onShippingMethodSelected callback and call updatePlatformPaySheet from there.

  • OptionalmerchantCapabilities?: ApplePayMerchantCapability[]

    Set the payment capabilities you support. If set, 3DS is required.

  • OptionalshippingType?: ApplePayShippingType

    An optional value that indicates how to ship purchased items. Defaults to 'Shipping'.

  • OptionalsupportedCountries?: string[]

    A list of two-letter ISO 3166 country codes for limiting payment to cards from specific countries or regions.

Settings

Member Visibility