Skip to main content
A payout draws on a virtual account’s available balance and sends it to a counterparty you saved earlier. It is the lifecycle with the most states, and two of them surface in only one place.

What advances it

COMPLETED is not terminal. A bank rail can return an already-posted payout — for a request for information, an account error, or a post-settlement claw-back. That arrives as payout.returned and the payout becomes FAILED. Only FAILED, CANCELLED and EXPIRED are endings, so an integration that tells its customer the money landed on COMPLETED needs a path back from that.
IN_REVIEW and KYT_PENDING reach you only on payout.status_changed. See Payouts.

What announces it

Compare status values without case.

Corridors

A bank payout never carries a transaction hash, and a crypto payout never carries a wire reference. Which identifiers arrive is a property of the rail, not of the payout going well. See The payout object.

Where an RFI interrupts it

KYT_PENDING is the compliance hold on this lifecycle. The check is running, and the payout waits for it. A compliance check can also raise a request for information against the payout. That hold waits on you. status reads NEEDS_ACTION, and rfi names the request and its deadline. The hold that waits on you says what happens to the stage underneath. KYT_PENDING waits on Kira, and there is nothing for you to do. NEEDS_ACTION waits on you, and nothing moves until you answer. Treat either as a state you display, not one you resolve by retrying. Who releases it says why.

States

Every status on every resource, and what moves it.