Cancel an Invoice

delete https://test.bitpay.com/invoices/{invoiceId}

Facades: merchant

📘
Note
Cancellation will require EITHER an SMS or E-mail to have already been set if the invoice has proceeded to the point where it may have been paid, unless using forceCancel parameter.

Error Scenarios

Cancellation requires SMS/email. Next step: resubmit the request after updating the invoice with verified SMS or Email
Invoice is already complete. Next step, use the POST /refunds endpoint for this invoice

Path Params

invoiceId

string

required

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

Query Params

token

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.

forceCancel

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

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.

Responses

Language


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

Choose an example:

application/json

text/plain

📘Note

Error Scenarios

200200

5XX5XX

📘
Note