Create Pix Charge

/invoice-pix


Possible status:
Currently, a Pix charge can only have three possible statuses:

  • Created – Payment created
  • Pending – Awaiting payment
  • Paid – Payment completed
  • Canceled – Payment error or charge canceled
Body Params
string
required

Payer reference ID

string
required

Charge name

string
required
Defaults to 100

Charge amount

string

Charge expiration date (YYYY-MM-DD)

string

Charge description

string
Defaults to 0.1

Late payment penalty. Value in percentage (e.g., if 10%, provide as 0.1)

string
required
Defaults to unique

Always "unique"

string
required
Defaults to pix

Always "pix"

string
Defaults to 8600

QR Code duration time in seconds

string
Defaults to 321323

Customer reference identifier

boolean
Defaults to false

Defines a unique document for cash-in from the registered Payer

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json