Skip to main content
POST
Generates a Pix v2

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The generation Pix v2 attributes

Body params to generate a Pix v2

amount
integer
required

Amount

Required range: x <= 100000000000
reference
string
required

Receiver Pix key or receiver brcode

type
enum<string>
required

Pix reference type

Available options:
key,
brcode
virtual_account_id
string<uuid>
required

Unique identifier

description
string

Pix description

external_id
string

External ID

platform_id
string | null

Platform ID

reference_bank_accounts
ReferenceBankAccount · object[]

Receiver bank account list reference

reference_tax_number
string

Receiver tax number reference

Response

GeneratePixV2

Response schema for a single Pix generation

data
object