Supported events
transfer
transfer.initiatedPayload:
transactionId, details
Transfer initiated. Fires multiple times as the transfer advances — see Transaction lifecycle.
transfer.completedPayload:
transactionId, details
Transfer successfully completed.
transfer.failedPayload:
transactionId, details
Transfer failed. See Failure reasons.
withdrawal
withdrawal.initiatedPayload:
transactionId, details
Withdrawal initiated. Fires multiple times as the withdrawal advances — see Transaction lifecycle.
withdrawal.completedPayload:
transactionId, details
Withdrawal successfully completed.
withdrawal.failedPayload:
transactionId, details
Withdrawal failed. See Failure reasons.
deposit
deposit.attributedPayload:
transactionId
Deposit attribution completed.
deposit.pending-attributionPayload:
transactionId
New deposit pending attribution.
Transaction lifecycle (transfers and withdrawals)
Fortransfer and withdrawal, the three events, initiated, completed, and failed, track an operation across its whole lifecycle. Unlike other topics, initiated fires more than once: each time the operation reaches a new phase, a fresh initiated event arrives with a different details value. Read details to know where the operation is. completed fires once on success, and failed fires once on a terminal failure, each with its own details value.
Expanded lifecycle
details are rolling out per organization. If you don’t yet see a details field on your transfer and withdrawal events, notify your integration point of contact.initiated event carries one of these details values:
The
completed event carries a single details value, completed, once the operation settles successfully.
Failure reasons
Afailed event fires once if the operation ends unsuccessfully, carrying one of these details values:
Some
failed events arrive with no details field. Treat a missing details as an unspecified failure.
Because initiated now fires multiple times, order matters. Webhook delivery is at-least-once and events may arrive out of order, so use details rather than arrival order to track progress. See Delivery and reliability for handling duplicates and out-of-order events.