Retrieve Click to Pay profiles

Overview

The issuer backend might need to retrieve the Click to Pay data previously enrolled for an end user. Typical use cases include:

• Displaying Click to Pay details to the end user in the issuer application.

• Verifying the information stored in Click to Pay before allowing the end user to update it.

D1 exposes the Click to Pay get consumer profiles API, which retrieves all Click to Pay profiles that the issuer has enrolled in the Click to Pay directories.

When multiple Click to Pay directories are configured, D1 aggregates the data and returns at most one profile per directory. The response contains a clickToPayProfiles[] array, where each entry represents the consumer profile stored in a given directory.

Quick links

• Enroll cards in Click to Pay

• Update Click to Pay profiles

• Opt out cards from Click to Pay

When to use this API

Use Click to Pay get consumer profiles when the issuer backend needs a current snapshot of the consumer information stored in Click to Pay directories. Typical situations include:

• Showing the consumer which cards and profile data are registered in Click to Pay.

• Comparing the data stored in Click to Pay with the data stored in the issuer backend before deciding whether an update is required.

• Troubleshooting differences between what is stored in the issuer backend and what is stored in Click to Pay.

Do not use this API to update consumer or card details. To modify the data stored in Click to Pay, use the update APIs described in Update Click to Pay profiles.

Flow

The diagram below shows the overall flow to retrieve Click to Pay consumer profiles through D1:

Sequence diagram

Prerequisites

Please refer to prerequisites.

The sequence diagram below illustrates the detailed behavior when retrieving Click to Pay consumer profiles. When several directories are available, D1 queries each directory and consolidates the profiles in a single response.