Create a Static QR Code

curl --request POST \ --url https://plugin-pix-indirect.api.lerian.net/v1/brcode/static \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Account-Id: <x-account-id>' \ --data ' { "receiverKey": "+5511999999999", "amount": "100.00", "description": "Payment for order" } '

{ "id": "019c96a0-0bf7-7060-8f39-1bfbcb9168ca", "emv": "00020126580014br.gov.bcb.pix...", "base64": "<string>", "receiverKey": "+5511999999999", "amount": "100.00", "description": "Payment for order #12345", "createdAt": "2024-01-15T10:30:00Z" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id

string

required

Unique identifier of the Midaz Ledger Account (UUID format).

Query Parameters

include_base64

boolean

default:false

Returns the rendered QR code in base64 alongside the EMV payload.

Body

application/json

receiverKey

string

required

Pix key that will receive the payment.

Example:

"+5511999999999"

amount

string

Optional fixed amount.

Example:

"100.00"

description

string

Custom description.

Example:

"Payment for order #12345"

txId

string

Optional transaction identifier.

Example:

"TXabcdefghijklmno123456789"

Response

Static QR Code created successfully.

string

QR Code unique identifier.

Example:

"019c96a0-0bf7-7060-8f39-1bfbcb9168ca"

emv

string

EMV QR Code payload.

Example:

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

base64

string

Base64 encoded QR Code image (if requested).

receiverKey

string

Pix key.

Example:

"+5511999999999"

amount

string

Fixed amount (if set).

Example:

"100.00"

description

string

Description.

Example:

"Payment for order #12345"

createdAt

string<date-time>

Example:

"2024-01-15T10:30:00Z"