The Vendy Settlement Apis consists of APIs used to transmit funds out of Vendy wallets to a defined payout account. A payout account can be a bank account or a mobile money wallet. All endpoints in this section requires that the requests are authenticated.
Payout process flow
-
Get a list of supported banks
https://vendy.readme.io/reference/bank-codes -
Validate the destination bank account exists
https://vendy.readme.io/reference/validate-bank -
Create a payout account using the bank details from validation
https://vendy.readme.io/reference/create-payouts -
Withdraw into the payout account
https://vendy.readme.io/reference/request-payouts -
Get a list of payouts and their status (optional)
https://vendy.readme.io/reference/get-payouts-for-business -
Get payout details (Optional)
https://vendy.readme.io/reference/get-payout-details -
Cancel pending payout (Optional)
https://vendy.readme.io/reference/cancel-payout