Payouts

A payout represents the flow of funds from a client’s virtual account to an end user. A payout can be for an arbitrary amount if you have sufficient funds stored in your virtual account to cover the payout. Using Payouts requires integrating with virtual account API routes and receiving transaction webhooks.

Make sure your virtual account is set up before following these steps. For more information on setting up an account, see Managing virtual accounts.

1. Call /wallet/get to check your virtual account balance.

   • If you have insufficient funds to make your desired payout, make sure to fund your virtual account before proceeding. After funding your virtual account, another request to /wallet/get will show the updated balance.

2. Call /wallet/transaction/execute and store the transaction_id and status from the response.

   • If you have configured transaction webhooks, you will receive real-time status update webhooks for each payout transaction.

   • Alternatively, if not using webhooks, you can confirm the transaction has been executed by calling /wallet/transaction/get with the transaction_id.

You can begin testing Payouts in Sandbox by following the steps listed in the Add Virtual Accounts to your App guide. For Production access you will first need to submit a product access request Support ticket.