<!--
{
  "availability" : [

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

# ApplePayAutomaticReloadPaymentRequest

A dictionary that represents a request to set up an automatic reload payment, such as a store card top-up or a prepaid account.

```
dictionary ApplePayAutomaticReloadPaymentRequest {
	required DOMString paymentDescription;
	required ApplePayLineItem automaticReloadBilling;
	DOMString billingAgreement;
	required DOMString managementURL;
	DOMString tokenNotificationURL;
};
```

## Overview> Important:
> You must include the ``doc://com.apple.applepayontheweb/documentation/ApplePayontheWeb/ApplePayModifier/automaticReloadPaymentRequest`` property in the ``doc://com.apple.applepayontheweb/documentation/ApplePayontheWeb/ApplePayPaymentRequest`` object to set up an automatic reload payment.

Use an [`ApplePayAutomaticReloadPaymentRequest`](/documentation/ApplePayontheWeb/ApplePayAutomaticReloadPaymentRequest) object to provide the user with payment details and a way to manage payment methods for an automatic reload payment. You can optionally display a billing agreement and set up merchant token life-cycle notifications for the request. For more information about the merchant token life-cycle notifications, see <doc://com.apple.documentation/documentation/MerchantTokenNotificationServices>.

Apple Pay issues an Apple Pay Merchant Token if the user’s payment network supports merchant-specific payment tokens. Otherwise, Apple Pay issues a device token for the payment request.

## Topics

### Describing an automatic reload payment

[`paymentDescription`](/documentation/ApplePayontheWeb/ApplePayAutomaticReloadPaymentRequest/paymentDescription)

A description of the automatic reload payment that Apple Pay displays in the payment sheet.

[`billingAgreement`](/documentation/ApplePayontheWeb/ApplePayAutomaticReloadPaymentRequest/billingAgreement)

A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment.

### Setting the payment summary items

[`automaticReloadBilling`](/documentation/ApplePayontheWeb/ApplePayAutomaticReloadPaymentRequest/automaticReloadBilling)

A line item that contains the reload amount and balance threshold for the automatic reload payment.

[`ApplePayLineItem`](/documentation/ApplePayontheWeb/ApplePayLineItem)

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

### Receiving payment token notifications

[`tokenNotificationURL`](/documentation/ApplePayontheWeb/ApplePayAutomaticReloadPaymentRequest/tokenNotificationURL)

A URL you provide to receive life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment.

### Managing the automatic reload payment

[`managementURL`](/documentation/ApplePayontheWeb/ApplePayAutomaticReloadPaymentRequest/managementURL)

A URL to a web page where the user can update or delete the payment method for the automatic reload payment.


---

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)