Structure

ApplePayPaymentRequest

A request for payment, which includes information about payment processing capabilities, the payment amount, and shipping information.

Topics

Total and Line Items

total

Required. A line item representing the total for the payment.

lineItems

A set of line items that explain recurring payments and additional charges and discounts.

ApplePayLineItem

A line item in a payment request—for example, total, tax, discount, or grand total.

Transaction Information

countryCode

Required. The merchant’s two-letter ISO 3166 country code.

currencyCode

Required. The three-letter ISO 4217 currency code for the payment.

merchantCapabilities

Required. The payment capabilities supported by the merchant.

shippingMethods

A list of available methods for shipping physical goods.

shippingType

An optional value that indicates how purchased items are to be shipped.

supportedCountries

A list of two-character country codes you provide, used to limit payments to cards from specific countries.

supportedNetworks

Required. The payment networks supported by the merchant.

ApplePayMerchantCapability

The payment capabilities supported by the merchant.

ApplePayShippingMethod

The shipping method for delivering physical goods.

ApplePayShippingType

A type that indicates how purchased items are to be shipped.

Requested Billing and Shipping Contact Information

requiredBillingContactFields

The fields of billing information that you require from the user to process the transaction.

requiredShippingContactFields

The fields of shipping information that you require from the user to fulfill the order.

ApplePayContactField

Field names used for requesting contact information in a payment request.

Known Contact Information

billingContact

Billing contact information for the user.

shippingContact

Shipping contact information for the user.

ApplePayPaymentContact

Information fields that are used for billing and shipping contacts.

Custom Data

applicationData

A Base64-encoded string used to contain your application-specific data.