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
| Parameter | Description |
|---|---|
| payout_id | The id of the payout to cancel |
Example
Note
In this example, we assume that a Client has already been initialized and assigned to the
bitpayvariable.
bitpay.cancel_payout('payoutId')