Skip to content
HitchPay API Docs

Webhooks

Card Funding Status Update

Fired when a card top-up or withdrawal settles.

Use this webhook to

  • Confirm a top-up has actually landed on the card
  • Confirm a withdrawal has actually settled back to your wallet
  • Update your own ledger without polling. Get Card

Events

Event Fired when
card.funded A top-up settles
card.withdrawn A withdrawal settles

Payloads

card.funded

{
  "event": "card.funded",
  "data": {
    "tracking_id": "EXTCARD…",
    "customer_uuid": "…",
    "card_id": "…",
    "amount": 50,
    "currency": "USD",
    "balance": 75.00,
    "reference": "CFND…"
  }
}

card.withdrawn

{
  "event": "card.withdrawn",
  "data": {
    "tracking_id": "EXTCARD…",
    "customer_uuid": "…",
    "card_id": "…",
    "amount": 30,
    "currency": "USD",
    "balance": 45.00,
    "reference": "CWTD…"
  }
}

Payload fields

Field Type Description
tracking_id string Card id
customer_uuid string Customer this card belongs to
card_id string Card reference
amount number Amount funded or withdrawn
currency string USD
balance number Card balance after this event
reference string Our transaction id for this event
  • Fund Card and Withdraw from 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.