> ## 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.

# Decodificar QR code Pix pela URL de payload

> Decodifica um QR code Pix dinâmico pela URL de payload JWS publicada pelo recebedor, normalizando os subtipos estático / dinâmico-imediato / cobv em uma única resposta null-safe. Diferente da decodificação por scan, ele recebe uma urlPayloadJson que o upstream busca; o documento do pagador vem do alias do CRM para o cabeçalho de decodificação do upstream.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/qrcodes/decode/url
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/qrcodes/decode/url:
    post:
      tags:
        - QR Codes API
      summary: Decodificar QR code Pix pela URL de payload
      description: >-
        Decodifica um QR code Pix dinâmico pela URL de payload JWS publicada
        pelo recebedor, normalizando os subtipos estático / dinâmico-imediato /
        cobv em uma única resposta null-safe. Diferente da decodificação por
        scan, ele recebe uma urlPayloadJson que o upstream busca; o documento do
        pagador vem do alias do CRM para o cabeçalho de decodificação do
        upstream.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeURLQRBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeQRResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    DecodeURLQRBody:
      additionalProperties: false
      properties:
        accountId:
          description: >-
            O id da conta no CRM do pagador que escaneia (fonte do documento
            PI-PayerID).
          type: string
        municipalityCode:
          description: Código do município do pagador (codMun; cálculo de feriado da cobv).
          type: string
        payloadUrl:
          description: >-
            A URL de payload JWS publicada pelo recebedor a decodificar
            (urlPayloadJson; sem esquema).
          type: string
        paymentDate:
          description: >-
            Data pretendida de pagamento (dPP; aaaa-mm-dd; cálculo de valorFinal
            da cobv).
          type: string
      required:
        - payloadUrl
        - accountId
      type: object
    DecodeQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: O valor decodificado em reais.
          format: double
          type: number
        amountTroco:
          description: O valor do Pix Troco em reais (somente troco).
          format: double
          type: number
        bankIdPss:
          description: O ISPB do participante PSS de saque/troco.
          format: int64
          type: integer
        description:
          description: Dados adicionais (dadosAdicionais).
          type: string
        dueDate:
          description: Data de vencimento (cobv/estático opcional).
          type: string
        endToEndId:
          description: O id ponta a ponta do SPI.
          type: string
        isPixSaque:
          description: Se o QR carrega uma perna de Pix Saque.
          type: boolean
        isPixTroco:
          description: Se o QR carrega uma perna de Pix Troco.
          type: boolean
        key:
          description: A chave Pix do recebedor.
          type: string
        payee:
          $ref: '#/components/schemas/DecodePayeeResponse'
        qrCodeType:
          description: >-
            O tipo de QR decodificado (STATIC ou DYNAMIC; cobv se dobra em
            DYNAMIC).
          type: string
        txId:
          description: Id de conciliação (idConciliacaoRecebedor).
          type: string
      required:
        - qrCodeType
        - amount
        - payee
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    DecodePayeeResponse:
      additionalProperties: false
      properties:
        accountDigit:
          description: Dígito verificador da conta do recebedor (separado da conta do fio).
          type: string
        accountNumber:
          description: Número da conta do recebedor (separado da conta do fio).
          type: string
        accountType:
          description: eAccountType numérico (0=Conta Corrente).
          format: int64
          type: integer
        bankId:
          description: ISPB do participante recebedor.
          type: string
        branch:
          description: Agência do recebedor.
          type: string
        document:
          description: Documento do recebedor (CPF/CNPJ).
          type: string
        keyType:
          description: eKeyType numérico (CPF=0,CNPJ=1,EMAIL=2,PHONE=3,RANDOM=4).
          format: int64
          type: integer
        name:
          description: Nome do titular recebedor.
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````