Simulate a card's tokenization

Tokenization Request Parameters

• account_score
  Integer, Defaults to 5. The account score (1-5) that represents how the Digital Wallet's view on how reputable an end user's account is.

• cvv
  String, required, length between 3 and 3. The three digit CVV for the card.

• device_score
  Integer, Defaults to 5. The device score (1-5) that represents how the Digital Wallet's view on how reputable an end user's device is.

• entity
  String, optional field to specify the token requestor name for a merchant token simulation. Ignored when tokenization_source is not MERCHANT.

• expiration_date
  String, required, length between 5 and 5. The expiration date of the card in 'MM/YY' format.

• pan
  String, required, length between 16 and 16. The sixteen digit card number.

• tokenization_source
  String, enum, required. The source of the tokenization request.
  Allowed: APPLE_PAY, GOOGLE, SAMSUNG_PAY, MERCHANT

• wallet_recommended_decision
  String, enum, Defaults to APPROVED. The decision that the Digital Wallet's recommend.
  Allowed: APPROVED, DECLINED, REQUIRE_ADDITIONAL_AUTHENTICATION

Tokenization Response

Success Response

• 201 OK
  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.
  • events
    Array of objects. A list of events related to the tokenization.
    • event
      • 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.
        Allowed: 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.
        Allowed: TOKENIZATION_2FA, TOKENIZATION_AUTHORIZATION, TOKENIZATION_DECISIONING, TOKENIZATION_ELIGIBILITY_CHECK, TOKENIZATION_UPDATED
  • status
    String, enum, required. The status of the tokenization request.
    Allowed: ACTIVE, DEACTIVATED, INACTIVE, PAUSED, PENDING_2FA, PENDING_ACTIVATION, UNKNOWN
  • token
    UUID, required. Globally unique identifier for a Tokenization.
  • token_requestor_name
    String, required. The entity that requested the tokenization.
  • 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.
    Allowed: DIGITAL_WALLET, MERCHANT
  • updated_at
    Date-time, required. Latest date and time when the tokenization was updated. UTC time zone.

Error Responses

• 400
  A parameter in the query given in the request does not match the valid queries for the endpoint.
• 401
  User has not been authenticated or other authentication-related issues.
• 404
  The specified resource was not found.
• 422
  Unprocessable entity.
• 429
  Client has exceeded the number of allowed requests in a given time period.

Example Curl Command

curl --request POST \
     --url https://sandbox.lithic.com/v1/simulate/tokenizations \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "account_score": 5,
  "cvv": "776",
  "device_score": 5,
  "expiration_date": "08/29",
  "pan": "4111111289144142",
  "tokenization_source": "APPLE_PAY",
  "wallet_recommended_decision": "APPROVED"
}
'

Example Success Response

{
  "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"
    }
  ],
  "status": "ACTIVE",
  "token": "3e9a10da-11be-4a62-a510-d43548bfcec1",
  "tokenization_channel": "DIGITAL_WALLET",
  "token_requestor_name": "APPLE_PAY",
  "token_unique_reference": "DM4MMC0000332872ef1029f38fa0184b5c9260383da192b22",
  "dpan": "5489123487251234",
  "payment_account_reference_id": "50019T0AL7DEFGJ4AGGT8BQDOABCD",
  "updated_at": "2023-08-28T15:57:14.578051"
}