Skip to main content
GET
/
v1
/
brcode
/
static
/
{brcode_id}
Retrieve a Static QR Code
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/brcode/static/{brcode_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-4466554400bb",
  "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.

Path Parameters

​
brcode_id
string
required

Static BR Code identifier.

Response

Static QR Code details retrieved successfully.

​
id
string

QR Code unique identifier.

Example:

"550e8400-e29b-41d4-a716-4466554400bb"

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