Skip to main content
One payload per event, grouped by resource. Every delivery has the same envelope. 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

Fires on every transition. See Sub-client for why to subscribe to it.
reasons is the decline’s only record. See Sub-client.

Virtual account and deposits

The funds-ready signal. Nothing before it can receive money.
Sent when the account is frozen, unfrozen or deactivated. An unfreeze returns it to the status it had before the freeze. Both fields take the raw status values, whichever version you are pinned to.
The rail-independent signal that money arrived, sent once compliance approves the deposit. On a 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.
From a crypto inbound: Kira took the stablecoins to convert them to dollars.
From a crypto inbound: the dollars are on the account. fees and net_amount are the same figures the deposit returns when you read it.
From a crypto inbound. Not credited. Deposit 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.
The one refund event, the same shape on every rail. A crypto inbound’s refund carries these fields too, and its 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. amount is what went back, after the return fee, in currency, 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. amount is what reached it, after the return fee, 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

See Payouts for why to subscribe to this one.
Amounts are strings. 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.
to_status here is the item’s, not the request’s.
What the request was holding is released with this event.
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.