TokenizationServiceAsync

Types

Link copied to clipboard
interface WithRawResponse

A view of TokenizationServiceAsync that provides access to raw HTTP responses for each method.

Functions

Link copied to clipboard
abstract suspend fun activate(params: TokenizationActivateParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun activate(tokenizationToken: String, requestOptions: RequestOptions)

open suspend fun activate(tokenizationToken: String, params: TokenizationActivateParams = TokenizationActivateParams.none(), requestOptions: RequestOptions = RequestOptions.none())

This endpoint is used to ask the card network to activate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network activates the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on digital wallet tokenizations with status INACTIVE, PENDING_ACTIVATION, or PENDING_2FA. This will put the tokenization in an active state, and transactions will be allowed. Reach out at lithic.com/contact for more information.

Link copied to clipboard
abstract suspend fun deactivate(params: TokenizationDeactivateParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun deactivate(tokenizationToken: String, requestOptions: RequestOptions)

open suspend fun deactivate(tokenizationToken: String, params: TokenizationDeactivateParams = TokenizationDeactivateParams.none(), requestOptions: RequestOptions = RequestOptions.none())

This endpoint is used to ask the card network to deactivate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network deactivates the tokenization, the state will be updated and a tokenization.updated event will be sent. Authorizations attempted with a deactivated tokenization will be blocked and will not be forwarded to Lithic from the network. Deactivating the token is a permanent operation. If the target is a digital wallet tokenization, it will be removed from its device. Reach out at lithic.com/contact for more information.

Link copied to clipboard
open suspend fun list(requestOptions: RequestOptions): TokenizationListPageAsync

abstract suspend fun list(params: TokenizationListParams = TokenizationListParams.none(), requestOptions: RequestOptions = RequestOptions.none()): TokenizationListPageAsync

List card tokenizations

Link copied to clipboard
abstract suspend fun pause(params: TokenizationPauseParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun pause(tokenizationToken: String, requestOptions: RequestOptions)

open suspend fun pause(tokenizationToken: String, params: TokenizationPauseParams = TokenizationPauseParams.none(), requestOptions: RequestOptions = RequestOptions.none())

This endpoint is used to ask the card network to pause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network pauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status ACTIVE. A paused token will prevent merchants from sending authorizations, and is a temporary status that can be changed. Reach out at lithic.com/contact for more information.

Link copied to clipboard
abstract suspend fun resendActivationCode(params: TokenizationResendActivationCodeParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun resendActivationCode(tokenizationToken: String, requestOptions: RequestOptions)

open suspend fun resendActivationCode(tokenizationToken: String, params: TokenizationResendActivationCodeParams = TokenizationResendActivationCodeParams.none(), requestOptions: RequestOptions = RequestOptions.none())

This endpoint is used to ask the card network to send another activation code to a cardholder that has already tried tokenizing a card. A successful response indicates that the request was successfully delivered to the card network. The endpoint may only be used on Mastercard digital wallet tokenizations with status INACTIVE, PENDING_ACTIVATION, or PENDING_2FA. The network will send a new activation code to the one of the contact methods provided in the initial tokenization flow. If a user fails to enter the code correctly 3 times, the contact method will not be eligible for resending the activation code, and the cardholder must restart the provision process. Reach out at lithic.com/contact for more information.

Link copied to clipboard
abstract suspend fun retrieve(params: TokenizationRetrieveParams, requestOptions: RequestOptions = RequestOptions.none()): Tokenization
open suspend fun retrieve(tokenizationToken: String, requestOptions: RequestOptions): Tokenization

open suspend fun retrieve(tokenizationToken: String, params: TokenizationRetrieveParams = TokenizationRetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): Tokenization

Get tokenization

Link copied to clipboard
abstract suspend fun simulate(params: TokenizationSimulateParams, requestOptions: RequestOptions = RequestOptions.none()): TokenizationSimulateResponse

This endpoint is used to simulate a card's tokenization in the Digital Wallet and merchant tokenization ecosystem.

Link copied to clipboard
abstract suspend fun unpause(params: TokenizationUnpauseParams, requestOptions: RequestOptions = RequestOptions.none())
open suspend fun unpause(tokenizationToken: String, requestOptions: RequestOptions)

open suspend fun unpause(tokenizationToken: String, params: TokenizationUnpauseParams = TokenizationUnpauseParams.none(), requestOptions: RequestOptions = RequestOptions.none())

This endpoint is used to ask the card network to unpause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network unpauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status PAUSED. This will put the tokenization in an active state, and transactions may resume. Reach out at lithic.com/contact for more information.

Link copied to clipboard
abstract suspend fun updateDigitalCardArt(params: TokenizationUpdateDigitalCardArtParams, requestOptions: RequestOptions = RequestOptions.none()): TokenizationUpdateDigitalCardArtResponse
open suspend fun updateDigitalCardArt(tokenizationToken: String, requestOptions: RequestOptions): TokenizationUpdateDigitalCardArtResponse

open suspend fun updateDigitalCardArt(tokenizationToken: String, params: TokenizationUpdateDigitalCardArtParams = TokenizationUpdateDigitalCardArtParams.none(), requestOptions: RequestOptions = RequestOptions.none()): TokenizationUpdateDigitalCardArtResponse

This endpoint is used update the digital card art for a digital wallet tokenization. A successful response indicates that the card network has updated the tokenization's art, and the tokenization's digital_cart_art_token field was updated. The endpoint may not be used on tokenizations with status DEACTIVATED. Note that this updates the art for one specific tokenization, not all tokenizations for a card. New tokenizations for a card will be created with the art referenced in the card object's digital_card_art_token field. Reach out at lithic.com/contact for more information.

Link copied to clipboard

Returns a view of this service with the given option modifications applied.

Link copied to clipboard

Returns a view of this service that provides access to raw HTTP responses for each method.