Payouts

Getting started with payouts

A payout account is an account on Vendy where proceeds from transactions and commissions can be withdrawn. This account can be either a bank account or a mobile money wallet.

This account can be added via the API or on the merchant application.

Payouts are initiated to withdraw funds from wallets which are paid into payout accounts described above.

Payout process flow

1. Get a list of supported banks
   https://vendy.readme.io/reference/bank-codes

2. Validate the destination bank account exists
   https://vendy.readme.io/reference/validate-bank

3. Create a payout account using the bank details from validation
   https://vendy.readme.io/reference/create-payouts

4. Withdraw into the payout account
   https://vendy.readme.io/reference/request-payouts

5. Get a list of payouts and their status (optional)
   https://vendy.readme.io/reference/get-payouts-for-business

6. Get payout details (Optional)
   https://vendy.readme.io/reference/get-payout-details

7. Cancel pending payout (Optional)
   https://vendy.readme.io/reference/cancel-payout