payout.updated
payout.updated replaces the deprecated payout.update. During the migration, both names are delivered for the same transition — payout.updated (new) and payout.update (legacy) — so you can migrate without missing events. payout.update is deprecated and will be removed on 15 November 2026; switch your payout handling to payout.updated before then.type is always payout.updated regardless of the transition — read data.state (and data.previousState) to know what happened. See Webhooks overview for delivery, headers, and signature verification.
data fields
string
Stable identifier for this payout event. The same value is sent on the legacy
payout.update during the transition — use it to deduplicate the two names.string
The payout identifier.
string
Your company identifier.
string
Your external reference, if one was provided.
string
The end user/entity the payout was made for.
string | null
The state before this transition.
null on the first event.string
The current payout state. See the table below.
number
The payout amount, in minor units (e.g. cents).
string
The destination currency.
string
One of
wallet, bank, or qr_code.string
Present only when the payout failed.
string
On-chain transaction hash. Present for
wallet and bank destinations.object
Bank-rail metadata. Present only for
destinationType = bank.string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp.