Update invoice by transaction id

put

https://api.stg.bavabank.com/pix/v1/accounts/{account_uuid}/invoices/{txid}

Endpoint to update an existing invoice by transaction id.

To be able to update the invoice, it must already exist and cannot have been paid.

After the update the revision_count field will be incremented by one.

Path Params

account_uuid

string

required

A universally unique identifier (UUID) of the account

txid

string

required

The txid field determines the transaction identifier.

It will be the main way to be able to reconcile a receipt

In transactions with online QRCode field will have up to 26-35 characters in offline transactions will have 1-25 characters

Body Params

Invoice update request data

Invoice request

expiration_time

integer

required

Expiration time in seconds.

customer_document

string

required

length between 11 and 14

^\d{11,14}$

Customer document.

customer_name

string

required

length ≤ 200

Customer name.

original_amount

string

required

^\d{1,10}\.\d{2}$

Original amount.

payment_label

string

required

length ≤ 200

Payment label presented to the payer.

meta_data

object

Key, Value properties. Can you chose which data you wanna storage with us associated with invoice and pix.

issuer_bava_code

string

^BVC+[A-Za-z0-9]{6}

Identification code issuer of QRCode.

Responses

401

Necessary Authentication token or you pass a invalid Token.

403

Necessary permission scope.

404

Resource not found.

406

Not acceptable for the Server.

500

Internal server error.

503

Service Unavailable.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated invoice data.

400For invalid param, json field or required field.