Webhooks

Our Webhooks give your app the ability to listen in near real-time notifications of specific events that occur. To listen for events, you must register your webhook via the webhook registration endpoint. Once submitted we send you a POST request with a JSON structure as shown below. We expect that your endpoint return a 200 status to us promptly to avoid side effects like retries and timeouts.

Webhook Events

The list of event definitions supported by the API at the moment is stated below:

Virtual Accounts

• virtual_account.activity.created

• virtual_account.activity.updated

Transfers

• transfer.created

• transfer.updated

• transfer.updated.status_transitioned

Webhook Payload Structure

{
  "metadata": {
    "api_version": "v0",
    "event_id": "wh_t8trBtrPEqeFYLrQD9Zjog4",
    "event_created_at": "2024-02-01T04:34:13.763Z"
  },
   "event": {
    "category": "virtual_account.activity",
    "type": "virtual_account.activity.updated",
    "object_id": "fecffc8b-ed5e-48ae-bd24-b36268330b32",
    "object_status": null
  },
"payload": {
    "id": "fecffc8b-ed5e-48ae-bd24-b36268330b32",
    "type": "payment_submitted",
    "customer_id": "6ed47d9c-03be-420c-8699-369707ca02e9",
    "virtual_account_id": "22033ca5-a991-476c-ade9-911d10f0ece6",
    "deposit_id": "c7fab38f-7b65-42d3-bc8d-a694cd1901c1",
    "created_at": "2024-02-01T04:31:43.342Z",
    "transaction": {
      "source": {
        "description": "EXAMPLE TRANSACTION Brown-Beer Arnoldo Schimmel MD 01202024",
        "sender_name": "Brown-Beer",
        "payment_rail": "ach_push",
        "sender_bank_routing_number": "023883013"
      },
      "amounts": {
        "subtotal": "1970.0",
        "gas_fee": "0.0",
        "exchange_fee": "10.0",
        "developer_fee": "20.0",
        "total": "1970.0"
      },
      "currency": "usdc",
      "destination_tx_hash": "0xa7de792daa970f89cdb36dbce93026d10942ea24"
    }
  },
 "changes": {
    "destination_tx_hash": [
      null,
      "0xa7de792daa970f89cdb36dbce93026d10942ea24"
    ]
  }
  "event_created_at": "2024-02-01T04:34:13.763Z"
}