Retrieve Static QR Code Details

Use this endpoint to retrieve a static Pix BR Code by its BTG id. The read is institution-wide: any code issued with the institution’s BTG credentials is returned, whichever account created it, and X-Account-Id is not read.

GET /v1/brcode/static/{brcode_id}

Retrieve Static QR Code Details

cURL

curl --request GET \
  --url https://api.example.com/v1/brcode/static/{brcode_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "createdAt": "2024-01-15T10:30:00Z",
  "emv": "000201010212...",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "receiverKey": "[phone]",
  "amount": "100.00",
  "base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "description": "Payment for order #12345",
  "merchant": {
    "categoryCode": "5411",
    "city": "São Paulo",
    "name": "Loja ABC",
    "postalCode": "01310000"
  },
  "tags": [
    "checkout",
    "web"
  ],
  "txId": "ORDER-12345"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

brcode_id · string · requerido

Static BR Code identifier

Respuesta

200

application/json

OK

createdAt · string · requerido

Timestamp when the BR Code was created

Ejemplo:

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

emv · string · requerido

QR code payload in EMV format

Ejemplo:

"000201010212..."

id · string · requerido

Unique identifier of the BR Code

Ejemplo:

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

receiverKey · string · requerido

Pix key that will receive the payment

Ejemplo:

"[phone]"

amount · string

Fixed payment amount (optional)

Ejemplo:

"100.00"

base64 · string

Base64-encoded QR code image (when requested)

Ejemplo:

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

description · string

Custom message or description shown to the payer

Ejemplo:

"Payment for order #12345"

merchant · object

Merchant metadata for this BR Code

Show child attributes

tags · string[]

Array of custom tags for categorization

Ejemplo:

["checkout", "web"]

txId · string

Transaction identification (txid) sent on the payment message

Ejemplo:

"ORDER-12345"