Skip to main content
POST
/
cards
/
{id}
/
freeze
Freeze a card
curl --request POST \
  --url https://api.fyatu.com/api/v3.20/cards/{id}/freeze \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Card frozen",
  "data": {
    "id": "crd_01HXYZ5555ABCDEF1111",
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "productId": "prd_01HXYZ7777ABCDEF3333",
    "status": "FROZEN",
    "cardType": "VIRTUAL",
    "cardBrand": "VISA",
    "maskedPan": "**** **** **** 4242",
    "last4": "4242",
    "expirationDate": "05/2029",
    "currency": "USD",
    "frozenAt": "2026-05-26T10:00:00Z",
    "createdAt": "2026-05-22T09:00:00Z",
    "updatedAt": "2026-05-26T10:00:00Z"
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-26T10:00:00Z"
  }
}

Overview

Immediately freezes an active card. While frozen:
  • All purchase attempts are declined at the network level
  • The card balance is fully preserved
  • The card can be unfrozen at any time via POST /cards/{id}/unfreeze
This is the recommended first action when a cardholder reports a lost or suspicious card. Freeze first, investigate, then unfreeze if the situation resolves or terminate if confirmed compromised.

Path Parameters

ParameterTypeDescription
idstringThe card ID (prefix crd_)

Request Body

This endpoint has no request body.

Example

curl -X POST https://api.fyatu.com/api/v3.20/cards/crd_01HXYZ5555ABCDEF1111/freeze \
  -H "Authorization: Bearer $FYATU_API_KEY"

Success Response (200)

Returns the updated card with status: FROZEN and a non-null frozenAt:
{
  "success": true,
  "status": 200,
  "message": "Card frozen",
  "data": {
    "id":             "crd_01HXYZ5555ABCDEF1111",
    "cardholderId":   "chl_01HXYZ1234ABCDEF5678",
    "productId":      "prd_01HXYZ7777ABCDEF3333",
    "status":         "FROZEN",
    "cardType":       "VIRTUAL",
    "cardBrand":      "VISA",
    "maskedPan":      "**** **** **** 4242",
    "last4":          "4242",
    "expirationDate": "05/2029",
    "currency":       "USD",
    "frozenAt":       "2026-05-26T10:00:00Z",
    "createdAt":      "2026-05-22T09:00:00Z",
    "updatedAt":      "2026-05-26T10:00:00Z"
  },
  "meta": {
    "requestId": "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-26T10:00:00Z"
  }
}

Webhook

A CARD_FROZEN event fires after a successful freeze:
{
  "event":      "CARD_FROZEN",
  "eventId":    "evt_01HXY123456ABCDEF",
  "businessId": "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":  "2026-05-26T10:00:00Z",
  "data": {
    "cardId":       "crd_01HXYZ5555ABCDEF1111",
    "status":       "FROZEN",
    "cardType":     "VIRTUAL",
    "cardholderId": "chl_01HXYZ1234ABCDEF5678"
  }
}

Error Codes

CodeHTTPCause
CARD_NOT_FOUND404Card does not exist or belongs to another business/environment
CARD_ALREADY_FROZEN409Card is already frozen
CARD_ALREADY_TERMINATED422Cannot freeze a terminated card
INSUFFICIENT_SCOPE403Key lacks cards:write scope

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Path Parameters

id
string
required

Response

Card frozen

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Card retrieved"

data
object

Full card object returned by GET /cards/{id}. Includes live balance, full PAN, CVV, features, and billing address.

meta
object