Understanding the workflow of a payout

Payouts go through a series of statuses in the payout workflow.

Status

Immutable?

Description

pending

No

The initial state of a payout. Payouts will remain in this state until a crypto address to send the payout to has been input, or the payout request is cancelled.

processing

No

After a crypto address has been provided, payouts transition into a processing state whilst the payout is being processed.

complete

Yes

Once funds have been paid out, the payout will transition to complete.

cancelled

Yes

If the payout is cancelled or fails, the state will transition to cancelled and the funds will remain in the merchant account.

❗️

Once you finalise a payout, please ensure no more API calls will be made to duplicate the withdrawal - transactions on the blockchain are final and cannot be recalled.


What’s Next
Did this page help you?