Tokenization API

Filters for tokenizations associated with a specific account.

Parameters

account_token

uuid
Filters for tokenizations associated with a specific card.

begin

date
Filter for tokenizations created after this date.

card_token

uuid
Filters for tokenizations associated with a specific card.

end

date
Filter for tokenizations created before this date.

tokenization_channel

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

Allowed:
DIGITAL_WALLET``MERCHANT``ALL

ending_before

string
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

integer

1 to 100

Defaults to 50
Page size (for pagination).

starting_after

string
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.

Responses

200 OK

Object

• data: array of objects

Data Object

• account_token uuid (required)
  The account token associated with the card being tokenized.
• card_token uuid (required)
  The card token associated with the card being tokenized.
• created_at date-time (required)
  Date and time when the tokenization first occurred. UTC time zone.
• device_id string | null
  The device identifier associated with the tokenization.
• digital_card_art_token uuid | null
  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.

events

• array of objects: A list of events related to the tokenization.

Event Object

• created_at date-time
  Date and time when the tokenization event first occurred. UTC time zone.
• result string enum
  Enum representing the result of the tokenization event
  APPROVED``DECLINED``NOTIFICATION_DELIVERED``REQUIRE_ADDITIONAL_AUTHENTICATION``TOKEN_ACTIVATED``TOKEN_CREATED``TOKEN_DEACTIVATED``TOKEN_DELETED_FROM_CONSUMER_APP``TOKEN_INACTIVE``TOKEN_STATE_UNKNOWN``TOKEN_SUSPENDED``TOKEN_UPDATED
• token uuid
  Globally unique identifier for a Tokenization Event
• type string enum
  Enum representing the type of tokenization event that occurred
  TOKENIZATION_2FA``TOKENIZATION_AUTHORIZATION``TOKENIZATION_DECISIONING``TOKENIZATION_ELIGIBILITY_CHECK``TOKENIZATION_UPDATED

tokenization_decline_reasons

• array of objects: List of reasons why the tokenization was declined

tokenization_tfa_reasons

• array of objects: List of reasons why two-factor authentication was required

rule_results

• array of objects: Results from rules that were evaluated for this tokenization

Rule Result Object

• auth_rule_token nullstring (required)
  The Auth Rule Token associated with the rule. If this is set to null, then the result was not associated with a customer-configured rule.
• result string enum (required)
  The result associated with this rule APPROVED``DECLINED``REQUIRE_TFA``ERROR
• name nullstring (required)
  The name for the rule, if any was configured
• explanation nullstring (required)
  A human-readable explanation outlining the motivation for the rule's result

status

string enum (required)
The status of the tokenization request
ACTIVE``DEACTIVATED``INACTIVE``PAUSED``PENDING_2FA``PENDING_ACTIVATION``UNKNOWN

• token uuid (required)
  Globally unique identifier for a Tokenization
• token_requestor_name
  Digital wallet type or Merchant name
  enum (required)
  The entity that requested the tokenization.

Digital wallet type

AMAZON_ONE``ANDROID_PAY``APPLE_PAY``FACEBOOK``FITBIT_PAY``GARMIN_PAY``GOOGLE_PAY``MICROSOFT_PAY``NETFLIX``SAMSUNG_PAY``UNKNOWN``VISA_CHECKOUT

• token_unique_reference string (required)
  The network's unique reference for the tokenization.
• dpan string | null (required)
  The dynamic pan assigned to the token by the network.
• payment_account_reference_id string | null
  The network's unique reference for the card that is tokenized.
• tokenization_channel string enum (required)
  The channel through which the tokenization was made. DIGITAL_WALLET``MERCHANT
• updated_at date-time (required)
  Latest date and time when the tokenization was updated. UTC time zone.

has_more

boolean
Indicates if there are more results available.

Sample Request

curl --request GET \
     --url 'https://sandbox.lithic.com/v1/tokenizations?page_size=50' \
     --header 'accept: application/json'

Sample Response

{
  "data": [
    {
      "account_token": "61c3acef-3c2c-4d61-9352-941397b92ca3",
      "card_token": "16a410c9-7f5c-43e9-8108-bb8a72c063f7",
      "created_at": "2023-08-28T15:57:14.578051",
      "events": [
        {
          "created_at": "2023-09-13T16:01:13.643241",
          "result": "TOKEN_ACTIVATED",
          "token": "a690b617-d3d4-4976-82f6-901f817ad98a",
          "type": "TOKENIZATION_UPDATED"
        },
        {
          "created_at": "2023-09-13T16:01:13.643241",
          "result": "APPROVED",
          "token": "2b2a1038-45f3-42e4-98bb-e745be3f1de1",
          "type": "TOKENIZATION_AUTHORIZATION",
          "tokenization_decline_reasons": [],
          "tokenization_tfa_reasons": [],
          "rule_results": []
        }
      ],
      "status": "ACTIVE",
      "token": "3e9a10da-11be-4a62-a510-d43548bfcec1",
      "token_requestor_name": "APPLE_PAY",
      "token_unique_reference": "DM4MMC0000332872ef1029f38fa0184b5c9260383da192b22",
      "tokenization_channel": "DIGITAL_WALLET",
      "dpan": "5489123487251234",
      "device_id": "ba6f05c312d4a5789b2e04f05c1f9d3b81GJ4AG1",
      "payment_account_reference_id": "50019T0AL7DEFGJ4AGGT8BQDOABCD",
      "updated_at": "2023-08-28T15:57:14.578051"
    }
  ],
  "has_more": false
}