Push to the digital wallet

Use this guide to push a card from the issuer application to a digital wallet application using the D1 SDK. Supported wallet applications are Google Pay, Samsung Pay, and Apple Pay.

Call this API when the end user taps Add to wallet and the card digitization state is NOT_DIGITIZED. To retrieve the state, see Get the card digitization state.

Overview

The issuer application calls the D1 SDK addDigitalCardToOEM() API to start the push provisioning flow. The D1 SDK and D1 backend:

Validate the end user and card data stored in D1.
Prepare the payload required by the wallet application and TSP.
Call the wallet application to start Tokenization.
Return the result so the issuer application can update the UI.

Only call addDigitalCardToOEM() after the D1 SDK returns NOT_DIGITIZED from getCardDigitizationState().
For Google Pay on Android, you must implement onActivityResult so that the wallet result is forwarded back to the D1 SDK.
Starting June 10, 2024, Google Wallet requires Android 9 or higher.

Flow

Sequence diagram

Prerequisites

The end user account and card are registered in D1.
The D1 SDK is initialized.
The issuer application has called the D1 SDK login API.

High-level sequence for pushing a card to a digital wallet

Platform integration

For Android 2.4.0 and later, use D1PushWallet.addDigitalCardToOEM().

//activity: Current activity for OEM Push Provisioning.
//cardID: Card ID received.
fun pushCardToWallet_v2_4_0(d1Task: D1Task, cardID: String, activity: Activity) {
    val wallet = OEMPayType.GOOGLE_PAY //GOOGLE_PAY, SAMSUNG_PAY, NONE
    val callback: D1Task.Callback<Any?> = object : D1Task.Callback<Any?> {

        override fun onSuccess(data: Any?) {
            // Handles the `digitalCardStatus` object from the server.
        }

        override fun onError(exception: D1Exception) {
            // Refer to D1 SDK Integration – Error Management section.
        }
    }
    val d1PushWallet : D1PushWallet = d1Task.d1PushWallet
    d1PushWallet.addDigitalCardToOEM(cardID, wallet, activity, callback)
}

// NOTE: Implement the `onActivityResult` method to forward all the callback events to the SDK.

// Activity Result: The `onActivityResult` method is received in the issuer app from GPay SDK, and passed back to D1 SDK to handle the result.
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    d1Task.handleCardResult(requestCode, resultCode, data);
}

On iOS, use addDigitalCardToOEM(_:viewController:completion:).

let cardID = "" // Obtained by the issuer application, for example from your backend
let viewController = /* current UIViewController instance presenting the Apple Pay UI */

d1Task.addDigitalCardToOEM(cardID, viewController: viewController) { error in
    if let error = error {
        // Refer to the D1 SDK integration error management section
    } else {
        // Update the UI, for example confirm that the card was added to Apple Wallet
    }
}

For complete D1 SDK details, see the API reference.

PreviousGet the card digitization state NextApple wallet extension

Last updated 2 months ago

Was this helpful?

//activity: Current activity for OEM Push Provisioning.
//cardID: Card ID received.
fun pushCardToWallet_v2_4_0(d1Task: D1Task, cardID: String, activity: Activity) {
    val wallet = OEMPayType.GOOGLE_PAY //GOOGLE_PAY, SAMSUNG_PAY, NONE
    val callback: D1Task.Callback<Any?> = object : D1Task.Callback<Any?> {

        override fun onSuccess(data: Any?) {
            // Handles the `digitalCardStatus` object from the server.
        }

        override fun onError(exception: D1Exception) {
            // Refer to D1 SDK Integration – Error Management section.
        }
    }
    val d1PushWallet : D1PushWallet = d1Task.d1PushWallet
    d1PushWallet.addDigitalCardToOEM(cardID, wallet, activity, callback)
}

// NOTE: Implement the `onActivityResult` method to forward all the callback events to the SDK.

// Activity Result: The `onActivityResult` method is received in the issuer app from GPay SDK, and passed back to D1 SDK to handle the result.
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    d1Task.handleCardResult(requestCode, resultCode, data);
}