Skip to main content
POST
Gerar BR Code

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string

Idempotency key, max 255 characters

Corpo

application/json
kind
string
obrigatório

BR Code kind: STATIC (reusable, no expiry) or DYNAMIC (single-use, resolved via payload URL). Empty defaults to STATIC.

Exemplo:

"STATIC"

merchantCity
string
obrigatório

Merchant city encoded into the EMV payload (EMV field 60).

Exemplo:

"São Paulo"

merchantName
string
obrigatório

Merchant legal/trade name encoded into the EMV payload (EMV field 59).

Exemplo:

"Lerian Studio"

pixKey
string
obrigatório

Pix key identifying the receiver (CPF/CNPJ, phone, email, or random EVP key).

Exemplo:

"12345678901"

amount
string

Transaction amount in BRL as a decimal string, scale 2 (e.g. "100.00"). Empty leaves the amount open for the payer to set.

Exemplo:

"100.00"

arrangementType
string

Pix arrangement type governing MCC/key/amount constraints (e.g. direct_participant). Empty applies the default arrangement.

Exemplo:

"direct_participant"

merchantCategoryCode
string

ISO 18245 four-digit Merchant Category Code; 0000 indicates no specific category.

Exemplo:

"0000"

txId
string

Merchant transaction identifier (EMV field 62.05). Empty for static codes that omit a transaction reference.

Exemplo:

"txid-abc-123"

Resposta

Created

createdAt
string
obrigatório

Creation timestamp in RFC3339 UTC.

Exemplo:

"2025-03-07T14:30:00Z"

id
string
obrigatório

Server-assigned payload identifier (UUID).

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

kind
string
obrigatório

BR Code kind: STATIC (reusable) or DYNAMIC (single-use).

Exemplo:

"STATIC"

merchantCity
string
obrigatório

Merchant city from the EMV payload (EMV field 60).

Exemplo:

"São Paulo"

merchantName
string
obrigatório

Merchant legal/trade name from the EMV payload (EMV field 59).

Exemplo:

"Lerian Studio"

pixKey
string
obrigatório

Pix key identifying the receiver (CPF/CNPJ, phone, email, or random EVP key).

Exemplo:

"12345678901"

status
string
obrigatório

Lifecycle status of the payload (e.g. ACTIVE).

Exemplo:

"ACTIVE"

updatedAt
string
obrigatório

Last-update timestamp in RFC3339 UTC.

Exemplo:

"2025-03-07T14:30:00Z"

amount
string

Transaction amount in BRL as a decimal string, scale 2 (empty when the amount is open).

Exemplo:

"100.00"

copyPaste
string

Pix copy-and-paste string (the raw EMV payload); empty when unavailable.

Exemplo:

"00020126580014br.gov.bcb.pix..."

payloadUrl
string

Resolvable payload location URL for dynamic codes (empty for static codes).

Exemplo:

"https://pix.example.com/qr/v2/550e8400"

qrPngBase64
string

QR code image rendered from the raw payload, base64-encoded PNG (only populated on generation responses).

Exemplo:

"iVBORw0KGgoAAAANSUhEUgAA..."

qrPngContentType
string

MIME content type of qrPngBase64 (image/png) when an image is present.

Exemplo:

"image/png"

raw
string

Raw EMV BR Code string; same value as copyPaste, retained for compatibility.

Exemplo:

"00020126580014br.gov.bcb.pix..."

txId
string

Merchant transaction identifier (EMV field 62.05); empty when not present.

Exemplo:

"txid-abc-123"