Retrieve a Payout
Returns the Payout with its current state. The response surfaces the latest disbursement attempt as a convenience triple — never the full attempts list, count, or prior attempt IDs.
https://docs.usecleff.com/api-reference/payouts-get.md.Authorizations
Cleff API key, created in the dashboard under Settings → API keys
Path Parameters
Response
The full lifecycle step. Read it when you need the exact step, such as compliance_hold or settled; to decide what to do next, branch on status.
pending_approval, approved, rejected, disbursed, failed, returned, canceled, settled, compliance_hold Where the payout stands, in terms of what you do next. Derived from state and delivered_at, so it moves when they do. needs_approval: approve or reject it. processing: approved and being sent, including a pause for review. in_transit: the money has left your Cleff Account and has not arrived. delivered: the money has arrived in the Beneficiary's account; a late return can still follow. rejected, canceled, failed and returned: the payout ended without the payee being paid, though a failed payout with failure_code indeterminate may have moved the money.
needs_approval, processing, in_transit, delivered, rejected, failed, returned, canceled When the money arrived in the Beneficiary's account. Null until it does, and stays set if the payout is later returned.
Where the money goes, pinned when the Payout was created. A later change to the Beneficiary's declared destination does not move it. Null only on Payouts created before destinations were recorded.
bank, card Deprecated: read destination_id. Set only when the destination is a bank account, so it never carries a card's id.
Why the funds were sent. Provisional corridor-agnostic set.
advertising, advisor_fees, charity, education, family_support, investment, loan_repayment, medical, other, payroll, purchase_of_goods, purchase_of_services, real_estate, royalties, taxes, treasury, travel manual sandbox, production Who carried the Payout for Cleff. Opaque: quote it to Cleff support, but never branch on it, because its values change without notice.
The reference provider gave the Payout. Opaque, like provider.
The network that carried the payment, as the provider reported it: ach, rtp, fednow or card. Null until the provider reports one, and for a payout that never reached the provider.
ach, rtp, fednow, card Why the money did not move. Null until a Payout fails, and on rows that failed before the reason was recorded. indeterminate means Cleff does not know the provider's answer, which is not the same as a rejection.
insufficient_funds, business_not_enrolled, account_closed, account_invalid, account_frozen, account_unauthorized, account_not_enrolled, indeterminate The rail's own words for the failure, for a human to read. Never branch on it — the vocabulary is the provider's and it changes without notice.
Whose problem the failure is, resolved from failure_code. Route on this before refining to the code itself.
business, destination_account, unknown Whether this Payout can be answered with a replacement. False once one exists, and false for an indeterminate failure, where the money may already have moved.
person, business Channel through which the Intent arrived.