Overview

The Settlement APIs move funds out of your Vendy wallets to a payout account you've saved. A payout account can be a bank account or a mobile money wallet. Every request needs your AccessKey and SecretKey.

To send money to an account you haven't saved, use Transfers instead.

Payout process flow

1. List Banks to get the bank code.
2. Validate the bank account to confirm it exists and get the account name.
3. Add a payout account using the details from validation.
4. Initiate a payout from a wallet into the payout account.
5. Optional: list payouts and their status, or get one payout.
6. Optional: cancel a payout while it is still pending.

Track each payout with payout webhook events.