Skip to main content

​
Overview

Our card webhook events are fired based on the following triggers:
  • Created webhook event
  • Terminated webhook event
  • Freeze webhook event
  • Unfreeze webhook event
  • Updated webhook event
  • Transaction webhook event

​
Created webhook event

This event is fired when a card is created.
card.created
{
  "event": "card.created",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}

​
Terminated webhook event

This event is fired when a card is terminated.
card.terminated
{
  "event": "card.terminated",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}

​
Freeze webhook event

This event is fired when a card is freezed.
card.freezed
{
  "event": "card.freezed",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "balance": 1000,
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}

​
Unfreeze webhook event

This event is fired when a card is unfreezed.
card.unfreezed
{
  "event": "card.unfreezed",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "balance": 1000,
    "status": "STATUS",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}

​
Updated webhook event

This event is fired when a card is funded.
card.updated
{
  "event": "card.updated",
  "data": {
    "id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "balance": 1000,
    "status": "ACTIVE",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}

​
Transaction webhook event

This event is fired when a card transaction is made.

​
Transaction Categories

  • FUNDING
  • WITHDRAW
  • Transaction

​
Transaction Types

  • DEBIT
  • CREDIT

​
Transaction Status

  • APPROVED
  • DECLINED
  • COMPLETED
  • FAILED
  • REVERSE
card.transaction
{
  "event": "card.transaction",
  "data": {
    "id": "card_123456789",
    "card_id": "card_123456789",
    "business_id": "bus_mviuNSMKi74vTY8yvfP6nQ",
    "reference": "ref_mviuNSMKi74vTY8yvfP6nQ",
    "amount": 1000,
    "charges": 1000,
    "status": "APPROVED",
    "type": "DEBIT",
    "merchant_name": "Google Inc",
    "merchant_city": "",
    "merchant_country": "",
    "merchant_postal_code": "",
    "merchant_state": "",
    "merchant_mcc": "",
    "merchant_mid": "",
    "currency": "USD",
    "category": "FUNDING",
    "created_at": "2024-02-06T02:49:18Z",
    "updated_at": "2024-02-06T02:49:18Z"
  }
}