# Card Token

## Required
- `uuid`

## Carrier
- `object`
  - *If omitted, the previous carrier will be used.*

### Carrier Object

## Expiry Month
- `exp_month`
  - *string*
  - *length between 2 and 2*
  - *Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided, an expiration date five years in the future will be generated. Five years is the maximum expiration date.*

## Expiry Year
- `exp_year`
  - *string*
  - *length between 4 and 4*
  - *Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided, an expiration date five years in the future will be generated. Five years is the maximum expiration date.*

## Product ID
- `product_id`
  - *string*
  - *Specifies the configuration (e.g. physical card art) that the card should be manufactured with, and only applies to cards of type `PHYSICAL`. This must be configured with Lithic before use.*

## Shipping Address
- `object`
  - *required*
  - *The shipping address this card will be sent to.*

## Shipping Method
- `shipping_method`
  - *string*
  - *enum*
  - *Shipping method for the card. Only applies to cards of type PHYSICAL.*
  - *Use of options besides `STANDARD` require additional permissions.*

- `STANDARD` – USPS regular mail or similar international option, with no tracking
    - `STANDARD_WITH_TRACKING` – USPS regular mail or similar international option, with tracking
    - `PRIORITY` – USPS Priority, 1-3 day shipping, with tracking
    - `EXPRESS` – FedEx or UPS depending on card manufacturer, Express, 3-day shipping, with tracking
    - `2_DAY` – FedEx or UPS depending on card manufacturer, 2-day shipping, with tracking
    - `EXPEDITED` – FedEx or UPS depending on card manufacturer, Standard Overnight or similar international option, with tracking
    - `BULK` – Card will be shipped as part of a bulk fulfillment order. The shipping method and timeline are inherited from the parent bulk order.

### Allowed:
- `2_DAY`, `BULK`, `EXPEDITED`, `EXPRESS`, `PRIORITY`, `STANDARD`, `STANDARD_WITH_TRACKING`

## 200 OK
- `object`
  - *Card details without PCI information*

## Account Token
- `account_token`
  - *string*
  - *required*
  - *Globally unique identifier for the account to which the card belongs.*

## Auth Rule Tokens
- `auth_rule_tokens`
  - *array of strings*
  - *deprecated*
  - *List of identifiers for the Auth Rule(s) that are applied on the card. This field is deprecated and will no longer be populated in the Card object. Use the `/auth_rules` endpoints to fetch Auth Rule information instead.*

## Card Program Token
- `card_program_token`
  - *string*
  - *required*
  - *Globally unique identifier for the card program on which the card exists.*

## Bulk Order Token
- `bulk_order_token`
  - *uuid | null*
  - *Globally unique identifier for the bulk order associated with this card. Only applicable to physical cards that are part of a bulk shipment*

## Replacement For
- `replacement_for`
  - *string | null*
  - *If the card is a replacement for another card, the globally unique identifier for the card that was replaced.*

## Cardholder Currency
- `cardholder_currency`
  - *string*
  - *3-character alphabetic ISO 4217 code for the currency of the cardholder.*

## Created
- `created`
  - *date-time*
  - *required*
  - *An RFC 3339 timestamp for when the card was created. UTC time zone.*

## Digital Card Art Token
- `digital_card_art_token`
  - *string | null*
  - *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.*

## Expiry Month
- `exp_month`
  - *string*
  - *length between 2 and 2*
  - *Two digit (MM) expiry month.*

## Expiry Year
- `exp_year`
  - *string*
  - *length between 4 and 4*
  - *Four digit (yyyy) expiry year.*

## Funding
- `funding`
  - *null*
  - *required*
  - *Deprecated: Funding account for the card.*

## Hostname
- `hostname`
  - *string*
  - *Hostname of card's locked merchant (will be empty if not applicable).*

## Last Four
- `last_four`
  - *string*
  - *required*
  - *length between 4 and 4*
  - *Last four digits of the card number.*

## Memo
- `memo`
  - *string*
  - *Friendly name to identify the card.*

## Network Program Token
- `network_program_token`
  - *string | null*
  - *Globally unique identifier for the card's network program. Null if the card is not associated with a network program. Currently applicable to Visa cards participating in Account Level Management only*

## Pending Commands
- `pending_commands`
  - *array of strings*
  - *Indicates if there are offline PIN changes pending card interaction with an offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable only to cards issued in markets supporting offline PINs.*

## Pin Status
- `pin_status`
  - *string*
  - *required*
  - *Indicates if a card is blocked due to a PIN status issue (e.g. excessive incorrect attempts).*

- `OK`, `BLOCKED`, `NOT_SET`

## Product ID
- `product_id`
  - *string | null*
  - *Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic before use. Specifies the configuration (i.e., physical card art) that the card should be manufactured with.*

## Spend Limit
- `spend_limit`
  - *integer*
  - *required*
  - *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.*

## Spend Limit Duration
- `spend_limit_duration`
  - *string*
  - *enum*
  - *required*
  - *Spend limit duration values:*

- `ANNUALLY` – Card will authorize transactions up to spend limit for the trailing year.
    - `FOREVER` – Card will authorize only up to spend limit for the entire lifetime of the card.
    - `MONTHLY` – Card will authorize transactions up to spend limit for the trailing month. To support recurring monthly payments, which can occur on different day every month, the time window we consider for monthly velocity starts 6 days after the current calendar date one month prior.
    - `TRANSACTION` – Card will authorize multiple transactions if each individual transaction is under the spend limit.

- `ANNUALLY`, `FOREVER`, `MONTHLY`, `TRANSACTION`

## State
- `state`
  - *string*
  - *enum*
  - *required*
  - *Card state values:*

- `CLOSED` – Card will no longer approve authorizations. Closing a card cannot be undone.
    - `OPEN` – Card will approve authorizations (if they match card and account parameters).
    - `PAUSED` – Card will decline authorizations, but can be resumed at a later time.
    - `PENDING_FULFILLMENT` – The initial state for cards of type `PHYSICAL`. The card is provisioned pending manufacturing and fulfillment. Cards in this state can accept authorizations for e-commerce purchases, but not for "Card Present" purchases where the physical card itself is present.
    - `PENDING_ACTIVATION` – At regular intervals, cards of type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production warehouse and updated to state `PENDING_ACTIVATION`. Similar to `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce transactions or can be added to mobile wallets. API clients should update the card's state to `OPEN` only after the cardholder confirms receipt of the card. In sandbox, the same daily batch fulfillment occurs, but no cards are actually manufactured.

- `CLOSED`, `OPEN`, `PAUSED`, `PENDING_ACTIVATION`, `PENDING_FULFILLMENT`

## Substatus
- `substatus`
  - *string | null*
  - *enum*
  - *Card state substatus values:*

- `LOST` – The physical card is no longer in the cardholder's possession due to being lost or never received by the cardholder.
    - `COMPROMISED` – Card information has been exposed, potentially leading to unauthorized access. This may involve physical card theft, cloning, or online data breaches.
    - `DAMAGED` – The physical card is not functioning properly, such as having chip failures or a demagnetized magnetic stripe.
    - `END_USER_REQUEST` – The cardholder requested the closure of the card for reasons unrelated to fraud or damage, such as switching to a different product or closing the account.
    - `ISSUER_REQUEST` – The issuer closed the card for reasons unrelated to fraud or damage, such as account inactivity, product or policy changes, or technology upgrades.
    - `NOT_ACTIVE` – The card hasn’t had any transaction activity for a specified period, applicable to statuses like `PAUSED` or `CLOSED`.
    - `SUSPICIOUS_ACTIVITY` – The card has one or more suspicious transactions or activities that require review. This can involve prompting the cardholder to confirm legitimate use or report confirmed fraud.
    - `INTERNAL_REVIEW` – The card is temporarily paused pending further internal review.
    - `EXPIRED` – The card has expired and has been closed without being reissued.
    - `UNDELIVERABLE` – The card cannot be delivered to the cardholder and has been returned.
    - `OTHER` – The reason for the status does not fall into any of the above categories. A comment can be provided to specify the reason.

- `LOST`, `COMPROMISED`, `DAMAGED`, `END_USER_REQUEST`, `ISSUER_REQUEST`, `NOT_ACTIVE`, `SUSPICIOUS_ACTIVITY`, `INTERNAL_REVIEW`, `EXPIRED`, `UNDELIVERABLE`, `OTHER`

## Comment
- `comment`
  - *string*
  - *Additional context or information related to the card.*

## Token
- `token`
  - *string*
  - *required*
  - *Globally unique identifier.*

## Type
- `type`
  - *string*
  - *enum*
  - *required*
  - *Card types:*

- `VIRTUAL` – Card will authorize at any merchant and can be added to a digital wallet like Apple Pay or Google Pay (if the card program is digital wallet-enabled).
    - `PHYSICAL` – Manufactured and sent to the cardholder. We offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality.
    - `SINGLE_USE` – Card is closed upon first successful authorization.
    - `MERCHANT_LOCKED` – Card is locked to the first merchant that successfully authorizes the card.
    - `UNLOCKED` – [Deprecated] Similar behavior to VIRTUAL cards, please use VIRTUAL instead.
    - `DIGITAL_WALLET` – [Deprecated] Similar behavior to VIRTUAL cards, please use VIRTUAL instead.

- `MERCHANT_LOCKED`, `PHYSICAL`, `SINGLE_USE`, `VIRTUAL`, `UNLOCKED`, `DIGITAL_WALLET`

## Primary Account Number (PAN)
- `pan`
  - *string*
  - *length between 16 and 16*
  - *Primary Account Number (PAN) (i.e. the card number). Customers must be PCI compliant to have PAN returned as a field in production.*

## CVV
- `cvv`
  - *string*
  - *length between 3 and 3*
  - *Three digit cvv printed on the back of the card.*

# Example Request

curl --request POST \
         --url https://sandbox.lithic.com/v1/cards/card_token/renew \
         --header 'accept: application/json' \
         --header 'content-type: application/json' \
         --data '\n    {\n      "carrier": {\n        "qr_code_url": "https://lithic.com/activate-card/1"\n      },\n      "product_id": "100",\n      "shipping_address": {\n        "address1": "5 Broad Street",\n        "address2": "Unit 5A",\n        "city": "NEW YORK",\n        "country": "USA",\n        "first_name": "Janet",\n        "last_name": "Yellen",\n        "postal_code": "10001",\n        "state": "NY"\n      },\n      "shipping_method": "STANDARD"\n    }\n    '

# Example Response

{\n      "account_token": "f3f4918c-dee9-464d-a819-4aa42901d624",\n      "card_program_token": "5e9483eb-8103-4e16-9794-2106111b2eca",\n      "cardholder_currency": "USD",\n      "created": "2021-06-28T22:53:15Z",\n      "cvv": "742",\n      "exp_month": "05",\n      "exp_year": "2027",\n      "funding": {\n        "account_name": "Sandbox",\n        "created": "2020-07-08T17:57:36Z",\n        "last_four": "5263",\n        "nickname": "checking account",\n        "state": "ENABLED",\n        "token": "b0f0d91a-3697-46d8-85f3-20f0a585cbea",\n        "type": "DEPOSITORY_CHECKING"\n      },\n      "hostname": "",\n      "last_four": "4938",\n      "memo": "Updated Name",\n      "pan": "4111111289144142",\n      "spend_limit": 100,\n      "spend_limit_duration": "FOREVER",\n      "state": "OPEN",\n      "token": "f5f905f5-8a8e-49bf-a9b4-c0adaa401456",\n      "type": "PHYSICAL",\n      "pin_status": "OK"\n    }