Skip to main content

Approve and reject payouts

In case you want to integrate an additional layer of security to your payments, you can approve or reject payouts before they go out. For example, your customers may create a payout request, and your Ops team should verify and approve it. With the approval flows enabled, a payout will go to a pending state after the wallet details are provided. Then BVNK will wait for an Approve or a Reject call to proceed or cancel the payout.

There are several ways of working with approvals:

  • Portal: You can enable approval flows on the BVNK Portal and set the approval rules and limits.
  • API: Use it to integrate the approval logic in your own system or interface. To enable payout approval flows for the API flow, contact your Solutions consultant.
  1. Create a payout request as described in the Create a payout section.

  2. Once the payout is created, you will receive the redirectUrl in the response. Use it to redirect your customers to the Hosted payment page to collect the destination wallet details.

    {
    "redirectUrl": "https://pay.sandbox.bvnk.com/payout/79e520a8-d4d8-4a3c-983b-dd1d98acbe95"
    }

    If the approval flows are enabled, once your customer submits the wallet details on the hosted payment page the Payout will go to a processing state. It will then need to be approved by your Operations team.

  3. To approve or reject the payment send the POST /api/approval-workflow/v2/action request using the UUID value that you received in the payment response from Step 1 as the reference

    {
    "action": "APPROVE",
    "reference": [
    "79e520a8-d4d8-4a3c-983b-dd1d98acbe95"
    ]
    }