<!--
{
  "availability" : [

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

# ApplePayRequestBase

A dictionary that defines basic payment and contact information that the Apple Pay payment request object uses for the W3C Payment Request API.

```
dictionary ApplePayRequestBase {
	sequence <ApplePayFeature> features;
	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;
	ApplePayInstallmentConfiguration installmentConfiguration;
	boolean supportsCouponCode;
	DOMString couponCode;
	ApplePayShippingContactEditingMode shippingContactEditingMode;
	ApplePayLaterAvailability applePayLaterAvailability;
};
```

## Topics

### Setting the transaction information

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

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

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

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

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

The payment networks the merchant provides to their customers.

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

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

### Managing coupon codes

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

The initial coupon code for the payment request.

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

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

### Billing and shipping information

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

A list of fields use for processing the transaction, including the name, address, and other information associated with the payment method.

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

A list of fields used for processing the transaction, including the recipient’s name, mailing address, and other contact details.

### Setting contact information

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

A prepopulated billing address.

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

The customer’s address, used for sending products or services for to the person.

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

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

### Adding custom data

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

Application-specific data or state you can add to support your app.

### Adding an installment configuration

[`ApplePayInstallmentConfiguration installmentConfiguration;`](/documentation/ApplePayontheWeb/ApplePayRequestBase/installmentConfiguration)

### Adding features

[`sequence <ApplePayFeature> features;`](/documentation/ApplePayontheWeb/ApplePayRequestBase/features)

### Deprecated

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

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

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

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



---

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)