Skip to main content
WEBHOOK
CARD_FROZEN
{
  "event":       "CARD_FROZEN",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T10:00:00Z",
  "data": {
    "cardId":       "crd_01HXYZ5555ABCDEF1111",
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "programId":    "prg_01HXYZ9876ABCDEF0000",
    "status":       "FROZEN",
    "reason":       "MANUAL"
  }
}

{}

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

Fires after a successful POST /cards/{id}/freeze request, or when FYATU’s fraud systems freeze a card automatically. No new transactions can be authorized on the card until it is unfrozen.

​
Event Type

CARD_FROZEN

​
Payload

{
  "event":       "CARD_FROZEN",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T10:00:00Z",
  "data": {
    "cardId":       "crd_01HXYZ5555ABCDEF1111",
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "programId":    "prg_01HXYZ9876ABCDEF0000",
    "status":       "FROZEN",
    "reason":       "MANUAL"
  }
}

​
Payload Fields

FieldTypeDescription
cardIdstringThe frozen card ID
cardholderIdstringThe cardholder the card belongs to
programIdstringThe program the card belongs to
statusstringAlways FROZEN
reasonstringMANUAL (API call) or FRAUD (automated freeze)

​
Common Use Cases

  • Notify the cardholder that their card has been temporarily blocked
  • Update the card status in your platform UI
For the full event group documentation see Card Events. 
{
  "event":       "CARD_FROZEN",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T10:00:00Z",
  "data": {
    "cardId":       "crd_01HXYZ5555ABCDEF1111",
    "cardholderId": "chl_01HXYZ1234ABCDEF5678",
    "programId":    "prg_01HXYZ9876ABCDEF0000",
    "status":       "FROZEN",
    "reason":       "MANUAL"
  }
}

{}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
event
string
Example:

"CARD_FROZEN"

​
eventId
string
​
businessId
string
​
environment
enum<string>
Available options:
LIVE,
SANDBOX
​
timestamp
string<date-time>
​
data
object

Response

200

Acknowledge the event.