Webhook event: balance_transfer.created.v1

Fired when a new balance adjustment is initiated against a client holdings account. The event includes details about the adjustment, direction, type, and initial payment status.

postWebhookbalance_transfer.created.v1

Payload

event_typestring required

Type of the event

event_idstring uuid required

UUID of the event

account_idstring uuid required

UUID of the account associated with this event

Example payload

{
  "event_type": "balance_transfer.created.v1",
  "event_id": "85df84c7-a298-44bc-8040-7bd2ae372cbf",
  "account_id": "857c679a-8e80-47f1-9334-39dd08ea801f"
}

Response

Webhook processed successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.