---
title: ApplePayRequest
framework: applepayontheweb
role: symbol
role_heading: Structure
path: applepayontheweb/applepayrequest
---

# ApplePayRequest

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

## Declaration

```data
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;
};
```

## Mentioned in

Apple Pay on the Web Version 12 Release Notes Setting up the payment request API to accept Apple Pay Apple Pay on the Web Version 6 Release Notes

## Overview

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.

## Topics

### Identifier and version information

- [merchantIdentifier](applepayontheweb/applepayrequest/merchantidentifier.md)
- [version](applepayontheweb/applepayrequest/version.md)

### Transaction information

- [countryCode](applepayontheweb/applepayrequest/countrycode.md)
- [merchantCapabilities](applepayontheweb/applepayrequest/merchantcapabilities.md)
- [supportedNetworks](applepayontheweb/applepayrequest/supportednetworks.md)
- [supportedCountries](applepayontheweb/applepayrequest/supportedcountries.md)

### Setting the Apple Pay Later mode

- [applePayLaterAvailability](applepayontheweb/applepayrequestbase/applepaylateravailability.md)
- [ApplePayLaterAvailability](applepayontheweb/applepaylateravailability.md)

### Coupon codes

- [couponCode](applepayontheweb/applepayrequest/couponcode.md)
- [supportsCouponCode](applepayontheweb/applepayrequest/supportscouponcode.md)

### Requesting billing and shipping contact information

- [requiredBillingContactFields](applepayontheweb/applepayrequest/requiredbillingcontactfields.md)
- [requiredShippingContactFields](applepayontheweb/applepayrequest/requiredshippingcontactfields.md)

### Known contact information

- [billingContact](applepayontheweb/applepayrequest/billingcontact.md)
- [shippingContact](applepayontheweb/applepayrequest/shippingcontact.md)
- [shippingContactEditingMode](applepayontheweb/applepayrequest/shippingcontacteditingmode.md)
- [ApplePayPaymentContact](applepayontheweb/applepaypaymentcontact.md)
- [ApplePayShippingContactEditingMode](applepayontheweb/applepayshippingcontacteditingmode.md)

### Respond to payment request change events

- [PaymentMethodChangeEvent](applepayontheweb/paymentmethodchangeevent.md)
- [ApplePayCouponCodeDetails](applepayontheweb/applepaycouponcodedetails.md)

### Custom data

- [applicationData](applepayontheweb/applepayrequest/applicationdata.md)

## See Also

### Payment request

- [Setting up the payment request API to accept Apple Pay](applepayontheweb/setting-up-the-payment-request-api-to-accept-apple-pay.md)
- [ApplePayRequestBase](applepayontheweb/applepayrequestbase.md)
- [ApplePayModifier](applepayontheweb/applepaymodifier.md)
- [ApplePayPaymentCompleteDetails](applepayontheweb/applepaypaymentcompletedetails.md)