API Reference

Create invoice for account

post
https://api.stg.bavabank.com/pix/v1/accounts//invoices

Endpoint to create an immediate invoice for account.

The generated invoice can be paid through the PIX up to its lifetime calculated based on expiration_time added to the current time in seconds.

Currently the currency used on the invoice is only brazilian currency BRL.

Path Params
string
required

A universally unique identifier (UUID) of the account

Body Params

Invoice create request data

Invoice request

integer
required

Expiration time in seconds.

string
required
length between 11 and 14
^\d{11,14}$

Customer document.

string
required
length ≤ 200

Customer name.

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

Original amount.

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.

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.

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?