Opt out from Click to Pay

Overview

Click to Pay allows an end user to opt a card out so that it is no longer available during Click to Pay checkout.

To opt a card out of Click to Pay, the issuer uses the D1 API Click to Pay opt-out card.

Opting out a card has the following effects:

• The card is removed from the Click to Pay directory.
• The payment network deletes the associated digital card.
• The card no longer appears as a means of payment during Click to Pay checkout for that end user.

D1 also exposes another API to opt out a consumer from Click to Pay entirely. This removes the consumer details and all tokenized cards. Refer to Click to Pay opt-out consumer.

The opt-out is a definitive operation. If needed, the issuer can make the card available again by re-enrolling it in Click to Pay. For details, see Enroll cards in Click to Pay.

Quick links

• Enroll cards in Click to Pay
• Update Click to Pay profiles
• Retrieve Click to Pay profiles
• Opt out by D1 API
• Opt out by D1 SDK

Effects of opt-out

Depending on the selected opt-out type, the operation deletes either the card or the full consumer profile and all cards from Click to Pay.

As a result, the payment network deletes all associated details.

When the end user checks out on a merchant site with Click to Pay, the deleted card no longer appears as a payment method.

When the issuer decides to permanently remove the resources from D1, the Delete card and Delete consumer requests are propagated to all the enabled services, when applicable. As a consequence of that, for Click to Pay means:

• Delete card request triggers first Click to Pay card opt-out.
• Delete consumer request triggers first Click to Pay consumer opt-out.

No further actions are required from the issuer.

Recommendation

• For consumers with several cards, use granular opt-out with the Click to Pay opt-out card API. The cardholder details remain in the Click to Pay directory as long as at least one card exists. When the last card is opted out, D1 automatically deletes the cardholder details from Click to Pay. This ensures that no cardholder details remain in the Click to Pay directory without an associated card.
• For consumers with a single card, use Click to Pay opt-out consumer to ensure full deletion in a single call.

Choose how to opt out

D1 provides two integration options for opting out a card from Click to Pay:

• Opt out via issuer backend (D1 API) – the issuer backend calls the Click to Pay opt-out card API to remove a card from Click to Pay, or the Click to Pay opt-out consumer API to fully remove the consumer from Click to Pay. See Opt out by D1 API.
• Opt out via issuer application (D1 SDK) – the issuer application uses the D1 SDK (D1ClickToPay.optOutCard or D1ClickToPay.optOutConsumer) to initiate the same backend flow from within the mobile experience. See Opt out by D1 SDK.

Both approaches trigger the same backend operation on D1 and on the Click to Pay directories. Choose the one that best fits your user experience and technical architecture.

When to use backend vs SDK opt-out

Use backend opt-out (D1 API) when:

• Opt-out is triggered by the issuer backend (for example, card closure, fraud, or chargeback handling).
• Customer care agents perform opt-out from a customer care interface.
• You need to bulk-opt-out multiple cards without any issuer application interaction.

Use SDK opt-out (D1 SDK) when:

• You want the end user to initiate opt-out directly from the issuer application (for example, a "Remove from Click to Pay" action in card details).
• You want to show immediate feedback in the issuer application while D1 orchestrates the backend process.
• You already use the D1 SDK for Click to Pay enrollment and want a consistent user experience.