CardDigitizationService Actor Reference


                    
                    
                    EligibilityAcceptableData

Data returned by checkEligibility(_:instrumentData:) method.

Declaration

Swift

public struct EligibilityAcceptableData : Sendable

Return Value

termsAndConditions and issuerData


                    
                    
                    eventStream

Asynchronous

Awaits the result from digitizeCard(withTNC:pushToken:language:authenticationToken:).

Declaration

Swift

public var eventStream: AsyncStream<State> { get async }

Return Value

Stream of State.


                    
                    
                    init()

Initializes the Card Digitization service.

Declaration

Swift

public init()


                    
                    
                    checkEligibility(_:instrumentData:)

Asynchronous

Performs an eligibility check for card provisioning.

This method is the first step in the card provisioning flow, where the cardholder initiates digitization from the issuer’s application. It checks if a card is eligible for digitization by sending a request to the server with the provided eligibility data and InstrumentData

Declaration

Swift

public func checkEligibility(
    _ eligibilityData: EligibilityData,
    instrumentData: InstrumentData
) async throws -> EligibilityAcceptableData

Parameters

`eligibilityData`	`EligibilityData` A struct containing the details required for the eligibility check.
`instrumentData`	`InstrumentData` A struct containing the encrpted card details.

Return Value

EligibilityAcceptableData.

Throws:

networkError if there is a network connectivity error or connection timeout.

serverError(_:) if there is any server error or communication error.

clientError(_:) if the eligibilityData or instrumentData are invalid.

fpanNotEligible if the FPAN is not eligible.

cardAlreadyProvisionedInWallet if card is already provisioned in wallet.

unknownIssuerID if issuer ID is unknown.

unknownCardID if card ID is unknown.

unknownWalletProviderID if wallet provider ID is unknown.

unknownBIN if BIN is unknown.

unknownCardProduct if card product is unknown.

unknownWalletApplicationID if wallet application ID is unknown.

cardProductNotSupported if card product is not supported.

incorrectCVV if CVV is incorrect.

deviceNotEligible if device is not eligible.

exceedCountForCardProvisioning if card provisioning count has exceeded.

unexpectedInternalError if there is an unexpencted internal error.

externalSystemUnavailable if external system is unavailable.

operationAlreadyOngoing if there is an ongoing operation.

invalidCardData if card data is invalid.

resourceNotFound if the requested resource cannot found.

Else, unknown(_:) if an unexpected error encountered.


                    
                    
                    checkEligibility(_:pushSessionID:)

Asynchronous

Eligibility check with pushSessionID has to be used in the Backend-to-Backend Push Card Enrollment. The wallet server will first push the payment instrument to the Thales server. In return, the Thales server will return the pushSessionID to be passed to thecheckEligibility API to check if payment instrument is eligible for digitization.

Since

7.3.0

Declaration

Swift

public func checkEligibility(
    _ eligibilityData: EligibilityData,
    pushSessionID: String
) async throws -> EligibilityAcceptableData

Parameters

`eligibilityData`	`EligibilityData` A struct containing the details required for the eligibility check.
`pushSessionID`	The push session ID (0–255 chars) received from TSHPay backend to the issuer.

Return Value

EligibilityAcceptableData.

Throws:

networkError if there is a network connectivity error or connection timeout.

serverError(_:) if there is any server error or communication error.

clientError(_:) if the eligibilityData or pushSessionID are invalid.

unknownWalletApplicationID if wallet application ID is unknown.

deviceNotEligible if device is not eligible.

exceedCountForCardProvisioning if card provisioning count has exceeded.

unexpectedInternalError if there is an unexpencted internal error.

externalSystemUnavailable if external system is unavailable.

invalidPushSessionID if pushSessionID is not found or invalid

Else, unknown(_:) if an unexpected error encountered.


                    
                    
                    digitizeCard(withTNC:pushToken:language:authenticationToken:)

Asynchronous

Begins the digitization process. When checkEligibility(_:instrumentData:) returns TermsAndConditions in EligibilityAcceptableData, MPA has to accept it and pass it as a parameter to start the card digitization process. Application should call eventStream to handle each event.

Throws:

networkError if there is a network connectivity error or connection timeout.

serverError(_:) if there is a server error or an internal error.

clientError(_:) if the request contains invalid data.

fpanNotEligible if the FPAN is not eligible.

exceededCountForCardProvisioning if card provisioning count has exceeded.

cardStateDoesNotAllowRequestedOperation if card state does not allow requested operation.

invalidCardData if card data is invalid.

operationFailed if operation failed.

unknownDeviceID if device ID is unknown.

unknownIssuerID if issuer ID is unknown.

unknownCardID if card ID is unknown.

unknownWalletProviderID if wallet provider ID is unknown.

unknownWalletID if wallet ID is unknown.

unknownDigitalCardID if digital card ID is unknown.

unknownCorrelationID if correlation ID is unknown.

unknownCardProduct if card product is unknown.

unexpectedInternalError if there is an unexpencted internal error.

provisioningNotAllowed if card provisioning is not allowed.

incorrectOTPMaxTryExceeded if incorrect OTP mac try is exceeded.

incorrectAuthenticationToken if authentication token is incorrect.

idvMethodNotAvailable if IDV method is not available.

externalSystemUnavailable if external System is not available.

operationAlreadyOngoing if there is an ongoing operation.

missingRequiredParameter if there is a missing required parameter.

web3DSAuthenticationError if there is a 3DS authentication error.

web3DSDataError if there is a 3DS data error.

Else, unknown(_:) if an unexpected error encountered.

Declaration

Swift

public func digitizeCard(
    withTNC tnc: TermsAndConditionsSession,
    pushToken: String,
    language: String,
    authenticationToken: Data? = nil
) async throws

Parameters

`tnc`	The value from MPA to accept the termsAndConditions.
`pushToken`	fcm token
`language`	The ISO 639 language code chosen by the user when the mobile wallet is installed
`authenticationToken`	token used for green card enrollment flow or null otherwise.


                    
                    
                    getPendingCardActivationSession(forDigitalCardID:)

Asynchronous

Returns the PendingCardActivationSession object. It is used to resume the card activation process.

Declaration

Swift

public func getPendingCardActivationSession(
    forDigitalCardID digitalCardID: String
) async -> PendingCardActivationSession?


                    
                    
                    Error

Card enrollment service error

Declaration

Swift

public enum Error : Sendable, Swift.Error


                    
                    
                    EligibleError

Card Digitization Check eligibility error: Returns the reason why the elibility check failed.

Declaration

Swift

public enum EligibleError : Sendable, CaseIterable, Swift.Error


                    
                    
                    DigitizeError

Card Digitization error: Returns the reason for card digitization failure.

Declaration

Swift

public enum DigitizeError : Sendable, CaseIterable, Swift.Error


                    
                    
                    IDVMethod

The different verification/authentication methods used to verify the cardholder’s identify.

Declaration

Swift

public struct IDVMethod : Sendable


                    
                    
                    IDVMethodSelector

The object used to list and select IDV method for card activation.

Declaration

Swift

public struct IDVMethodSelector : Sendable


                    
                    
                    TermsAndConditions

TermsAndConditions provides the contents in the Terms and Conditions and the option to accept it.

Declaration

Swift

public struct TermsAndConditions : Sendable


                    
                    
                    PendingCardActivation

PendingCardActivation indicates the card which was previously interrupted during activation.

Declaration

Swift

public struct PendingCardActivation : Sendable


                    
                    
                    PendingCardActivationSession

PendingCardActivationSession indicates the card which the Id&V has not been performed.

Declaration

Swift

public struct PendingCardActivationSession : Sendable


                    
                    
                    EligibilityData

EligibilityData is used by MPA to provide information associated with the card digitization.

Declaration

Swift

public struct EligibilityData : Sendable


                    
                    
                    EligibilityDataComponents

Components used to build EligibilityData.

Declaration

Swift

public struct EligibilityDataComponents : Sendable


                    
                    
                    InstrumentData

InstrumentData is used by MPA for checkEligibility(_:instrumentData:).

Declaration

Swift

public struct InstrumentData : Sendable, Codable


                    
                    
                    InstrumentDataComponents

Components of InstrumentData.

Declaration

Swift

public struct InstrumentDataComponents : Sendable


                    
                    
                    IssuerData

IssuerData contains the information of the issuer.

Declaration

Swift

public struct IssuerData : Sendable


                    
                    
                    State

State of the card digitization process that is initiated with digitizeCard(withTNC:pushToken:language:authenticationToken:)

Declaration

Swift

public enum State : Sendable


                    
                    
                    TermsAndConditionsSession

TermsAndConditionsSession provides the correlation ID and timestamp of the session.

Declaration

Swift

public struct TermsAndConditionsSession : Sendable