Tokenization

Simulate a card's tokenization

Changed on

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

post/v1/simulate/tokenizations

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/simulate/tokenizations
  • Auth
    API key in header Authorization

Request body

account_scoreinteger

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

cvvstring required

The three or four digit CVV for the card. AMEX cards use four digit CVVs.

device_scoreinteger

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

entitystring

Optional field to specify the token requestor name for a merchant token simulation. Ignored when tokenization_source is not MERCHANT.

expiration_datestring required

The expiration date of the card in 'MM/YY' format.

panstring required

The sixteen digit card number.

tokenization_source'APPLE_PAY' | 'GOOGLE' | 'SAMSUNG_PAY' | 'MERCHANT' required

The source of the tokenization request.

wallet_recommended_decision'APPROVED' | 'DECLINED' | 'REQUIRE_ADDITIONAL_AUTHENTICATION'

The decision that the Digital Wallet's recommend

Example request

{
  "cvv": "776",
  "pan": "4111111289144142"
}

Response

OK

account_tokenstring uuid required

The account token associated with the card being tokenized.

card_tokenstring uuid required

The card token associated with the card being tokenized.

created_atstring date-time required

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

device_idstring nullable

The device identifier associated with the tokenization.

digital_card_art_tokenstring uuid nullable

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.

status'ACTIVE' | 'DEACTIVATED' | 'INACTIVE' | 'PAUSED' | 'PENDING_2FA' | 'PENDING_ACTIVATION' | 'UNKNOWN' required

The status of the tokenization request

tokenstring uuid required

Globally unique identifier for a Tokenization

token_unique_referencestring required

The network's unique reference for the tokenization.

dpanstring nullable required

The dynamic pan assigned to the token by the network.

payment_account_reference_idstring nullable

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

tokenization_channel'DIGITAL_WALLET' | 'MERCHANT' required

The channel through which the tokenization was made.

updated_atstring date-time required

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

Changes

  • 511ac83f5a4bRevision changes
    • info

      the request property's maxLength was increased from 3 to 4

  • cfbca12dc3e6Revision changes
    • warning

      added the new INVALID_PAN enum value to the /// response property for the response status