Skip to content
HitchPay API Docs

Webhooks

Card Status Change Update

Fired when a card's lifecycle status changes: frozen, unfrozen, or terminated.

Use this webhook to

  • Confirm a freeze, unfreeze, or termination has actually taken effect
  • Keep your own records of card status in sync without polling Get Card

Events

Event Fired when
card.frozen A card is frozen
card.unfrozen A card is unfrozen
card.terminated A card is permanently closed

Payload

All three events share the same shape:

{
  "event": "card.frozen",
  "data": {
    "tracking_id": "EXTCARD…",
    "customer_uuid": "…",
    "card_id": "…",
    "status": "frozen"
  }
}

Payload fields

Field Type Description
tracking_id string Card id
customer_uuid string Customer this card belongs to
card_id string Card reference
status string frozen, active (after unfreeze), or terminated
  • Freeze Card, Unfreeze Card, and Terminate Card, see the Virtual Cards section
  • See Overview & Signature Verification for how to verify the x-hitchpay-signature header before trusting this payload

Questions? Email [email protected]. Also on GitBook.