Apple Pay · Schema

Apple Pay Payment Request

Represents an ApplePayPaymentRequest used to configure an Apple Pay payment session, specifying the merchant capabilities, supported networks, payment amount, and optional shipping and billing requirements.

AppleContactless PaymentsDigital WalletE-CommerceMobile PaymentsPayments

Properties

Name Type Description
countryCode string The two-letter ISO 3166-1 alpha-2 country code for the merchant's country of operation
currencyCode string The three-letter ISO 4217 currency code for the payment
supportedNetworks array The payment networks the merchant supports
merchantCapabilities array The payment capabilities the merchant supports
total object The total amount for the payment, including the merchant name as the label
lineItems array A list of line items explaining the charges, such as subtotal, tax, discount, and shipping
requiredBillingContactFields array The billing contact fields required to process the payment
requiredShippingContactFields array The shipping contact fields required to fulfill the order
shippingMethods array Available shipping methods for the order
shippingType string The type of shipping used for this request, which determines the wording on the payment sheet
shippingContactEditingMode string Controls whether the shipping contact can be edited on the payment sheet
applicationData string Base64-encoded application-specific data that is included in the payment token hash for verification
supportedCountries array A list of ISO 3166-1 alpha-2 country codes for cards that can be used for payment. If not specified, all countries are supported
recurringPaymentRequest object
automaticReloadPaymentRequest object
multiTokenContexts array An array of payment token contexts for multi-merchant payments
View JSON Schema on GitHub