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
| Status | Meaning | Webhook |
|---|---|---|
pending | The payout was created and the wallet debited | payout_received |
completed | The bank confirmed the payout | payout_completed |
failed | Either the bank rejected it, or Vendy declined it. See below | payout_failed only when Vendy declined it |
cancelled | The payout was cancelled before processing and the wallet refunded | payout_cancelled |
A bank rejection isn't finalIf 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 ascompleted.
payout_failedis sent only when Vendy declines the payout. The wallet is refunded and the payout is final.
See Payouts events for the webhook payloads.
