For the complete documentation index, see llms.txt. This page is also available as Markdown.

Payout status flow

status
Final state?
Description

draft

no

A payout draft has been created. Only returned when using the optional draft flow. The draft must be confirmed within 30 seconds, otherwise it expires and is cancelled.

processing

no

The payout has been accepted and is in flight. The transaction is being prepared and broadcast, or has been broadcast and is awaiting its first on-chain confirmation.

completed

yes

The transaction has received at least one on-chain confirmation.

cancelled

yes

The payout did not complete and will not proceed. Possible causes include an address flagged during compliance screening, insufficient account balance, an expired or rejected draft, or an unexpected issue during processing.

Processing is immediate in most cases. Delays can occur when a transaction requires compliance review or when liquidity needs to be rebalanced before the transaction can be broadcast.

Approval status

Dashboard-initiated payouts subject to an approval rule carry an additional approvalStatus field reflecting where the payout sits in the approval workflow. API-created payouts always return null for this field.

See the Approvals feature guide for how approval rules work.

Last updated