Create static PIX QR Code

POST

/order/v1/banking/pix-static-qrcodes

• Production
• Sandbox

Generate a static PIX QR Code for a company account.

Authorizations

• Bearer

Parameters

Header Parameters

idempotency-key

required

string

Unique key for idempotent requests

Request Body ^required

object

accountId

required

Account identifier

string format: uuid

Example

f288ae0d-47fd-4207-aee4-0a384888bd96

pixKey

required

PIX key used for the QR Code

string

Example

john.doe@mailinator.com

amount

required

Amount

object

currency

required

Currency code

string

Allowed values: BRL

Example

BRL

value

required

Amount value as numeric string

string

Example

10.00

Example

{
  "currency": "BRL",
  "value": "25.00"
}

description

Description for the QR Code

string

Example

Static QRCode for invoice #123

Responses

200

object

id

required

Identifier of the generated QR Code

string

Example

qrcode-123

qrcodeImageBase64

required

QR Code image in base64

string

Example

iVBORw0KGgoAAAANSUhEUg...

qrcodeData

required

QR Code payload data

string

Example

000201010212...

amount

required

Amount info

object

currency

required

Currency

string

Allowed values: BRL USD ARS EUR CLP COP MXN PEN BUSD USDT

Example

BRL

value

required

Value as string

string

Example

25.00

Example

{
  "currency": "BRL",
  "value": "25.00"
}

description

required

Description used on QR Code

string

Example

Static QRCode for invoice #123

conciliationId

required

Conciliation identifier

string

Example

conciliation-123

400

Bad request

403

Forbidden

500

Internal error