balance.updated
Covers both fiat deposits (bank rail) and on-chain crypto deposits — tell them apart by the event name above, or by the chain name in the blockchain field (e.g. polygon, tron, stellar) for crypto. See Webhooks overview for delivery, headers, and signature verification.
The fields below describe bank-rail and on-chain deposits. Deposits made through a payment code (PIX in Brazil, QR in Bolivia) are also delivered under this legacy name, but carry a different set of fields — no
payoutId, blockchain or txHash, plus id, method and creditedUsdc, and a previousState that is not always null. See Fiat deposit updated for that payload.data fields
string
The deposit identifier (named
payoutId for transport consistency).string
Your company identifier.
string
Your external reference, if one was provided.
string | null
The state the deposit moved from. Always
null for bank-rail and on-chain deposits: a single deposit still produces several events as it progresses, but each one is reported on its own, so rely on state rather than on the transition.string
The current deposit state.
number
The deposit amount, in minor units.
string
The deposit currency (e.g.
usdc).string
The settlement rail for fiat deposits, or the chain name (e.g.
polygon, tron, stellar) for on-chain crypto deposits.string | null
On-chain transaction hash, when available.
string | null
Failure reason, when applicable.
string
ISO 8601 last-update timestamp.