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 |
|---|---|
| payoutId | The ID of the payout to cancel. |
Example
Boolean cancelledPayout = bitpay.cancelPayout("JMwv8wQCXANoU2ZZQ9a9GH");