Update an Invoice

put

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

In the case of a payment exception occurring on a non-HVT invoice (ie. where no communication details are present) the exception will be stranded and unable to be processed. Amend the invoice in order to handle the exception. HVT invoices cannot have their contact information updated after it is initially set.

Facades: merchant

Path Params

invoiceId

string

required

ID of the invoice to update

Body Params

buyerEmail

string

Buyer email address (Updating an invoice will require EITHER an SMS or E-mail).

buyerSms

string

SMS to use to process any payment exception if necessary, includes country code i.e. “+12223334444" (Updating an invoice will require EITHER an SMS or E-mail).

smsCode

string

Verification code in order to complete the SMS verification process (smsCode required only when verifying SMS).

token

string

required

Approved merchant facade token.

autoVerify

string

If provided alongside a valid SMS, will bypass the need to complete an SMS challenge (only available in the test environment).

status

string

TEST ENVIRONMENT ONLY
Can be forced to confirmed or complete.

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

Loading…

Response

Choose an example:

application/json

200200