Invalidate a Merchant Token
Invalidate a merchant token associated with your merchant identifier, making it invalid for future transaction authorizations.
URL
POST https://apple-pay-gateway.apple.com/paymentservices/v1/merchantId/{merchantId}/merchantToken/unlinkPath Parameters
| Name | Type | Description |
|---|---|---|
merchantId Required | string | Your merchant identifier. |
Header Parameters
| Name | Type | Description |
|---|---|---|
Accept Optional | string | |
Content-Type Required | string | |
x-request-id Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 204 | No Content | Success. The service doesn’t return any additional information. | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | Invalid request. The merchant token identifier isn’t valid for the merchant identifier. |
| 500 | Internal Server Error Content-Type: application/json | ErrorResponse | Internal server error. |
Discussion
When you call this endpoint, Apple Pay server unlinks — invalidates — the merchant token, and the token is no longer valid for future transaction authorizations. Call this endpoint in the following cases:
Someone cancels a recurring transaction on your website or in your app that uses this merchant token
Someone changes the payment method for a recurring transactions, for example, they stop using Apple Pay for the transaction
HTTP Body
The request body you use to specify the merchant token that Apple Pay should invalidate.