Cancel a Payout Group

delete https://test.bitpay.com/payouts/group/{groupId}

Facades: payout

Response

Name	Type
`cancelled` An array of payout objects that were successfully cancelled. A description of all payout fields is available in the [resource](#rest-api-resources-payouts-resource) section.	`array`
`failed` An array of objects representing the payouts that failed to cancel.	`array`
`errMessage` The error message or reason the payout cancellation may have failed.	`string`
`payoutId` The id of the payout that failed.	`string`

Path Params

groupId

string

required

The the groupId of the collection of payouts you want to cancel.

Query Params

token

string

required

Approved payout facade token.

Headers

Content-Type

string

required

Defaults to application/json

Must be set to application/json for requests to the BitPay API

X-Accept-Version

string

required

Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

X-Identity

string

required

The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

X-Signature

string

required

The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

Response

Language


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://test.bitpay.com/payouts/group/groupId \
3
     --header 'Content-Type: application/json' \
4
     --header 'X-Accept-Version: 2.0.0' \
5
     --header 'accept: application/json'

Choose an example:

application/json

Response

200200