Cancel Payouts

Facades: payout

Overview

Cancel a specific payout batch request, based on the payout batch ID.

πŸ“˜

Note

It is very important that merchants implement this endpoint as it is the only way for them to cancel a payout prior to execution. Once a payout has been executed, the funds cannot be recovered.

Parameters

ParameterDescription
payout_idThe id of the payout to cancel

Example

πŸ“˜

Note

In this example, we assume that a Client has already been initialized and assigned to the bitpay variable.

bitpay.cancel_payout('payoutId')