Payouts

Getting started with payouts

A payout moves money from one of your wallets to a payout account: a bank account or a mobile money wallet you've saved on Vendy. Add payout accounts via the API or on the merchant application.

The steps are listed in the Settlement overview.

Payout status

StatusMeaningWebhook
pendingThe payout was created and the wallet debitedpayout_received
completedThe bank confirmed the payoutpayout_completed
failedEither the bank rejected it, or Vendy declined it. See belowpayout_failed only when Vendy declined it
cancelledThe payout was cancelled before processing and the wallet refundedpayout_cancelled
📘

A bank rejection isn't final

If a bank rejects a payout, its status changes to failed, but no webhook is sent and your wallet isn't refunded yet. Vendy can retry it through another bank, so it may still end as completed.

payout_failed is sent only when Vendy declines the payout. The wallet is refunded and the payout is final.

See Payouts events for the webhook payloads.