Approve, execute or cancel a wallet payout batch
Move a batch through the four-eyes workflow: approve it as a different person, execute the payout, retry failures or cancel it with a reason.
Have questions or need step-by-step guidance on this topic?
Step-by-Step Procedure
Open "Payout batches"
Each batch shows its id, status (DRAFT, APPROVED, EXECUTED, PARTIAL or CANCELLED), what it pays, who created and approved it, the settlement terms and each entry with its status.
Approve
On a DRAFT batch click "Approve". It is disabled for the person who created the batch (tooltip "A different person must approve"), and needs plan.approve. If you created the batch and are signed in as the Super Administrator, the button reads "Approve (self-approve as super admin)" and asks you to confirm; the approval is marked SELF_APPROVED_BY_SUPER_ADMIN and audited.
Execute
On an APPROVED batch click "Execute payout". A browser confirmation "Pay <totals> to <n> wallet(s)? This moves money." appears; confirm to pay. If some fail the banner reports "<n> paid, <m> failed: <reason>" and the batch becomes PARTIAL.
Retry failures
On a PARTIAL batch the button reads "Retry failed"; each entry is paid at most once however many times you run it.
Cancel
On a DRAFT or APPROVED batch click "Cancel", enter the reason in the prompt and confirm.
Check the audit chain
The line at the bottom says "Audit chain: intact (n entries)" or "BROKEN at ...".
The batch reaches EXECUTED with every entry SETTLED, or the cancellation is recorded.
Was this guide helpful?
Help us refine our platform documentation