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

# Ver QR Code Dinâmico

> Obtém detalhes de um QR code PIX dinâmico específico pelo seu ID.



## OpenAPI

````yaml /api-reference/banking/openapi.pt.json get /v1/dynamic-qrcode/{id}
openapi: 3.1.0
info:
  title: API Conta Digital
  description: API pública para gerenciamento de conta, extrato e operações PIX
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://conta-public-api.kiwify.com
    description: Production environment
security: []
tags:
  - name: Conta
    description: Detalhes da conta, saldo, limites e chaves PIX
  - name: Extrato
    description: Extrato e histórico de transações
  - name: Enviar Pix
    description: Enviar dinheiro via transferências PIX
  - name: Receber Pix
    description: Reembolsar transações PIX
  - name: Pagar boletos
    description: Pagar boletos via API
  - name: QR Codes PIX
    description: Geração de QR codes PIX para receber pagamentos
  - name: Webhooks
    description: >-
      Gerenciamento de assinaturas de webhook para recebimento de notificações
      de eventos
paths:
  /v1/dynamic-qrcode/{id}:
    get:
      tags:
        - QR Codes PIX
      summary: Ver QR Code Dinâmico
      description: Obtém detalhes de um QR code PIX dinâmico específico pelo seu ID.
      operationId: get_dynamic_qrcode_details
      parameters:
        - name: id
          in: path
          description: QR code identifier
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: QR code details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDynamicQrcodeDetailsResponse'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - missing ManageQRCode permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: QR code not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - AccessId: []
          PoPChallenge: []
          PoPFormat: []
          PoPSignature: []
components:
  schemas:
    GetDynamicQrcodeDetailsResponse:
      type: object
      required:
        - id
        - type
        - status
        - amount_in_cents
        - accept_change_value
        - copy_paste_code
        - picture_code_base64
        - allowed_tax_ids
        - created_at
        - updated_at
      properties:
        accept_change_value:
          type: boolean
          description: Allows payer to change the QR code value when scanning
          example: false
        allowed_tax_ids:
          type: array
          items:
            type: string
          description: List of CPF/CNPJ allowed to pay this QR code. Empty if unrestricted.
          example:
            - 012.345.678-90
            - 45.059.493/0001-73
        amount_in_cents:
          type: integer
          format: int64
          description: Amount in cents
          example: 4000
        copy_paste_code:
          type: string
          description: PIX copy-paste code (BR Code)
          example: 00020126...
        created_at:
          type: string
          format: date-time
          description: QR Code creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        due_date:
          type:
            - string
            - 'null'
          format: date
          description: Due date (`YYYY-MM-DD`). Present for DUE_DATE type QR codes.
          example: '2026-06-01'
        external_reference_id:
          type:
            - string
            - 'null'
          description: External reference ID provided by the client (if any)
          example: order-12345
        id:
          type: string
          format: uuid
          description: Unique QR Code identifier
        payer_data:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PayerData'
              description: Payer information (required for DUE_DATE type)
        picture_code_base64:
          type: string
          description: QR Code image in base64 format
        status:
          $ref: '#/components/schemas/QRCodeStatus'
          description: 'QR Code status: active, cancelled, or completed'
        transaction:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ExternalApiTransactionDto'
              description: Most recent transaction that paid this QR code.
        type:
          $ref: '#/components/schemas/QRCodeType'
          description: 'QR Code type: INSTANT or DUE_DATE'
        updated_at:
          type: string
          format: date-time
          description: QR Code last update timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
    ErrorResponse:
      type: object
      required:
        - error
        - timestamp
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetails'
          description: Error payload.
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 / RFC 3339 UTC timestamp of when the error occurred.
          example: '2026-05-28T14:30:00Z'
    PayerData:
      type: object
      required:
        - name
        - document_number
        - document_type
      properties:
        document_number:
          type: string
          description: Payer CPF or CNPJ (with or without formatting)
          example: 012.345.678-90
        document_type:
          $ref: '#/components/schemas/DocumentType'
          description: Payer document type. "cpf"/"CPF" or "cnpj"/"CNPJ"
        name:
          type: string
          description: Payer full name
          example: João Silva
    QRCodeStatus:
      type: string
      enum:
        - waiting_payment
        - paid
        - cancelled
    ExternalApiTransactionDto:
      type: object
      required:
        - id
        - type
        - status
        - category
        - amount_in_cents
        - end_to_end_id
        - description
        - created_at
        - details
      properties:
        amount_in_cents:
          type: integer
          format: int64
          description: >-
            Transaction amount in centavos. Positive for credits, negative for
            debits.
        category:
          $ref: '#/components/schemas/AccountTransactionCategory'
          description: Transaction category.
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Transaction completion timestamp (UTC, RFC 3339). Null while
            pending.
          example: '2026-05-28T14:30:00Z'
        counterparty:
          type:
            - string
            - 'null'
          description: Counterparty name, when available.
        created_at:
          type: string
          format: date-time
          description: Transaction creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        description:
          type: string
          description: Human-readable transaction description.
        details:
          $ref: '#/components/schemas/ExternalApiTransactionDetails'
          description: Type-specific transaction details.
        end_to_end_id:
          type: string
          description: >-
            End-to-End (E2E) identifier of the PIX in the Central Bank's Instant
            Payment System.

            Format: `E{ISPB}{YYYYMMDD}{HHmmss}{UniqueID}` (e.g.:
            E323070002024011012345612345678901234).

            Used for tracking, reconciliation, and proof of PIX transactions.
          example: E323070002024011012345612345678901234
        id:
          type: integer
          format: int64
          description: Transaction identifier.
        med:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ExternalApiTransactionMedInfo'
              description: MED dispute/infraction context, when applicable.
        status:
          $ref: '#/components/schemas/TransactionStatus'
          description: Transaction status.
        type:
          type: string
          description: Transaction type (e.g., `pix_transfer`, `boleto_payment`).
    QRCodeType:
      type: string
      enum:
        - INSTANT
        - DUE_DATE
    ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: >-
            Machine-readable error code. Use this for branching logic, not
            `message`.
          example: INVALID_REQUEST
        details:
          type: object
          description: >-
            Optional structured details. For `INVALID_REQUEST`, may be an array
            of field validation errors or a `validation_failed` object depending
            on the endpoint.
        message:
          type: string
          description: >-
            Human-readable error description. Do not rely on this text for
            programmatic handling.
    DocumentType:
      type: string
      enum:
        - cpf
        - cnpj
    AccountTransactionCategory:
      type: string
      enum:
        - credit
        - debit
        - block
    ExternalApiTransactionDetails:
      oneOf:
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Pix
            value:
              $ref: '#/components/schemas/PixDetailsPayload'
          title: Pix
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Boleto
            value:
              $ref: '#/components/schemas/BoletoDetailsPayload'
          title: Boleto
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Refund
            value:
              $ref: '#/components/schemas/RefundDetailsPayload'
          title: Refund
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Judicial
            value:
              $ref: '#/components/schemas/JudicialDetailsResponse'
          title: Judicial
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Med
            value:
              $ref: '#/components/schemas/ExternalApiMedDetails'
          title: Med
    ExternalApiTransactionMedInfo:
      type: object
      required:
        - can_be_disputed
      properties:
        can_be_disputed:
          type: boolean
        incoming_infraction:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ExternalApiMedInfraction'
        outgoing_dispute:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ExternalApiMedDispute'
    TransactionStatus:
      type: string
      enum:
        - initial
        - pending
        - committed
        - voided
        - failed
    PixDetailsPayload:
      type: object
      required:
        - pix_type
        - sender
        - receiver
      properties:
        message:
          type:
            - string
            - 'null'
        pix_key:
          type:
            - string
            - 'null'
        pix_type:
          $ref: '#/components/schemas/PixType'
        receiver:
          $ref: '#/components/schemas/PartyInfo'
        sender:
          $ref: '#/components/schemas/PartyInfo'
    BoletoDetailsPayload:
      type: object
      required:
        - bar_code
        - inputtable_line
        - due_date
        - sender
        - receiver
        - assignor
      properties:
        assignor:
          type: string
        bar_code:
          type: string
        due_date:
          type: string
          format: date
          description: Boleto due date (`YYYY-MM-DD`).
          example: '2026-06-01'
        inputtable_line:
          type: string
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Payment confirmation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        receiver:
          $ref: '#/components/schemas/PartyInfo'
        sender:
          $ref: '#/components/schemas/PartyInfo'
    RefundDetailsPayload:
      type: object
      required:
        - amount_in_cents
        - refund_triggered_at
        - original_transaction_details
      properties:
        amount_in_cents:
          type: integer
          format: int64
        original_transaction_details:
          $ref: '#/components/schemas/ExternalApiRefundDetails'
        reason:
          type:
            - string
            - 'null'
        refund_triggered_at:
          type: string
          format: date-time
          description: Refund initiation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
    JudicialDetailsResponse:
      type: object
      required:
        - protocol_id
        - operation_type
      properties:
        action_nature_type:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ActionNatureType'
        judicial_process_number:
          type:
            - string
            - 'null'
        operation_type:
          $ref: '#/components/schemas/JudicialOperationType'
        protocol_id:
          type: string
    ExternalApiMedDetails:
      type: object
      required:
        - operation_type
        - infraction_id
        - infraction_external_id
        - original_end_to_end_id
      properties:
        infraction_external_id:
          type: string
        infraction_id:
          type: integer
          format: int64
        is_root_receiver:
          type:
            - boolean
            - 'null'
        operation_type:
          $ref: '#/components/schemas/MedOperationType'
        original_end_to_end_id:
          type: string
        original_pix_details:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PixDetailsPayload'
              description: >-
                Original cashin context for Return (root receiver). Counterparty
                CPF is masked.
        pix_details:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PixDetailsPayload'
              description: >-
                Role-swapped PIX payload SPI uses for the Return pacs.008 path.
                Counterparty CPF is masked.
    ExternalApiMedInfraction:
      type: object
      required:
        - id
        - transaction_id
        - end_to_end_id
        - status
        - original_amount_in_cents
        - refunded_amount_in_cents
        - created_at
        - original_transaction
      properties:
        created_at:
          type: string
          format: date-time
          description: Infraction creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        deadline:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Response deadline (UTC, RFC 3339). Derived from funds recovery
            `external_created_at` + 7 days when available.
          example: '2026-05-28T14:30:00Z'
        end_to_end_id:
          type: string
        funds_recovery:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ExternalApiMedFundsRecovery'
        id:
          type: integer
          format: int64
        original_amount_in_cents:
          type: integer
          format: int64
        original_transaction:
          $ref: '#/components/schemas/ExternalApiMedOriginalTransactionSummary'
        refunded_amount_in_cents:
          type: integer
          format: int64
        status:
          $ref: '#/components/schemas/PublicMedInfractionStatus'
        transaction_id:
          type: integer
          format: int64
    ExternalApiMedDispute:
      type: object
      required:
        - id
        - transaction_id
        - end_to_end_id
        - status
        - infraction_status
        - original_amount_in_cents
        - refunded_amount_in_cents
        - created_at
        - original_transaction
      properties:
        cancellation_requested_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp when cancellation was requested (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        created_at:
          type: string
          format: date-time
          description: Dispute creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        deadline:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Response deadline (UTC, RFC 3339). Derived from funds recovery
            `external_created_at` + 7 days when available.
          example: '2026-05-28T14:30:00Z'
        end_to_end_id:
          type: string
        funds_recovery:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ExternalApiMedFundsRecovery'
        id:
          type: integer
          format: int64
        infraction_status:
          $ref: '#/components/schemas/OutgoingInfractionStatus'
          description: >-
            How the contested PSPs analysed the contestation — orthogonal to
            `status`.
        original_amount_in_cents:
          type: integer
          format: int64
        original_transaction:
          $ref: '#/components/schemas/ExternalApiMedOriginalTransactionSummary'
        refunded_amount_in_cents:
          type: integer
          format: int64
        status:
          $ref: '#/components/schemas/PublicMedDisputeStatus'
        transaction_id:
          type: integer
          format: int64
    PixType:
      type: string
      enum:
        - Manual
        - Key
        - QRCode
    PartyInfo:
      type: object
      required:
        - name
        - document
        - bank
        - bank_code
        - account_number
        - account_type
      properties:
        account_number:
          type: string
        account_type:
          $ref: '#/components/schemas/AccountType'
        bank:
          type: string
        bank_code:
          type: string
        document:
          type: string
        name:
          type: string
    ExternalApiRefundDetails:
      oneOf:
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Pix
            value:
              $ref: '#/components/schemas/PixDetailsPayload'
          title: Pix
        - type: object
          required:
            - value
            - type
          properties:
            type:
              type: string
              enum:
                - Boleto
            value:
              $ref: '#/components/schemas/BoletoDetailsPayload'
          title: Boleto
    ActionNatureType:
      type: string
      enum:
        - civil
        - criminal
        - labor
        - fiscal
        - alimentary
    JudicialOperationType:
      type: string
      enum:
        - Block
        - Unblock
        - Return
    MedOperationType:
      type: string
      enum:
        - Block
        - Unblock
        - Return
    ExternalApiMedFundsRecovery:
      type: object
      required:
        - external_id
        - status
      properties:
        closed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: BACEN funds recovery closure timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        contact_email:
          type:
            - string
            - 'null'
        contact_phone:
          type:
            - string
            - 'null'
        external_created_at:
          type:
            - string
            - 'null'
          format: date-time
          description: BACEN funds recovery creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        external_id:
          type: string
        external_last_modified_at:
          type:
            - string
            - 'null'
          format: date-time
          description: BACEN funds recovery last modification timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        report_details:
          type:
            - string
            - 'null'
        reporter_participant:
          type:
            - string
            - 'null'
        root_transaction_id:
          type:
            - string
            - 'null'
        situation_type:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/MedOriginType'
        status:
          $ref: '#/components/schemas/MedFundsRecoveryStatus'
    ExternalApiMedOriginalTransactionSummary:
      type: object
      required:
        - created_at
      properties:
        counterparty_name:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
          description: Original transaction creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
    PublicMedInfractionStatus:
      type: string
      enum:
        - pending
        - completed
        - cancelled
    OutgoingInfractionStatus:
      type: string
      description: >-
        Derived, per-dispute view of how the contested PSPs analysed the
        contestation.

        Computed from the dispute's linked `med_outgoing_infractions`
      enum:
        - pending
        - accepted
        - rejected
        - cancelled
    PublicMedDisputeStatus:
      type: string
      enum:
        - pending
        - completed
        - cancelled
    AccountType:
      type: string
      enum:
        - checking_account
        - savings_account
        - prepaid_payment_account
        - payment_account
    MedOriginType:
      type: string
      description: |-
        Situation type from DICT API (SituationType).
        Set by the creator PSP when creating the Recuperação de Valores.
      enum:
        - scam_fraud
        - unauthorized_transaction
        - coercion_crime
        - fraudulent_access
        - others
        - unknown
    MedFundsRecoveryStatus:
      type: string
      enum:
        - created
        - tracked
        - awaiting_analysis
        - analysed
        - refunding
        - completed
        - cancelled
  securitySchemes:
    AccessId:
      type: apiKey
      in: header
      name: x-access-id
      description: UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)
    PoPChallenge:
      type: apiKey
      in: header
      name: X-PoP-Challenge
      description: >-
        Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5
        minutes of server time.
    PoPFormat:
      type: apiKey
      in: header
      name: X-PoP-Format
      description: Must be 'service-account' for service account authentication
    PoPSignature:
      type: apiKey
      in: header
      name: X-PoP-Signature
      description: >-
        EdDSA signature of the request in base64 format. Signs:
        uri:method:body:timestamp

````