Manage Cards

Freeze Card

Freeze a card when it is lost, stolen, suspected of compromise, or temporarily not required. A frozen card cannot be used for new payments.

Method	Endpoint
`POST`	`/api/v1/cards/:cardId/freeze`

curl --request POST 
      --url https://api.getanchor.co/api/v1/cards/:cardId/freeze 
      --header 'accept: application/json' 
      --header 'x-anchor-key: <API Key>'

{
  "data": {
    "id": "card_123",
    "type": "Card",
    "attributes": {
      "cardStatus": "INACTIVE",
      "description": "Operations expense card",
      "maskedPan": "539983******1234",
      "last4": "1234"
    }
  },
  "included": []
}

📘
Disable repeated freeze requests while the first one is processing, and refresh the card afterward rather than assuming the freeze succeeded client-side. Always display the status returned by the server.

Update Card Description

After a card has been created, you may update its description. This is the only card attribute that can be changed after creation.

Method	Endpoint
`POST`	`/api/v1/cards/:cardId`

curl --request POST \
     --url https://api.getanchor.co/api/v1/cards/:cardId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-anchor-key: <API Key>' \
     --data '
{
  "data": {
    "type": "Card",
    "attributes": {
      "description": "Updated operations expense card"
    }
  }
}
'

{
  "data": {
    "id": "card_123",
    "type": "Card",
    "attributes": {
      "cardStatus": "ACTIVE",
      "description": "Updated operations expense card",
      "maskedPan": "539983******1234",
      "last4": "1234"
    }
  },
  "included": []
}

Unfreeze Card

Restore an eligible frozen card back to active use.

Method	Endpoint
`POST`	`/api/v1/cards/:cardId/unfreeze`

curl --request POST 
	--url https://api.getanchor.co/api/v1/cards/:cardId/unfreeze
	--header 'accept: application/json'
	--header 'x-anchor-key: <API Key>

{
  "data": {
    "id": "card_123",
    "type": "Card",
    "attributes": {
      "cardStatus": "ACTIVE",
      "description": "Operations expense card",
      "maskedPan": "539983******1234",
      "last4": "1234"
    }
  },
  "included": []
}

📘
Not every frozen card is guaranteed to be eligible for unfreezing. Check the response status rather than assuming the request always succeeds.

Delete Card

Method	Endpoint
`DELETE`	`/api/v1/cards/:cardId`