Lithic · Schema

Tokenization

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name Type Description
account_token string The account token associated with the card being tokenized.
card_token string The card token associated with the card being tokenized.
created_at string Date and time when the tokenization first occurred. UTC time zone.
device_id stringnull The device identifier associated with the tokenization.
digital_card_art_token stringnull 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 A
events array A list of events related to the tokenization.
status string The status of the tokenization request
token string Globally unique identifier for a Tokenization
token_requestor_name object The entity that requested the tokenization. For digital wallets, this will be one of the defined wallet types. For merchant tokenizations, this will be a free-form merchant name string.
token_unique_reference string The network's unique reference for the tokenization.
dpan stringnull The dynamic pan assigned to the token by the network.
payment_account_reference_id stringnull The network's unique reference for the card that is tokenized.
tokenization_channel string The channel through which the tokenization was made.
updated_at string Latest date and time when the tokenization was updated. UTC time zone.
View JSON Schema on GitHub

JSON Schema

lithic-tokenization-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tokenization",
  "title": "Tokenization",
  "properties": {
    "account_token": {
      "description": "The account token associated with the card being tokenized.",
      "format": "uuid",
      "type": "string"
    },
    "card_token": {
      "description": "The card token associated with the card being tokenized.",
      "format": "uuid",
      "type": "string"
    },
    "created_at": {
      "description": "Date and time when the tokenization first occurred. UTC time zone.",
      "format": "date-time",
      "type": "string"
    },
    "device_id": {
      "description": "The device identifier associated with the tokenization.",
      "type": [
        "string",
        "null"
      ]
    },
    "digital_card_art_token": {
      "description": "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](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).",
      "format": "uuid",
      "type": [
        "string",
        "null"
      ]
    },
    "events": {
      "description": "A list of events related to the tokenization.",
      "items": {
        "$ref": "#/components/schemas/tokenization-event"
      },
      "type": "array"
    },
    "status": {
      "description": "The status of the tokenization request",
      "enum": [
        "ACTIVE",
        "DEACTIVATED",
        "INACTIVE",
        "PAUSED",
        "PENDING_2FA",
        "PENDING_ACTIVATION",
        "UNKNOWN"
      ],
      "type": "string"
    },
    "token": {
      "description": "Globally unique identifier for a Tokenization",
      "format": "uuid",
      "type": "string"
    },
    "token_requestor_name": {
      "description": "The entity that requested the tokenization. For digital wallets, this will be one of the defined wallet types. For merchant tokenizations, this will be a free-form merchant name string.",
      "anyOf": [
        {
          "title": "Digital wallet type",
          "description": "Digital wallet type",
          "enum": [
            "AMAZON_ONE",
            "ANDROID_PAY",
            "APPLE_PAY",
            "FACEBOOK",
            "FITBIT_PAY",
            "GARMIN_PAY",
            "GOOGLE_PAY",
            "MICROSOFT_PAY",
            "NETFLIX",
            "SAMSUNG_PAY",
            "UNKNOWN",
            "VISA_CHECKOUT"
          ],
          "type": "string"
        },
        {
          "title": "Merchant name",
          "description": "Merchant name for merchant tokenizations",
          "type": "string"
        }
      ]
    },
    "token_unique_reference": {
      "description": "The network's unique reference for the tokenization.",
      "type": "string"
    },
    "dpan": {
      "description": "The dynamic pan assigned to the token by the network.",
      "type": [
        "string",
        "null"
      ]
    },
    "payment_account_reference_id": {
      "description": "The network's unique reference for the card that is tokenized.",
      "type": [
        "string",
        "null"
      ]
    },
    "tokenization_channel": {
      "description": "The channel through which the tokenization was made.",
      "enum": [
        "DIGITAL_WALLET",
        "MERCHANT"
      ],
      "type": "string"
    },
    "updated_at": {
      "description": "Latest date and time when the tokenization was updated. UTC time zone.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "account_token",
    "card_token",
    "created_at",
    "status",
    "token",
    "token_requestor_name",
    "token_unique_reference",
    "dpan",
    "tokenization_channel",
    "updated_at"
  ],
  "type": "object"
}