Use correlationID

Get and set a correlation ID for Tokenization tracking.

Overview

Each Tokenization process has an associated correlationID that you can share with Thales to help with troubleshooting.

This identifier can be obtained in two ways:

• From a successful eligibility check or from a Tokenization error.
• You can also assign your own custom correlationID when calling checkEligibility() .

Available since: 6.15.0

SDK integration

Get correlationID from checkEligibility()

• After successful checkEligibility()

  • After a successful eligibility check, read acceptanceData.correlationID.
  • Store this value if you need to trace the same Tokenization process later.
• After error on checkEligibility()

  • Read or store correlationID as soon as the error is caught.

The following example explains how to get correlationID checkEligibility() :

mgCardEnrollmentService.checkEligibility(
    eligibilityData,
    instrumentData,
    object : CardEligibilityListener {
        override fun onSuccess(
            termsAndConditions: TermsAndConditions,
            issuerData: IssuerData
        ) {
            val correlationId = termsAndConditions.correlationId
            Log.d(TAG, "Correlation ID: $correlationId")
        }

        override fun onError(error: MobileGatewayError) {
            val correlationId = error.correlationId
            Log.e(TAG, "Digitization failed. Correlation ID: $correlationId")
        }
    }
)

ProvisioningServiceError also provides getCorrelationId().

Set a custom correlationID

You can set correlationID only in checkEligibility().

The following checkEligibility() variants support this parameter.

Use a custom value when you want to trace a Tokenization process across the issuer backend, the digital wallet application, and Thales logs.

You can also use your own identifier format, for example:

ORDER-12345-SESSION-67890

Set a custom correlationID with instrument data

val correlationId = UUID.randomUUID().toString()

mgCardEnrollmentService.checkEligibility(
    eligibilityData,
    instrumentData,
    correlationId,
    object : CardEligibilityListener {
        override fun onSuccess(
            termsAndConditions: TermsAndConditions,
            issuerData: IssuerData
        ) {
            val returnedCorrelationId = termsAndConditions.correlationId
            Log.d(TAG, "Digitization correlation ID: $returnedCorrelationId")
        }

        override fun onError(error: MobileGatewayError) {
            val returnedCorrelationId = error.correlationId
            Log.e(TAG, "Digitization failed. Correlation ID: $returnedCorrelationId")
        }
    }
)

Set a custom correlationID with a pushSessionID

mgCardEnrollmentService.checkEligibility(
    eligibilityData,
    pushSessionId,
    correlationId,
    object : CardEligibilityListener {
        override fun onSuccess(
            termsAndConditions: TermsAndConditions,
            issuerData: IssuerData
        ) {
            val trackingId = termsAndConditions.correlationId
            Log.d(TAG, "Push enrollment correlation ID: $trackingId")
        }

        override fun onError(error: MobileGatewayError) {
            val trackingId = error.correlationId
            Log.e(TAG, "Push enrollment failed. Correlation ID: $trackingId")
        }
    }
)

Related pages

• Check card eligibility
• Green flow digitization
• Yellow flow digitization
• Digitizing a card