Update card

patch

https://sandbox.lithic.com/v1/cards/{card_token}

Update the specified properties of the card. Unsupplied properties will remain unchanged.

Note: setting a card to a CLOSED state is a final action that cannot be undone.

Path Params

card_token

uuid

required

Body Params

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.

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:

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 - 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.

Allowed:

state

string

enum

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.

Allowed:

substatus

string

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 should be provided to specify the reason.

comment

string

Additional context or information related to the card.

Responses


User has not been authenticated	Invalid or missing API key
API key is not active	The API key used is no longer active
Could not find API key	The API key provided is not associated with any user
Please provide API key in Authorization header	The Authorization header is not in the request
Please provide API key in the form Authorization: [api-key]	The Authorization header is not formatted properly
Insufficient privileges. Issuing API key required	Write access requires an Issuing API key. Reach out at lithic.com/contact
Insufficient privileges to create virtual cards.	Creating virtual cards requires an additional privilege


Rate limited, too many requests per second	User has exceeded their per second rate limit
Rate limited, reached daily limit	User has exceeded their daily rate limit
Rate limited, too many keys tried	One IP has queried too many different API keys

200OK

400A parameter in the query given in the request does not match the valid queries for the endpoint.

404The specified resource was not found.

422Unprocessable entity.