Lithic API Documentation | Tokenizations › Get A Card S Tokenizations

Tokenizations

tokenizations

Methods

Simulate A Card S Tokenization ->

Tokenization

post/v1/simulate/tokenizations

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

Get A Card S Tokenizations -> CursorPage<

Tokenization

get/v1/tokenizations

List card tokenizations

query Parameters

account_token: string

Optional

(format: uuid)

Filters for tokenizations associated with a specific account.

begin: string

Optional

(format: date)

Filter for tokenizations created after this date.

card_token: string

Optional

(format: uuid)

Filters for tokenizations associated with a specific card.

end: string

Optional

(format: date)

Filter for tokenizations created before this date.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

tokenization_channel:

Optional

Filter for tokenizations by tokenization channel. If this is not specified, only DIGITAL_WALLET tokenizations will be returned.

"DIGITAL_WALLET"

"MERCHANT"

"ALL"

Response fields

data: Array<

Tokenization

Optional

has_more: boolean

Optional

Request example

curl https://api.lithic.com/v1/tokenizations \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "card_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "dpan": "dpan",
      "status": "ACTIVE",
      "token_requestor_name": "AMAZON_ONE",
      "token_unique_reference": "token_unique_reference",
      "tokenization_channel": "DIGITAL_WALLET",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "device_id": "device_id",
      "digital_card_art_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "events": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "created_at": "2019-12-27T18:11:19.117Z",
          "result": "APPROVED",
          "rule_results": [
            {
              "auth_rule_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "explanation": "explanation",
              "name": "name",
              "result": "APPROVED"
            }
          ],
          "tokenization_decline_reasons": [
            "ACCOUNT_SCORE_1"
          ],
          "tokenization_tfa_reasons": [
            "WALLET_RECOMMENDED_TFA"
          ],
          "type": "TOKENIZATION_2FA"
        }
      ],
      "payment_account_reference_id": "payment_account_reference_id"
    }
  ],
  "has_more": true
}

Get A Single Card Tokenization ->

Tokenization

get/v1/tokenizations/{tokenization_token}

Get tokenization

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.

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.

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.

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.

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.

Update Digital Card Art For A Card Tokenization ->

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

Device = { imei, ip_address, location }

DigitalWalletTokenMetadata = { payment_account_info, status, payment_app_instance_id, 2 more... }

Contains the metadata for the digital wallet being tokenized.

Tokenization = { token, account_token, card_token, 11 more... }

TokenizationDeclineReason = "ACCOUNT_SCORE_1" | "DEVICE_SCORE_1" | "ALL_WALLET_DECLINE_REASONS_PRESENT" | 10 more...

Reason code for why a tokenization was declined

TokenizationRuleResult = { auth_rule_token, explanation, name, 1 more... }

TokenizationTfaReason = "WALLET_RECOMMENDED_TFA" | "SUSPICIOUS_ACTIVITY" | "DEVICE_RECENTLY_LOST" | 12 more...

Reason code for why a tokenization required two-factor authentication

WalletDecisioningInfo = { account_score, device_score, recommended_decision, 1 more... }