Opt out with the D1 API

Overview

This page explains how the issuer backend can opt a card out of Click to Pay by calling the D1 API Click to Pay opt-out.

Use this backend flow when:

• You want to remove a card from Click to Pay without any action from the end user in the issuer application (for example, card closure, fraud, or regulatory reasons).

• You orchestrate opt-out operations from the issuer backend or the Customer care interface.

When the opt-out operation succeeds:

• The card is deleted from the Click to Pay directory.

• The payment network deletes the associated digital card.

• The card no longer appears as an available payment method during Click to Pay checkout.

Opt-out is final. If needed, you can re-enroll the card by calling the API Click to Pay enrol.

Click to Pay consumer opt-out

The flows below also apply to consumer opt-out, with the following exceptions:

• The dedicated API uses consumerId instead of cardId.

• The notification sent at the end of the operation is Notify Consumer Operations instead of Notify Card Operations.

User experience

Opt a card out of Click to Pay from the issuer backend.

Flow

The diagram below shows the overall backend opt-out flow:

Backend Click to Pay opt-out flow.

Sequence diagram

The sequence diagram below illustrates the opt-out by cardId flow initiated from the issuer backend:

Sequence diagram for backend Click to Pay opt-out.

The sequence diagram below illustrates the opt-out by consumerId flow initiated from the issuer backend:

Sequence diagram for backend Click to Pay consumer opt-out.

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.

Through D1, the Delete card request propagates to all linked services. As a result, the deletion request also triggers opt-out of the card from Click to Pay. No further action is 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.