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
$cancelledPayout = $bitpay->cancelPayout("JMwv8wQCXANoU2ZZQ9a9GH");
Response Body Fields
| Name | Description | Type |
|---|---|---|
status | Set to success in case of successful request and to error if the request failed, a description of the error will then be indicated in the message field. | string |
code | Reserved for future use. | number |
data | Empty data object {}. | object |
message | In case of error, this field will contain a description message. Set to null if the request is successful. | string |
HTTP Response
{
"status": "success",
"data": {},
"message": null
}