Skip to content
Stainless Stainless Stainless SDKs

Update

Update card
patch/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 Parameters
card_tokenstring
formatuuid
Body Parameters
digital_card_art_tokenstring
optional

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.

formatuuid
memostring
optional

Friendly name to identify the card.

pinstring
optional

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_statusenum
optional
Accepts one of the following: "OK"

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.

Hide ParametersShow Parameters
"OK"
spend_limitnumber
optional

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_durationSpendLimitDuration
optional

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.
stateenum
optional
Accepts one of the following: "CLOSED", "OPEN", "PAUSED"

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.
Hide ParametersShow Parameters
"CLOSED"
"OPEN"
"PAUSED"
Returns
cvvstringpanstringCard
Request example Request
curl https://api.lithic.com/v1/cards/$CARD_TOKEN \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "memo": "Updated Name"
    }'
200 Example
{
  "token": "7ef7d65c-9023-4da3-b113-3b8583fd7951",
  "account_token": "f3f4918c-dee9-464d-a819-4aa42901d624",
  "card_program_token": "5e9483eb-8103-4e16-9794-2106111b2eca",
  "created": "2021-06-28T22:53:15Z",
  "funding": {
    "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created": "2019-12-27T18:11:19.117Z",
    "last_four": "xxxx",
    "state": "DELETED",
    "type": "DEPOSITORY_CHECKING",
    "account_name": "account_name",
    "nickname": "x"
  },
  "last_four": "xxxx",
  "pin_status": "OK",
  "spend_limit": 1000,
  "spend_limit_duration": "ANNUALLY",
  "state": "CLOSED",
  "type": "MERCHANT_LOCKED",
  "auth_rule_tokens": [
    "string"
  ],
  "cardholder_currency": "USD",
  "digital_card_art_token": "00000000-0000-0000-1000-000000000000",
  "exp_month": "06",
  "exp_year": "2027",
  "hostname": "hostname",
  "memo": "New Card",
  "pending_commands": [
    "string"
  ],
  "product_id": "1",
  "replacement_for": "5e9483eb-8103-4e16-9794-2106111b2eca",
  "cvv": "776",
  "pan": "4111111289144142"
}