API Reference

1. Account Created

This webhook event is fired when a bank account that was requested has now been successfully issued and activated

{
  "event_type": "account.created",
  "entity": "bank_account",
  "data": {
    "id": "548d6eb668f111eda78fe041a4724e32",
    "holder_id": "6289dedc686511eda78fe041a4724e32",
    "holder_type": "person",
    "label": "Yomi's Account",
    "account_name": "YOMI NDU",
    "account_number": "9992740191426913",
    "routing_number": "084106768",
    "bank_name": "Oval Bank",
    "bank_code": null,
    "bank_address": {
      "city": "Memphis",
      "country": "US",
      "line1": "6351 Rahul Ligma",
      "line2": "Suite 92392",
      "postal_code": "38119",
      "state": "TN"
    },
    "currency": "USD",
    "balance": 0,
    "credit_pending": 0,
    "debit_pending": 0,
    "type": "personal_checking",
    "status": "active",
    "is_deleted": false,
    "created_at": "2022-11-20T17:35:23Z",
    "updated_at": "2022-11-20T19:32:50Z"
  }
}

2. Card Created

This webhook event is fired when a card that was requested has now been successfully issued and activated

{
  "event_type": "card.created",
  "entity": "card",
  "data": {
    "id": "011b7b78b07011ed9e800242ac110002",
    "holder_id": "c74b2fb8a59911eda9df0242ac110002",
    "holder_type": "person",
    "balance": 5000,
    "currency": "USD",
    "brand": "visa",
    "label": "Sandbox",
    "cardholder_name": "JOHN DERRICK",
    "number_masked": "4291**********48",
    "number": "5717e6470392f4865596c394e69740f7",
    "exp_month": "02",
    "exp_year": "2026",
    "cvv": "2f019c0bfc6df5ace5c2341fc840fcf0",
    "pin": null,
    "billing_address": {
      "address_type": "mailing",
      "city": "Missouri",
      "country": "US",
      "line1": "2632 Bouillon Way",
      "line2": "",
      "postal_code": "012916",
      "state": "BA"
    },
    "is_deleted": false,
    "status": "active",
    "created_at": "2023-02-19T16:11:01Z",
    "updated_at": "2023-02-19T16:11:02Z"
  }
}

3. Card Frozen

This webhook event is fired when an active card is frozen as a result of excessive transaction declines on the card due to insufficient funds, or when the balance on the card falls below the minimum allowed threshold.

{
  "event_type": "card.frozen",
  "entity": "card",
  "data": {
    "id": "011b7b78b07011ed9e800242ac110002",
    "holder_id": "c74b2fb8a59911eda9df0242ac110002",
    "holder_type": "person",
    "balance": 40,
    "currency": "USD",
    "brand": "visa",
    "label": "Sandbox",
    "cardholder_name": "JOHN DERRICK",
    "number_masked": "4291**********48",
    "number": "5717e6470392f4865596c394e69740f7",
    "exp_month": "02",
    "exp_year": "2026",
    "cvv": "2f019c0bfc6df5ace5c2341fc840fcf0",
    "pin": null,
    "billing_address": {
      "address_type": "mailing",
      "city": "Missouri",
      "country": "US",
      "line1": "2632 Bouillon Way",
      "line2": "",
      "postal_code": "012916",
      "state": "BA"
    },
    "is_deleted": false,
    "status": "inactive",
    "created_at": "2023-02-19T16:11:01Z",
    "updated_at": "2023-02-19T16:11:02Z"
  }
}

4. Card Closed

This webhook event is fired when an active card is closed as a result of an inability to pay monthly load fees (due to a low balance).

{
  "event_type": "card.closed",
  "entity": "card",
  "data": {
    "id": "011b7b78b07011ed9e800242ac110002",
    "holder_id": "c74b2fb8a59911eda9df0242ac110002",
    "holder_type": "person",
    "balance": 5000,
    "currency": "USD",
    "brand": "visa",
    "label": "Sandbox",
    "cardholder_name": "JOHN DERRICK",
    "number_masked": "4291**********48",
    "number": "5717e6470392f4865596c394e69740f7",
    "exp_month": "02",
    "exp_year": "2026",
    "cvv": "2f019c0bfc6df5ace5c2341fc840fcf0",
    "pin": null,
    "billing_address": {
      "address_type": "mailing",
      "city": "Missouri",
      "country": "US",
      "line1": "2632 Bouillon Way",
      "line2": "",
      "postal_code": "012916",
      "state": "BA"
    },
    "is_deleted": true,
    "status": "closed",
    "created_at": "2023-02-19T16:11:01Z",
    "updated_at": "2023-02-19T16:11:02Z",
    "event_transaction": {
      "id": "01270a2fb07011ed9e800242ac110002",
      "object_type": "card",
      "card_id": "011b7b78b07011ed9e800242ac110002",
      "account_id": null,
      "account_type": null,
      "kind": "charge",
      "deposit_id": null,
      "payout_id": null,
      "charge_id": "0124be79b07011ed9e800242ac110002",
      "linked_transaction_id": null,
      "type": "debit",
      "description": "Sainsbury's Shopping",
      "origin": "platform",
      "category": "closure.liquidation",
      "currency": "USD",
      "amount": 124,
      "balance_before": 124,
      "balance_after": 0,
      "status": "successful",
      "created_at": "2023-02-19 16:11:02",
      "updated_at": "2023-02-19 16:11:02",
    }
  }
}