Update profiles by D1 SDK

Overview

This page explains how the issuer application can update Click to Pay profile data by using the D1 SDK.

The issuer application can call updateConsumer to update end user profile data, or updateCard to update card-level data for one card.

Use this SDK flow when you want the end user to review and update Click to Pay data directly in the issuer application, while D1 orchestrates the backend update with the Click to Pay directories.

Quick links

Choose the right SDK API

`updateConsumer`

Use updateConsumer when consumer data stored in Click to Pay must change.

Provide all consumer fields, even if only one value changed.

If you also provide a billing address, D1 updates the billing address for all cards linked to the consumer profile.

`updateCard`

Use updateCard when only one enrolled card must change.

This API updates the billing address for the selected card and, for Visa only, the cardholder name.

Do not use these SDK APIs for card renewal or card replacement.

Use the D1 renew or replace flow instead.

Flow

The SDK update flow follows these steps:

The issuer application initializes D1 SDK and logs in the end user.
The issuer application retrieves the current Click to Pay profiles.
The end user updates the required data in the issuer application.
The issuer application calls updateConsumer or updateCard.
D1 sends the request to the D1 backend by using the authenticated end user context.
The D1 backend updates the relevant Click to Pay directories.
D1 returns the operation status to the issuer application.

Sequence diagram

The SDK flow has the same functional behavior as the backend update flow, but it is initiated directly from the issuer application.

For the detailed sequence diagrams, refer to Update Click to Pay profiles.

Key points

Both operations are asynchronous.
The immediate result contains a status of SUCCESSFUL or PENDING, plus an operationID.
Use Retrieve profiles by D1 SDK to prefill the issuer application user interface with the current Click to Pay data.
Use updateConsumer only when you want to update Click to Pay data specifically.
If the issuer backend stores the end user profile in D1, prefer Update consumer information when you want all channels, including Click to Pay, to stay synchronized.
For Mastercard, when you provide a billing address, provide the complete address object.

Handle Click to Pay push notifications

Refer to Handle Click to Pay push notifications in the enrollment by D1 SDK documentation for the implementation details.

SDK API for `updateConsumer`

Use updateConsumer when the issuer application updates end user profile data in Click to Pay.

This API updates the end user profile in all relevant Click to Pay directories. If you provide a billing address, D1 also updates the billing address for each enrolled card.

fun updateConsumerClick2Pay(d1Task: D1Task) {
    // Consumer info received from user input.
    val consumerInfo = ConsumerInfo(
        "Bella",
        "middle name",
        "Lin",
        "en-US",
        "+65",
        "99998888",
        "email@thalesgroup.com"
    )
    val billingAddress = BillingAddress("CZ")

    val callback: D1Task.Callback<Status?> =
        object : D1Task.Callback<Status?> {
            override fun onSuccess(data: Status?) {
                // Update consumer to Click to Pay success
                val status: Status? = data
                val operationID = data?.operationID
            }

            override fun onError(exception: D1Exception) {
                // Refer to D1 SDK Integration – Error Management section.
            }
        }
    d1Task.getClickToPayService().updateConsumer(
        consumerInfo,
        billingAddress,
        callback
    )
}

func updateConsumerClick2Pay(d1Task: D1Task) {
    do {
        // Consumer info received from user input.
        let consumerInfo = ConsumerInfo(firstName: "Bella",
                                        middleName: nil,
                                        lastName: "Lin",
                                        language: "en-US",
                                        phoneNumberCountryCode: "+65",
                                        phoneNumber: "99998888",
                                        email: "email@thalesgroup.com")
        let billingAddress = BillingAddress(countryCode: "CZ")
        let status = try await d1Task.clickToPayService().updateConsumer(consumerInfo: consumerInfo,
                                                                         billingAddress: billingAddress)
        switch status {
        case .pending(operationID: let operationID):
            // Handle pending scenario
            print(operationID)
        case .successful(operationID: let operationID):
            // Handle successful scenario
            print(operationID)
        }
    } catch let error {
        // Handle the error.
    }
}

Always send the full consumer data set.

Do not send only the changed field.

SDK API for `updateCard`

Use updateCard when the issuer application updates one enrolled card in Click to Pay.

This API updates card-level data only. Use it for the billing address, or for the cardholder name when the card belongs to Visa.

fun updateCardClickToPay(d1Task: D1Task, cardID: String, billingAddress: BillingAddress) {

    val callback: D1Task.Callback<Status?> =
        object : D1Task.Callback<Status?> {
            override fun onSuccess(data: Status?) {
                // Update card to Click to Pay success
                val status: Status? = data
                val operationID = data?.operationID
            }

            override fun onError(exception: D1Exception) {
                // Refer to D1 SDK Integration – Error Management section.
            }
        }
    d1Task.getClickToPayService().updateCard(
        cardID,
        "Bella Lin",
        billingAddress,
        callback
    )
}

do {
    let cardID = ""
    let name = "Bella Lin"
    let billingAddress = BillingAddress(countryCode: "CZ")
    let status = try await d1Task.clickToPayService().updateCard(cardID,
                                                                 name: name,
                                                                 billingAddress: billingAddress)
    switch status {
    case .pending(operationID: let operationID):
        // Handle pending scenario
        print(operationID)
    case .successful(operationID: let operationID):
        // Handle successful scenario
        print(operationID)
    }
} catch let error {
    // Handle the error.
}

Use updateCard only for data attached to one card.

If the end user profile changes, use updateConsumer instead.

PreviousUpdate Click to Pay profiles NextOpt out cards from Click to Pay

Last updated 2 months ago

Was this helpful?