---
title: Apple Pay Merchant Token Management API
framework: Apple Pay Merchant Token Management API
role: collection
role_heading: Web Service
platforms: [app store connect api 1.0+, apple pay merchant token management api 1.0.12+]
path: merchanttokennotificationservices
---

# Apple Pay Merchant Token Management API

Retrieve and manage payment life-cycle events for your Apple Pay merchant tokens.

## Overview

Overview The Apple Pay Merchant Token Management API is a REST API that enables merchants to get the details of a life-cycle event after receiving a merchant token event notification. You can also use this API to inform Apple Pay servers to invalidate your token when it’s no longer in use. Merchant tokens offer a reliable solution for taking recurring, deferred, and automatic reload payments with Apple Pay. Users can manage their merchant tokens in Wallet. You can enrich the token management experience by providing usage information, using the Apple Pay Merchant Token Usage Information API. This helps users understand past payments and keep track of upcoming payments. Apple Pay utilizes a tap-and-pull model to deliver events related to merchant tokens. In this process, the Apple Pay server notifies you of an event. Then you can subsequently retrieve the event details using the provided eventId. You can access the event details for seven days. The API between the device and you, the merchant, requires Transport Layer Security (TLS), and the device presents the merchant-provided authenticationToken to authenticate requests. In addition, you can call the Apple Pay server to unlink Merchant Primary Account Numbers (MPANs). Access to the APIs between the Apple Pay server and the merchant requires mutual TLS. A merchant token associates a payment card, merchant, and user. Apple Pay issues a merchant token when a customer initiates a purchase using Apple Pay in your app or on your website. When your app or website creates a payment request for a recurring payment or an automatic reload payment, it passes your server’s notification URL in the tokenNotificationURL parameter. For more information about tokenNotificationURL, see PKAutomaticReloadPaymentRequest, PKRecurringPaymentRequest, ApplePayAutomaticReloadPaymentRequest, ApplePayRecurringPaymentRequest, PKDeferredPaymentRequest, and ApplePayDeferredPaymentRequest. If a life-cycle event affects the token — for example, the card’s expiration date changes, or the user or issuer deletes the token — Apple Pay sends you a notification with an event identifier to that tokenNotificationURL. You retrieve the details of the event by calling Get Details of a Merchant Token Event with the event identifier.

## Topics

### Essentials

- [Adding merchant token usage information](applepaymerchanttokenmanagementapi/adding-merchant-token-usage-information.md)
- [Apple Pay Merchant Token Usage Information API](applepaymerchanttokenusageinformation.md)

### Merchant token notification handling

- [Receiving and handling merchant token notifications](applepaymerchanttokenmanagementapi/receiving-and-handling-merchant-token-notifications.md)
- [Send Merchant Token Event](merchanttokennotificationservices/send-merchant-token-event.md)
- [Update Merchant Metadata](merchanttokennotificationservices/update-merchant-metadata.md)

### Merchant token event retrieval

- [Get Details of a Merchant Token Event](merchanttokennotificationservices/merchant-token-event-retrieval.md)
- [MerchantTokenEventResponse](merchanttokennotificationservices/merchanttokeneventresponse.md)
- [MerchantTokenMetadata](merchanttokennotificationservices/merchanttokenmetadata.md)
- [CardArt](merchanttokennotificationservices/cardart.md)
- [CardMetadata](merchanttokennotificationservices/cardmetadata.md)
- [EncryptedTokenMetadata](merchanttokennotificationservices/encryptedtokenmetadata.md)
- [TokenMetadata](merchanttokennotificationservices/tokenmetadata.md)

### Merchant token usage information

- [Retrieve Merchant Token Public Key](merchanttokennotificationservices/retrieve-merchant-token-public-key.md)
- [MerchantToken Usage Data Availability Notification](merchanttokennotificationservices/merchanttoken-usage-data-availability-notification.md)
- [MerchantTokenUsageDataAvailabilityNotificationRequest](merchanttokennotificationservices/merchanttokenusagedataavailabilitynotificationrequest.md)
- [Get MerchantToken Usage Information Package](merchanttokennotificationservices/get-merchanttoken-usage-information-package.md)
- [GetMerchantTokenUsageInformationPackageResponse](merchanttokennotificationservices/getmerchanttokenusageinformationpackageresponse.md)
- [AutomaticReloadPaymentDetails](applepaymerchanttokenusageinformation/automaticreloadpaymentdetails.md)
- [CurrencyAmount](applepaymerchanttokenusageinformation/currencyamount.md)
- [DeferredPaymentDetails](applepaymerchanttokenusageinformation/deferredpaymentdetails.md)
- [PastPayment](applepaymerchanttokenusageinformation/pastpayment.md)
- [PaymentIssueDetails](applepaymerchanttokenusageinformation/paymentissuedetails.md)
- [RecurringPaymentDetails](applepaymerchanttokenusageinformation/recurringpaymentdetails.md)
- [UpcomingPayment](applepaymerchanttokenusageinformation/upcomingpayment.md)
- [UsageInformation](applepaymerchanttokenusageinformation/usageinformation.md)

### Merchant token invalidation

- [Invalidate a Merchant Token](merchanttokennotificationservices/unlinking-merchanttoken.md)
- [MerchantTokenUnlinkRequest](merchanttokennotificationservices/merchanttokenunlinkrequest.md)

### Error handling

- [ErrorResponse](merchanttokennotificationservices/errorresponse.md)

### Dictionaries

- [MerchantMetadata](merchanttokennotificationservices/merchantmetadata.md)
- [MerchantTokenUsageMetadata](merchanttokennotificationservices/merchanttokenusagemetadata.md)
- [RetrieveMerchantTokenPublicKeyRequest](merchanttokennotificationservices/retrievemerchanttokenpublickeyrequest.md)
- [RetrieveMerchantTokenPublicKeyResponse](merchanttokennotificationservices/retrievemerchanttokenpublickeyresponse.md)
- [UpdateMerchantMetadataRequest](merchanttokennotificationservices/updatemerchantmetadatarequest.md)