Skip to main content
POST
Create a new dynamic Pix QRCode

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

Pix QRCode payload

Body params to create a dynamic QRCode

amount
integer
required

Amount value of the dynamic QRCode

options
object
required

QRCode creation options

virtual_account_id
string
required

Virtual Account ID

counterparty
object

Counterparty information

description
string

Description of the dynamic QRCode

expiration_datetime
string<date-time>

Expiration datetime

external_id
string

External ID of the dynamic QRCode

platform_id
string | null

Platform ID of the dynamic QRCode

splits
(SplitPaymentFixedCreateParams · object | SplitPaymentPercentageCreateParams · object)[] | null

Split payment allocations to apply after the Pix QRCode transaction is received and settled. Use fixed for amounts in cents or percentage for a percentage of the received amount. Percentage allocations cannot total more than 100. Fixed allocations cannot total more than the paid amount. Any remaining value stays with the original receiver.

Fixed split payment information used to transfer part of the received transaction after settlement. The total fixed split amount cannot exceed the paid amount. Any remaining value stays with the original receiver.

Example:

Response

Pix QRCode

Response schema for a single dynamic QRCode

data
DynamicQRCodeData · object

Response schema for a single dynamic QRCode

Example: