Payout Automations

Payout Automations are optional workflows built with flows (type: payout) that add advanced orchestration on top of basic payout distribution.

When to Use Payout Automations

Basic payouts work without automations. Use automations for:

• Batched Payouts: Group multiple payouts for efficiency (reduce gas costs)
• Threshold-based: Trigger payouts when balance reaches threshold
• Multi-wallet Routing: Route payouts via different wallets/bridges
• Dynamic Fee Logic: Adjust splits based on plans, tiers, or partner-specific rules
• Complex Multi-level Splits: Multiple levels of partners, cascading distributions

Creating Payout Automations

Payout automations are flows with type: "payout":

1. Navigate to Payouts → Payout Automations
2. Click Create Payout Automation
3. Build your workflow using the Flow builder
4. Set flow status to "live" to activate

Example Automation: Batched Payouts

A batched payout automation might:

1. Trigger: Daily at 2 AM UTC
2. Action: Collect all pending payouts for merchant wallets
3. Action: Group by network/asset
4. Action: Execute batched payout (single transaction, multiple recipients)
5. Action: Update payout statuses

Flow Builder

Payout automations use the same Flow builder as other automations:

• Payment Node: Input payment_id → payment attributes
• Conditional Nodes: Route based on amount, network, beneficiary
• Action Nodes: Execute payouts, update status, trigger webhooks
• Wait Nodes: Delay between steps

Related Documentation

• Payouts Overview - Payout concepts
• Payout Ledger - Payout tracking
• Flows - Flow builder documentation