Skip to main content
WEBHOOK
CARD_UNLOADED
{
  "event":       "CARD_UNLOADED",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T10:00:00Z",
  "data": {
    "cardId":              "crd_01HXYZ5555ABCDEF1111",
    "cardholderId":        "chl_01HXYZ1234ABCDEF5678",
    "programId":           "prg_01HXYZ9876ABCDEF0000",
    "amountCents":         2500,
    "currency":            "USD",
    "cardBalanceCents":    2500,
    "programBalanceCents": 100002500,
    "ledgerTransactionId": "ltx_01HXYZ8888ABCDEF3333"
  }
}
{}

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}/unload request. Funds have moved from the card back to the program ledger.

Event Type

CARD_UNLOADED

Payload

{
  "event":       "CARD_UNLOADED",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T10:00:00Z",
  "data": {
    "cardId":              "crd_01HXYZ5555ABCDEF1111",
    "cardholderId":        "chl_01HXYZ1234ABCDEF5678",
    "programId":           "prg_01HXYZ9876ABCDEF0000",
    "amountCents":         2500,
    "currency":            "USD",
    "cardBalanceCents":    2500,
    "programBalanceCents": 100002500,
    "ledgerTransactionId": "ltx_01HXYZ8888ABCDEF3333"
  }
}

Payload Fields

FieldTypeDescription
cardIdstringThe card funds were unloaded from
cardholderIdstringThe cardholder the card belongs to
programIdstringThe program that received the funds
amountCentsintegerAmount unloaded in cents
currencystringCurrency code (ISO 4217)
cardBalanceCentsintegerCard balance after unloading, in cents
programBalanceCentsintegerProgram ledger balance after unloading, in cents
ledgerTransactionIdstringInternal ledger transaction reference

Common Use Cases

  • Reflect the updated card balance in your UI
  • Confirm a partial unload before proceeding with a withdrawal
For the full event group documentation see Card Events.
{
  "event":       "CARD_UNLOADED",
  "eventId":     "evt_01HXY123456ABCDEF",
  "businessId":  "BUS1A2B3C4D5E6F",
  "environment": "LIVE",
  "timestamp":   "2026-05-22T10:00:00Z",
  "data": {
    "cardId":              "crd_01HXYZ5555ABCDEF1111",
    "cardholderId":        "chl_01HXYZ1234ABCDEF5678",
    "programId":           "prg_01HXYZ9876ABCDEF0000",
    "amountCents":         2500,
    "currency":            "USD",
    "cardBalanceCents":    2500,
    "programBalanceCents": 100002500,
    "ledgerTransactionId": "ltx_01HXYZ8888ABCDEF3333"
  }
}
{}

Authorizations

Authorization
string
header
required

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

Body

application/json
event
string
Example:

"CARD_UNLOADED"

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

Response

200

Acknowledge the event.