Generate BR Code

Prerequisite: for a dynamic QR, the cob/cobv charge must be created first (see putCob, putCobV) — the payload links to it by txid/locator. Generates a new BR Code (QR code) payload following the EMV QRCPS-MPM standard.

POST /api/v1/brcode/

Generate BR Code

cURL

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "<string>",
  "merchantCity": "<string>",
  "merchantName": "<string>",
  "pixKey": "<string>",
  "amount": "<string>",
  "arrangementType": "<string>",
  "merchantCategoryCode": "<string>",
  "txId": "<string>"
}
'

201

{
  "createdAt": "<string>",
  "id": "<string>",
  "kind": "<string>",
  "merchantCity": "<string>",
  "merchantName": "<string>",
  "pixKey": "<string>",
  "status": "<string>",
  "updatedAt": "<string>",
  "amount": "<string>",
  "copyPaste": "<string>",
  "payloadUrl": "<string>",
  "qrPngBase64": "<string>",
  "qrPngContentType": "<string>",
  "raw": "<string>",
  "txId": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key · string

Idempotency key, max 255 characters

Body

application/json

kind · string · required

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

Example:

"STATIC"

merchantCity · string · required

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

Example:

"São Paulo"

merchantName · string · required

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

Example:

"Lerian Studio"

pixKey · string · required

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

Example:

"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.

Example:

"100.00"

arrangementType · string

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

Example:

"direct_participant"

merchantCategoryCode · string

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

Example:

"0000"

txId · string

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

Example:

"txid-abc-123"

Response

201

application/json

Created

createdAt · string · required

Creation timestamp in RFC3339 UTC.

Example:

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

id · string · required

Server-assigned payload identifier (UUID).

Example:

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

kind · string · required

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

Example:

"STATIC"

merchantCity · string · required

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

Example:

"São Paulo"

merchantName · string · required

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

Example:

"Lerian Studio"

pixKey · string · required

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

Example:

"12345678901"

status · string · required

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

Example:

"ACTIVE"

updatedAt · string · required

Last-update timestamp in RFC3339 UTC.

Example:

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

amount · string

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

Example:

"100.00"

copyPaste · string

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

Example:

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

payloadUrl · string

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

Example:

"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).

Example:

"iVBORw0KGgoAAAANSUhEUgAA..."

qrPngContentType · string

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

Example:

"image/png"

raw · string

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

Example:

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

txId · string

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

Example:

"txid-abc-123"