> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Get BR Code payload

> Retrieves a single BR Code payload by its UUID.



## OpenAPI

````yaml en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/{id}
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: BR Code service for QR code generation and decoding (EMV QRCPS-MPM).
  license:
    name: Lerian Studio General License
  title: Lerian SPI — BR Code API
  version: 1.0.0
servers:
  - url: https://spi.sandbox.lerian.net
security: []
tags:
  - description: EMV BR Code payload generation, decoding, validation, info, and lookup.
    name: BRCode
  - description: >-
      Pix charges (Cob/CobV/LoteCobV): create, retrieve by TxID, list, cancel,
      reconcile, and resolve public payloads.
    name: Charges
  - description: >-
      Flow (mandatory order): create cob/cobv → generate QR/payload. A dynamic
      BR Code payload references a charge, so the cob/cobv charge MUST be
      created first; the payload links to it by txid/locator.
    name: charge
paths:
  /api/v1/brcode/{id}:
    get:
      tags:
        - BRCode
      summary: Get BR Code payload
      description: Retrieves a single BR Code payload by its UUID.
      operationId: getBRCodePayload
      parameters:
        - description: Payload UUID
          in: path
          name: id
          required: true
          schema:
            description: Payload UUID
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    PayloadResponse:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Transaction amount in BRL as a decimal string, scale 2 (empty when
            the amount is open).
          examples:
            - '100.00'
          type: string
        copyPaste:
          description: >-
            Pix copy-and-paste string (the raw EMV payload); empty when
            unavailable.
          examples:
            - 00020126580014br.gov.bcb.pix...
          type: string
        createdAt:
          description: Creation timestamp in RFC3339 UTC.
          examples:
            - '2025-03-07T14:30:00Z'
          type: string
        id:
          description: Server-assigned payload identifier (UUID).
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        kind:
          description: 'BR Code kind: STATIC (reusable) or DYNAMIC (single-use).'
          examples:
            - STATIC
          type: string
        merchantCity:
          description: Merchant city from the EMV payload (EMV field 60).
          examples:
            - São Paulo
          type: string
        merchantName:
          description: Merchant legal/trade name from the EMV payload (EMV field 59).
          examples:
            - Lerian Studio
          type: string
        payloadUrl:
          description: >-
            Resolvable payload location URL for dynamic codes (empty for static
            codes).
          examples:
            - https://pix.example.com/qr/v2/550e8400
          type: string
        pixKey:
          description: >-
            Pix key identifying the receiver (CPF/CNPJ, phone, email, or random
            EVP key).
          examples:
            - '12345678901'
          type: string
        qrPngBase64:
          description: >-
            QR code image rendered from the raw payload, base64-encoded PNG
            (only populated on generation responses).
          examples:
            - iVBORw0KGgoAAAANSUhEUgAA...
          type: string
        qrPngContentType:
          description: >-
            MIME content type of qrPngBase64 (image/png) when an image is
            present.
          examples:
            - image/png
          type: string
        raw:
          description: >-
            Raw EMV BR Code string; same value as copyPaste, retained for
            compatibility.
          examples:
            - 00020126580014br.gov.bcb.pix...
          type: string
        status:
          description: Lifecycle status of the payload (e.g. ACTIVE).
          examples:
            - ACTIVE
          type: string
        txId:
          description: >-
            Merchant transaction identifier (EMV field 62.05); empty when not
            present.
          examples:
            - txid-abc-123
          type: string
        updatedAt:
          description: Last-update timestamp in RFC3339 UTC.
          examples:
            - '2025-03-07T14:30:00Z'
          type: string
      required:
        - id
        - kind
        - merchantName
        - merchantCity
        - pixKey
        - status
        - createdAt
        - updatedAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````