Cancel an Invoice by GUID

Facades: merchant

Path Params
string
required

The guid of the invoice for which you want to cancel.

Query Params
string
required

When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.

string

Parameter that will cancel the invoice even if no contact information is present. Note: Canceling a paid invoice without contact information requires a manual support process and is not recommended.

Headers
string
required
Defaults to application/json

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

string
required
Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

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.

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.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json
text/plain