Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Update a Card

patch/cards/{card_id}

Path parameters

card_idstring required

The card identifier.

Request body

descriptionstring

The description you choose to give the card.

entity_idstring

The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.

status'active' | 'disabled' | 'canceled'

The status to update the Card with.

Example request

{
  "description": "New description"
}

Response

Card

account_idstring required

The identifier for the account this card belongs to.

binstring required

The Bank Identification Number (BIN) of the Card.

created_atstring date-time required

The ISO 8601 date and time at which the Card was created.

descriptionstring nullable required

The card's description for display purposes.

entity_idstring nullable required

The identifier for the entity associated with this card.

expiration_monthinteger required

The month the card expires in M format (e.g., August is 8).

expiration_yearinteger required

The year the card expires in YYYY format (e.g., 2025).

idstring required

The card identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

last4string required

The last 4 digits of the Card's Primary Account Number.

status'active' | 'disabled' | 'canceled' required

This indicates if payments can be made with the card.

type'card' required

A constant representing the object's type. For this resource it will always be card.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "authorization_controls": {
    "merchant_acceptor_identifier": null,
    "merchant_category_code": {
      "allowed": null,
      "blocked": [
        {
          "code": "5734"
        }
      ]
    },
    "merchant_country": null,
    "usage": {
      "category": "multi_use",
      "multi_use": {
        "spending_limits": [
          {
            "interval": "per_month",
            "merchant_category_codes": null,
            "settlement_amount": 100000
          }
        ]
      },
      "single_use": null
    }
  },
  "billing_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "bin": "42424242",
  "cardholder_name": {
    "first": "Ian",
    "last": "Crease",
    "middle": null
  },
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Office Expenses",
  "digital_wallet": {
    "digital_card_profile_id": "digital_card_profile_s3puplu90f04xhcwkiga",
    "email": "user@example.com",
    "phone": "+16505046304"
  },
  "entity_id": null,
  "expiration_month": 11,
  "expiration_year": 2028,
  "id": "card_oubs0hwk5rn6knuecxg2",
  "idempotency_key": null,
  "last4": "4242",
  "status": "active",
  "type": "card"
}