<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "ApplePayontheWeb",
  "identifier" : "/documentation/ApplePayontheWeb/ApplePayRequest",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Apple Pay on the Web"
    ],
    "preciseIdentifier" : "struct/ApplePayRequest"
  },
  "title" : "ApplePayRequest"
}
-->

# ApplePayRequest

A dictionary that defines the Apple Pay payment request object to use for the W3C Payment Request API.

```
dictionary ApplePayRequest {
	required long version;
	required DOMString merchantIdentifier;
	required sequence <ApplePayMerchantCapability> merchantCapabilities;
	required sequence <DOMString> supportedNetworks;
	required DOMString countryCode;
	sequence <ApplePayContactField> requiredBillingContactFields;
	ApplePayPaymentContact billingContact;
	sequence <ApplePayContactField> requiredShippingContactFields;
	ApplePayPaymentContact shippingContact;
	DOMString applicationData;
	sequence <DOMString> supportedCountries;
	boolean supportsCouponCode;
	DOMString couponCode;
	ApplePayShippingContactEditingMode shippingContactEditingMode;
};
```

## Overview

The dictionary contains the supported Apple Pay properties for the `data` object of the `PaymentMethodData` dictionary in the Payment Request API.

For more information on `PaymentMethodData`, see the [W3C Payment Request API specification](https://www.w3.org/TR/payment-request/#paymentmethoddata-dictionary).

## Topics

### Identifier and version information

[`required DOMString merchantIdentifier;`](/documentation/ApplePayontheWeb/ApplePayRequest/merchantIdentifier)

The merchant identifier you registered with Apple for use with Apple Pay.

[`required long version;`](/documentation/ApplePayontheWeb/ApplePayRequest/version)

The Apple Pay version supported on your website.

### Transaction information

[`required DOMString countryCode;`](/documentation/ApplePayontheWeb/ApplePayRequest/countryCode)

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

[`required sequence <ApplePayMerchantCapability> merchantCapabilities;`](/documentation/ApplePayontheWeb/ApplePayRequest/merchantCapabilities)

An array of the payment capabilities the merchant supports, such as credit or debit.

[`required sequence <DOMString> supportedNetworks;`](/documentation/ApplePayontheWeb/ApplePayRequest/supportedNetworks)

The payment networks the merchant supports.

[`sequence <DOMString> supportedCountries;`](/documentation/ApplePayontheWeb/ApplePayRequest/supportedCountries)

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

### Setting the Apple Pay Later mode

[`ApplePayLaterAvailability applePayLaterAvailability;`](/documentation/ApplePayontheWeb/ApplePayRequestBase/applePayLaterAvailability)

A value that indicates whether Apple Pay Later is available for a transaction.

[`enum ApplePayLaterAvailability`](/documentation/ApplePayontheWeb/ApplePayLaterAvailability)

Values you use to enable or disable Apple Pay Later for a specific transaction.

### Coupon codes

[`DOMString couponCode;`](/documentation/ApplePayontheWeb/ApplePayRequest/couponCode)

The initial coupon code for the payment request.

[`boolean supportsCouponCode;`](/documentation/ApplePayontheWeb/ApplePayRequest/supportsCouponCode)

A Boolean value that determines whether the payment sheet displays the coupon code field.

### Requesting billing and shipping contact information

[`sequence <ApplePayContactField> requiredBillingContactFields;`](/documentation/ApplePayontheWeb/ApplePayRequest/requiredBillingContactFields)

The fields of billing information the user must provide to process the transaction.

[`sequence <ApplePayContactField> requiredShippingContactFields;`](/documentation/ApplePayontheWeb/ApplePayRequest/requiredShippingContactFields)

The fields of shipping information the user must provide to fulfill the order.

### Known contact information

[`ApplePayPaymentContact billingContact;`](/documentation/ApplePayontheWeb/ApplePayRequest/billingContact)

The customer’s billing contact information.

[`ApplePayPaymentContact shippingContact;`](/documentation/ApplePayontheWeb/ApplePayRequest/shippingContact)

The customer’s shipping contact information.

[`ApplePayShippingContactEditingMode shippingContactEditingMode;`](/documentation/ApplePayontheWeb/ApplePayRequest/shippingContactEditingMode)

A value that indicates if the shipping mode prevents the user editing the shipping address.

[`dictionary ApplePayPaymentContact {
	DOMString phoneNumber;
	DOMString emailAddress;
	DOMString givenName;
	DOMString familyName;
	DOMString phoneticGivenName;
	DOMString phoneticFamilyName;
	sequence <DOMString> addressLines;
	DOMString subLocality;
	DOMString locality;
	DOMString postalCode;
	DOMString subAdministrativeArea;
	DOMString administrativeArea;
	DOMString country;
	DOMString countryCode;
};`](/documentation/ApplePayontheWeb/ApplePayPaymentContact)

Contact information fields to use for billing and shipping contact information.

[`enum ApplePayShippingContactEditingMode`](/documentation/ApplePayontheWeb/ApplePayShippingContactEditingMode)

Values that indicate whether the shipping mode prevents the user from editing fields of the shipping address.

### Respond to payment request change events

[`interface PaymentMethodChangeEvent`](/documentation/ApplePayontheWeb/PaymentMethodChangeEvent)

The Apple Pay extensions to the Payment Request payment change event.

[`dictionary ApplePayCouponCodeDetails {
	DOMString couponCode;
};`](/documentation/ApplePayontheWeb/ApplePayCouponCodeDetails)

A dictionary that contains the updated coupon code.

### Custom data

[`DOMString applicationData;`](/documentation/ApplePayontheWeb/ApplePayRequest/applicationData)

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


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)