Payouts follow this state progression:
-
prepared
: Newly created payout awaiting merchant confirmation- Transitions to:
confirmed
(merchant accepts exchange rate) orexpired
(confirmation timeout)
- Transitions to:
-
confirmed
: Payout with exchange rate accepted by merchant- Transitions to:
sending
(scheduled for processing) orcanceled
(payout fails pre-processing checks)
- Transitions to:
-
sending
: Payout queued for processing in the next batch- Transitions to:
done
(successful processing)
- Transitions to:
-
done
: Payout successfully processed with transaction ID assigned- Final state, represents successful completion
-
expired
: Payout that wasn't confirmed within the required timeframe- Final state, cannot transition further
Data Purging
Similar to invoices, payouts which transition directly from prepared
to expired
status are subject to data purging after some retention period (e.g. a year).