Enroll cards by D1 SDK

Overview

This page explains how the issuer application can enroll a card and its end user in Click to Pay by using the D1 SDK.

The issuer application calls enrol, which triggers the same backend Click to Pay enrollment operation as the issuer backend calling the D1 API.

Use this SDK flow when you want the end user to initiate Click to Pay enrollment directly in the issuer application user interface while D1 orchestrates the backend interactions with the Click to Pay directories and the payment network.

Flow

The following diagram illustrates the main steps of the SDK Click to Pay enrollment flow:

Sequence diagram

Since D1 SDK 4.2.0, with the addition of the backend flow, the enrol (Android / iOS) API is also available through D1 SDK.

Prerequites

The SDK flow has the same prerequisites and limitations as the backend flow. Please refer to prerequisites.

The following sequence diagram shows the flow initiated from the issuer application:

Key points

The issuer application must provide the consumer information. See ConsumerInfo (SDK API).
The enrollment is an asynchronous operation. The final result can be retrieved by:
- using the callback status (SUCCESSFUL or PENDING),
- calling the Get Operation endpoint available in the D1 API, or
- activating D1 notifications. In the SDK flow, the issuer can also activate in-app push notifications in addition to issuer backend notifications.
The TSP associated with the payment network triggers a typical digitization flow.

Handle Click to Pay push notifications

Before the issuer application can receive Click to Pay enrollment notifications from the D1 backend, ensure that push notifications are set up as follows:

Configure push notifications

Perform the necessary actions as outlined in push notification configuration.

Register push notification token

Register for message notifications

Once these steps are completed, the issuer application can start receiving push notifications such as clickToPayEnrolment and clickToPayOptOutCard.

When D1 SDK receives a push notification of type clickToPayEnrolment (Android / iOS) or clickToPayOptOutCard (Android / iOS), the issuer application checks the notification to determine whether the Click to Pay enrollment operation or opt-out is successful.

SDK API

fun enrolClick2Pay(d1Task: D1Task, cardID: String) {
    // Consumer info received from user input or backend.
    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?) {
                // Enrol 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().enrol(
        cardID,
        consumerInfo,
        "Bella Lin",
        billingAddress,
        callback
    )
}

public void enrolClick2Pay(@NonNull D1Task d1Task, @NonNull String cardID) {
    // Consumer info received from user input or backend.
    ConsumerInfo consumerInfo = new ConsumerInfo(
        "Bella", 
        "middle name", 
        "Lin", 
        "en-US", 
        "+65", 
        "99998888", 
        "email@thalesgroup.com"
    );
    BillingAddress billingAddress = new BillingAddress("CZ");

    D1Task.Callback<Status> callback = new D1Task.Callback<Status>() {
        @Override
        public void onSuccess(Status data) {
            // Enrol to Click to Pay success
            Status status = data;
            String operationID = data.operationID;
        }

        @Override
        public void onError(D1Exception exception) {
            // Refer to D1 SDK Integration – Error Management section.
        }
    };
    d1Task.getClickToPayService().enrol(
            cardID,
            consumerInfo,
            "Bella Lin",
            billingAddress,
            callback);
}

let cardID = ""
let name = "Bella Lin"
let consumerInfo = ConsumerInfo(firstName: "Bella",
                                middleName: nil,
                                lastName: "Lin",
                                language: "en-US",
                                phoneNumberCountryCode: "+65",
                                phoneNumber: "99998888",
                                email: "email@thalesgroup.com")

let billingAddress = BillingAddress(line1: "1230 Rue de Rivoli",
                                    line2: nil,
                                    line3: nil,
                                    city: "Paris",
                                    state: "75",
                                    zipCode: "75000",
                                    countryCode: "FR")
do {
    let status = try await d1Task.clickToPayService().enrol(cardID,
                                                            consumerInfo: consumerInfo,
                                                            name: name,
                                                            billingAddress: billingAddress)
    switch status {
    case .pending(let operationID):
        // Enrol to Click to Pay is pending.
        print(operationID)
    case .successful(let operationID):
        // Enrol to Click to Pay successfully.
        print(operationID)
    }
} catch {
    // Handle the error.
}

PreviousEnroll cards by D1 API NextEnroll cards by auto enrollment

Last updated 2 months ago

Was this helpful?