Account

You can expect to receive webhook events whenever an account is successfully created.

Event Category:

ACCOUNT

Event Type:

ACCOUNT.ONRAMP: Creation or updates of onramp accounts.
ACCOUNT.OFFRAMP: Creation or updates of offramp accounts.
ACCOUNT.VIRTUAL_ACCOUNT: Creation or updates of virtual accounts.

Event Action:

CREATE
UPDATE

Example webhook event

The data object is expected to have the same structure as the response from the Get Account endpoint.

{
  "eventId": "evt_1934b4c45b35a61925",
  "eventCategory": "ACCOUNT",
  "eventType": "ACCOUNT.OFFRAMP",
  "eventAction": "CREATE",
  "createdAt": "2024-11-20T20:38:30.255Z",
  "timestamp": "2024-11-20T20:38:40.791Z",
  "data": {
    "name": "Bank Account Name",
    "rail": {
      "currency": "brl",
      "railType": "offramp",
      "paymentRail": "pix"
    },
    "type": "pix",
    "userId": "3b0d06c8-85dd-498c-ae37-1a1d5c4ea35a",
    "pix_key": "12947674725",
    "accountId": "ae566056-1f10-400e-89d1-73f27aa8e289"
  }
}