Skip to content

Tokenizations

Tokenizations

Last updated: (timestamp)

Tokenizations

tokenizations
Methods
Get a single card tokenization
get/v1/tokenizations/{tokenization_token}

Get tokenization

Get a card's tokenizations
get/v1/tokenizations

List card tokenizations

Activate a card tokenization
post/v1/tokenizations/{tokenization_token}/activate

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.

Deactivate a card tokenization
post/v1/tokenizations/{tokenization_token}/deactivate

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.

Pause a card tokenization
post/v1/tokenizations/{tokenization_token}/pause

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.

Resend activation code for a card tokenization
post/v1/tokenizations/{tokenization_token}/resend_activation_code

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.

Simulate a card's tokenization
post/v1/simulate/tokenizations

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

Unpause a card tokenization
post/v1/tokenizations/{tokenization_token}/unpause

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.

Update digital card art for a card tokenization
post/v1/tokenizations/{tokenization_token}/update_digital_card_art

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.

Domain Types
Tokenization
Tokenizationobject
ShowShow
tokenstring

Globally unique identifier for a Tokenization

formatuuid
account_tokenstring

The account token associated with the card being tokenized.

formatuuid
card_tokenstring

The card token associated with the card being tokenized.

formatuuid
created_atstring

Date and time when the tokenization first occurred. UTC time zone.

formatdate-time
dpanstring

The dynamic pan assigned to the token by the network.

statusenum
Accepts one of the following: "ACTIVE", "DEACTIVATED", "INACTIVE", 4 more

The status of the tokenization request

Hide ParametersShow Parameters
"ACTIVE"
"DEACTIVATED"
"INACTIVE"
"PAUSED"
"PENDING_2FA"
"PENDING_ACTIVATION"
"UNKNOWN"
token_requestor_nameenum
Accepts one of the following: "AMAZON_ONE", "ANDROID_PAY", "APPLE_PAY", 8 more

The entity that requested the tokenization. Represents a Digital Wallet or merchant.

Hide ParametersShow Parameters
"AMAZON_ONE"
"ANDROID_PAY"
"APPLE_PAY"
"FACEBOOK"
"FITBIT_PAY"
"GARMIN_PAY"
"MICROSOFT_PAY"
"NETFLIX"
"SAMSUNG_PAY"
"UNKNOWN"
"VISA_CHECKOUT"
token_unique_referencestring

The network's unique reference for the tokenization.

tokenization_channelenum
Accepts one of the following: "DIGITAL_WALLET", "MERCHANT"

The channel through which the tokenization was made.

Hide ParametersShow Parameters
"DIGITAL_WALLET"
"MERCHANT"
updated_atstring

Latest date and time when the tokenization was updated. UTC time zone.

formatdate-time
digital_card_art_tokenstring
optional

Specifies the digital card art displayed in the user’s digital wallet after tokenization. This will be null if the tokenization was created without an associated digital card art. See Flexible Card Art Guide.

formatuuid
eventsarray of object
optional

A list of events related to the tokenization.

Hide ParametersShow Parameters
tokenstring
optional

Globally unique identifier for a Tokenization Event

formatuuid
created_atstring
optional

Date and time when the tokenization event first occurred. UTC time zone.

formatdate-time
resultenum
optional
Accepts one of the following: "APPROVED", "DECLINED", "NOTIFICATION_DELIVERED", 8 more

Enum representing the result of the tokenization event

Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
"NOTIFICATION_DELIVERED"
"REQUIRE_ADDITIONAL_AUTHENTICATION"
"TOKEN_ACTIVATED"
"TOKEN_CREATED"
"TOKEN_DEACTIVATED"
"TOKEN_INACTIVE"
"TOKEN_STATE_UNKNOWN"
"TOKEN_SUSPENDED"
"TOKEN_UPDATED"
typeenum
optional
Accepts one of the following: "TOKENIZATION_2FA", "TOKENIZATION_AUTHORIZATION", "TOKENIZATION_DECISIONING", 2 more

Enum representing the type of tokenization event that occurred

Hide ParametersShow Parameters
"TOKENIZATION_2FA"
"TOKENIZATION_AUTHORIZATION"
"TOKENIZATION_DECISIONING"
"TOKENIZATION_ELIGIBILITY_CHECK"
"TOKENIZATION_UPDATED"
payment_account_reference_idstring
optional

The network's unique reference for the card that is tokenized.