Update an Invoice

Facades: merchant

Overview

Update an invoice with SMS or email in order to respond to a payment exception.

📘

Note

  • Updating the invoice will require EITHER an SMS or E-mail, but not both.
  • smsCode required only when verifying SMS.
  • autoVerify is only available in Sandbox environment.

Parameters

ParameterDescription
invoice_id *The id of the invoice to updated
buyer_emailThe buyer's email address
buyer_smsThe buyer's cell number
sms_codeThe buyer's received verification code

Example

📘

Note

In this example, we assume that a Client has already been initialized and assigned to the bitpay variable.

result = bitpay.update_invoice('someInvoiceId', '[email protected]')