Request an Invoice Webhook to be Resent

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.

Response

Name Type
data
set to "Success" once the webhook has been resent for the current invoice status
string

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
string
required

The id of the invoice for which you want the last webhook to be resent.

Body Params
string
required

The resource token for the invoiceId you want the webhook to be resent. You first need to retrieve this token from the invoice object itself, using the merchant facade (see section Retrieve an invoice).

Headers
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.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json