event names what happened and data carries it, so the objects below are what arrives in data.
Every payload carries an event_id. Key on it to ignore a repeat.
Sub-client
user.created
user.created
user.status_changed
user.status_changed
user.verification.accepted
user.verification.accepted
user.verification.failed
user.verification.failed
reasons is the decline’s only record. See Sub-client.Virtual account and deposits
virtual_account.activated
virtual_account.activated
virtual_account.status_changed
virtual_account.status_changed
virtual_account.deposit_funds_received
virtual_account.deposit_funds_received
- Bank transfer
- Crypto inbound
status is pending until the dollars are credited, and amount is in the token that arrived. On a crypto inbound, source also carries the network, the transaction and the sending wallet as sender_address. A deposit you read names that wallet source.address.virtual_account.deposit_funds_in_transit
virtual_account.deposit_funds_in_transit
virtual_account.deposit_funds_in_destination
virtual_account.deposit_funds_in_destination
- Crypto inbound
- Bank transfer to a crypto account
fees and net_amount are the same figures the deposit returns when you read it.virtual_account.deposit_funds_failed
virtual_account.deposit_funds_failed
failure_reason lists every reason a crypto inbound can carry. A failed settlement on a crypto account sends the same event with a free-text failure_reason. A deposit compliance declined reads KYT_REJECTED when you read it, while this webhook’s status is failed.virtual_account.deposit_funds_refunded
virtual_account.deposit_funds_refunded
- Bank transfer
- Crypto inbound
return_details adds network, destination_address and tx_hash. tx_hash is the transaction that sent the tokens back, null while it is not known. created_at is when the deposit arrived, as on every deposit notice. return_details.refunded_at is when it went back. return_details is always present, with reason:returned_by_bank: the bank sent it back. Nothing else is added.compliance_review: Kira sent it back to its sender after a compliance review.amountis what went back, after the returnfee, incurrency, when Kira moved money to send it. When compliance declines a bank deposit before its arrival was announced, its return is not announced either.returned_to_client_wallet: a crypto inbound, returned to the wallet you named.amountis what reached it, after the returnfee, in the token that arrived.
source.payment_rail is null when the rail is not known. Read every source.* and return_details.* field past reason and refunded_at defensively. Which ones are present depends on the rail.Payouts
payout.status_changed
payout.status_changed
payout.completed
payout.completed
amount and recipient_amount differ by the fees and any conversion.Requests for information
These reach a URL with no event filter, or one whose filter names them.rfi.raised
rfi.raised
rfi.item_returned
rfi.item_returned
to_status here is the item’s, not the request’s.rfi.resolved
rfi.resolved
rfi.not_resolved
rfi.not_resolved
resolution_reason arrives only on this one. It is the difference between a deadline that ran out and an answer that was refused.Every payload carries
to_status read off the row that moved, rather than inferred from the event name. A handler that stores the event can reconstruct state without knowing which events existed on the day it was written.