Card Token

Card Details

Properties

• card_token: uuid (required)
  The unique identifier for the card.

• digital_card_art_token: uuid
  Specifies the digital card art to be displayed in the user’s digital wallet after tokenization. This artwork must be approved by Mastercard and configured by Lithic to use. See Flexible Card Art Guide.

• memo: string
  Friendly name to identify the card.

• network_program_token: uuid
  Globally unique identifier for the card's network program. Currently applicable to Visa cards participating in Account Level Management only.

• pin: string
  Encrypted PIN block (in base64). Only applies to cards of type PHYSICAL and VIRTUAL. Changing PIN also resets PIN status to OK. See Encrypted PIN Block.

• pin_status: string (enum)
  Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect attempts). Can only be set to OK to unblock a card.
  Allowed: OK

• spend_limit: integer
  Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,000 limit). Transaction requests above the spend limit will be declined. Note that a spend limit of 0 is effectively no limit, and should only be used to reset or remove a prior limit. Only a limit of 1 or above will result in declined transactions due to checks against the card limit.

• spend_limit_duration: string (enum)
  Spend limit duration values:

  • ANNUALLY
  • FOREVER
  • MONTHLY
  • TRANSACTION
    Allowed: ANNUALLY, FOREVER, MONTHLY, TRANSACTION

• state: string (enum)
  Card state values:

  • CLOSED
  • OPEN
  • PAUSED
    Allowed: CLOSED, OPEN, PAUSED

• substatus: string (enum)
  Card state substatus values:

  • LOST
  • COMPROMISED
  • DAMAGED
  • END_USER_REQUEST
  • ISSUER_REQUEST
  • NOT_ACTIVE
  • SUSPICIOUS_ACTIVITY
  • INTERNAL_REVIEW
  • EXPIRED
  • UNDELIVERABLE
  • OTHER
    Allowed: LOST, COMPROMISED, DAMAGED, END_USER_REQUEST, ISSUER_REQUEST, NOT_ACTIVE, SUSPICIOUS_ACTIVITY, INTERNAL_REVIEW, EXPIRED, UNDELIVERABLE, OTHER

• comment: string
  Additional context or information related to the card.

Example Response

{
  "account_token": "f3f4918c-dee9-464d-a819-4aa42901d624",
  "card_program_token": "5e9483eb-8103-4e16-9794-2106111b2eca",
  "cardholder_currency": "USD",
  "created": "2021-06-28T22:53:15Z",
  "cvv": "742",
  "exp_month": "05",
  "exp_year": "2027",
  "hostname": "",
  "last_four": "4938",
  "memo": "Updated Name",
  "pan": "4111111289144142",
  "spend_limit": 100,
  "spend_limit_duration": "FOREVER",
  "replacement_for": null,
  "state": "OPEN",
  "token": "f5f905f5-8a8e-49bf-a9b4-c0adaa401456",
  "type": "VIRTUAL",
  "pin_status": "NOT_SET"
}

Error Codes

• 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.
• 404: The specified resource was not found.
• 422: Unprocessable entity.
• 429: Client has exceeded the number of allowed requests in a given time period.