Contents

Send Merchant Token Event

Receive and handle merchant token life-cycle updates from Apple Pay.

URL

GET https://merchant.example.com/notification/merchantToken/{eventId}

Path Parameters

NameTypeDescription
eventId Requiredstring

A string that uniquely identifies a life-cycle event for a merchant token.

Response Codes

StatusReasonTypeDescription
200OK

Successful response.

Mentioned in

Discussion

You implement this endpoint on your server to receive notifications about merchant token life-cycle events. When a life-cycle event affects the merchant token — for example, the card’s expiration date changes, or the user or issuer deletes the token — Apple Pay calls this endpoint to notify you.

To receive requests at this endpoint, your server needs to support the Transport Layer Security (TLS) 1.2 protocol or later.

Process the event in your system with the appropriate action. Respond with 200 OK if your endpoint successfully receives the notification, even if your endpoint can’t find the related merchant token or event identifier. Respond with 500 Internal Server Error if your endpoint isn’t able to process the notification request. Apple Pay immediately retries the notification up to three times if the response isn’t 200.

For more information about implementing this endpoint on your server, see Receiving and handling merchant token notifications.

See Also

Merchant token notification handling