core/com.paysafe.wallet.android.core.card/CardService

CardService

Interface for card operations.

Functions

abstract suspend fun activate(cardId: String, request: CardActivationRequest): Card

Activates a prepaid PHYSICAL card by cardId (UUID).

open fun activateAsync(cardId: String, request: CardActivationRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<Card>)

Asynchronously Activates a prepaid PHYSICAL card by cardId (UUID).

authenticateScaEvent

abstract fun authenticateScaEvent(fragment: Fragment, scaDetails: ScaAuthenticationEventRequest)

create

abstract suspend fun create(request: CardRequest): Card

Create a new Physical or Virtual prepaid card for a customer, based on the provided programName.

createAsync

open fun createAsync(request: CardRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<Card>)

Asynchronously Creates a new Physical or Virtual prepaid card for a customer, based on the provided programName.

get

abstract suspend fun get(cardId: String, include: List<CardIncludesParam>? = null): Card

This endpoint provides detailed information about specific Card by cardId.

getAll

abstract suspend fun getAll(parameters: CardParameters? = null): CardList

Retrieve a list of all prepaid cards for the current customer. The result list can be filtered by card status and card type.

getAllAsync

open fun getAllAsync(parameters: CardParameters?, cancellationSignal: CancellationSignal?, callback: WalletCallback<CardList>)

Asynchronously retrieves list of all customer cards based on the provided parameters.

getAsync

open fun getAsync(cardId: String, include: List<CardIncludesParam>?, cancellationSignal: CancellationSignal?, callback: WalletCallback<Card>)

Asynchronously provides detailed information about specific Card by cardId.

getPrograms

abstract suspend fun getPrograms(): ProgramList

Retrieve eligible programs for a customer.

getProgramsAsync

open fun getProgramsAsync(cancellationSignal: CancellationSignal?, callback: WalletCallback<ProgramList>)

Asynchronously Retrieve eligible programs for a customer.

getSecureDetailsFragment

abstract fun getSecureDetailsFragment(request: CardSecureDetailsRequest): Fragment

Create a new instance of a fragment for viewing card details. Attach the fragment to an activity using the FragmentManager. The sensitive card details will be loaded automatically upon fragment creation.
Merchants that are not PCI DSS Level 1 certified should use this method to display card sensitive information.

getSecureDetailsViews

abstract suspend fun getSecureDetailsViews(request: CardSecureDetailsViewRequest): CardSecureDetailsViews

Obtain custom Android Views displaying card sensitive details.

getSecureDetailsViewsAsync

open fun getSecureDetailsViewsAsync(request: CardSecureDetailsViewRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<CardSecureDetailsViews>)

Obtain custom Android Views displaying card sensitive details.

getSecurePinView

abstract suspend fun getSecurePinView(request: CardSecureViewRequest): View

Obtain a custom Android View displaying a card PIN code.

getSecurePinViewAsync

open fun getSecurePinViewAsync(request: CardSecureViewRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<View>)

Obtain a custom Android View displaying a card PIN code.

listenScaAuthenticationEvent

abstract fun listenScaAuthenticationEvent(fragment: Fragment, listener: ScaAuthenticationEventListener)

resetVerificationAttempts

abstract suspend fun resetVerificationAttempts(cardId: String, request: ResetCardVerificationAttemptsRequest): CardAttemptResetInfo

Resets the verification attempt counters for both PIN/CVV on a prepaid card. It clears failed attempts, restoring the card's ability to authorize transactions.

resetVerificationAttemptsAsync

open fun resetVerificationAttemptsAsync(cardId: String, request: ResetCardVerificationAttemptsRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<CardAttemptResetInfo>)

Asynchronously Resets the verification attempt counters for both PIN/CVV on a prepaid card. It clears failed attempts, restoring the card's ability to authorize transactions.

tokenize

abstract suspend fun tokenize(cardId: String, cardTokenizationRequest: CardTokenizationRequest): CardTokenization

Tokenize given card for specific mobile wallet.

tokenizeAsync

open fun tokenizeAsync(cardId: String, cardTokenizationRequest: CardTokenizationRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<CardTokenization>)

Asynchronously tokenizes given card for specific mobile wallet.

update

abstract suspend fun update(cardId: String, request: CardUpdateRequest): Card

The endpoint enables updating a card’s state like status and PIN.

updateAsync

open fun updateAsync(cardId: String, request: CardUpdateRequest, cancellationSignal: CancellationSignal?, callback: WalletCallback<Card>)

Asynchronously Updates a card’s state like status and PIN.

updateTokenizationStatus

abstract suspend fun updateTokenizationStatus(cardId: String, mobileWalletTokenization: MobileWalletTokenization): MobileWalletTokenization

Updates card tokenization status by which tokenization can be marked as COMPLETED. Tokenization marked as COMPLETED means that the given card will be not able to be tokenized for the specific device and profile (in case of Google Pay).

updateTokenizationStatusAsync

open fun updateTokenizationStatusAsync(cardId: String, mobileWalletTokenization: MobileWalletTokenization, cancellationSignal: CancellationSignal?, callback: WalletCallback<MobileWalletTokenization>)

Asynchronously updates card tokenization status by which tokenization can be marked as COMPLETED. Tokenization marked as COMPLETED means that the given card will be not able to be tokenized for the specific device and profile (in case of Google Pay).