Overview

Use these examples to choose a workflow pattern for automating payouts, scheduled transfers, wallet balance management, and event-driven money movement.

Workflows combine triggers, action steps, and runtime variables to move funds based on business rules. Start with the example closest to your use case, then adapt the workflow definition, trigger condition, and wallet or bank account details for your own integration.

Possible Use Cases

1. Automatically Direct Payouts to Other Destinations
   Redirect payout funds from a PayMongo Wallet to a bank account or another PayMongo Wallet when a payout event is received. Use this when you want payout deposits to be routed automatically instead of manually moving funds after settlement.

2. Schedule a Money Transfer from your PayMongo Wallet
   Run scheduled money transfers from a PayMongo Wallet using a cron-based trigger. Use this for recurring transfers, periodic disbursements, or timed wallet-to-wallet and wallet-to-bank movements.

3. Split A Payout
   Split one payout into exact shares using compute helpers such as monetary_percent and monetary_split, then send each share with separate send_money steps. Use this for marketplaces, platforms, commission models, and fee-sharing flows.

4. Sweeps Wallet On A Schedule
   Read a wallet balance on a schedule, calculate the amount above a reserve floor, and transfer the excess to another destination. Use this to consolidate balances into a parent wallet or settle funds to a bank account on a recurring cadence.

5. Top Up A Wallet On Low Balance
   Check a target wallet balance on a schedule and fund the gap from another wallet when the balance is below a target amount. Use this to keep operating wallets funded for outbound payments.

6. Hold A Payout Until Confirmed
   Hold funds in an escrow wallet until an external confirmation event arrives, then release the merchant share. Use this for marketplace delivery confirmation, fraud checks, or other approval-based payout flows.

Choosing a Pattern

Use an event-based trigger when the workflow should react to a PayMongo or application event, such as a payout deposit or order creation. Use a schedule-based trigger when the workflow should run at a fixed cadence, such as hourly, daily, weekly, or monthly.

For flows that calculate amounts, add a compute step before send_money. For flows that depend on a future confirmation, add a wait_event step and design an operational process for timeouts.