Skip to main content
GET
Retrieve Static QR Code Details

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

brcode_id
string
required

Static BR Code identifier

Response

OK

createdAt
string
required

Timestamp when the BR Code was created

Example:

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

emv
string
required

QR code payload in EMV format

Example:

"000201010212..."

id
string
required

Unique identifier of the BR Code

Example:

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

receiverKey
string
required

Pix key that will receive the payment

Example:

"+5511999999999"

amount
string

Fixed payment amount (optional)

Example:

"100.00"

base64
string

Base64-encoded QR code image (when requested)

Example:

"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."

description
string

Custom message or description shown to the payer

Example:

"Payment for order #12345"

merchant
object

Merchant metadata for this BR Code

tags
string[]

Array of custom tags for categorization

Example:
txId
string

Transaction identification (txid) sent on the payment message

Example:

"ORDER-12345"