> ## 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 un QR Pix mediante su URL de payload

> Decodifica un QR Pix dinámico mediante la URL de payload JWS publicada por el beneficiario, normalizando los subtipos static / immediate-dynamic / cobv en una única respuesta segura ante nulos. A diferencia de la decodificación por escaneo, toma una urlPayloadJson que el upstream obtiene; el documento del pagador proviene del alias del CRM para el header de decodificación del upstream.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/qrcodes/decode/url
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  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 un QR Pix mediante su URL de payload
      description: >-
        Decodifica un QR Pix dinámico mediante la URL de payload JWS publicada
        por el beneficiario, normalizando los subtipos static /
        immediate-dynamic / cobv en una única respuesta segura ante nulos. A
        diferencia de la decodificación por escaneo, toma una urlPayloadJson que
        el upstream obtiene; el documento del pagador proviene del alias del CRM
        para el header de decodificación del 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: Error
components:
  schemas:
    DecodeURLQRBody:
      additionalProperties: false
      properties:
        accountId:
          description: >-
            El id de cuenta del CRM del pagador que escanea (aporta el documento
            PI-PayerID).
          type: string
        municipalityCode:
          description: >-
            Código de municipio del pagador (codMun; cálculo de feriados de
            cobv).
          type: string
        payloadUrl:
          description: >-
            La URL de payload JWS publicada por el beneficiario que se va a
            decodificar (urlPayloadJson; sin esquema).
          type: string
        paymentDate:
          description: >-
            Fecha de pago prevista (dPP; aaaa-mm-dd; cálculo de valorFinal de
            cobv).
          type: string
      required:
        - payloadUrl
        - accountId
      type: object
    DecodeQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: El monto decodificado en reales.
          format: double
          type: number
        amountTroco:
          description: El monto de Pix Troco en reales (solo troco).
          format: double
          type: number
        bankIdPss:
          description: El ISPB del participante PSS de saque/troco.
          format: int64
          type: integer
        description:
          description: Datos adicionales (dadosAdicionais).
          type: string
        dueDate:
          description: Fecha de vencimiento (opcional para cobv/static).
          type: string
        endToEndId:
          description: El end-to-end id del SPI.
          type: string
        isPixSaque:
          description: Si el QR lleva un tramo de Pix Saque.
          type: boolean
        isPixTroco:
          description: Si el QR lleva un tramo de Pix Troco.
          type: boolean
        key:
          description: La clave Pix del beneficiario.
          type: string
        payee:
          $ref: '#/components/schemas/DecodePayeeResponse'
        qrCodeType:
          description: >-
            El tipo de QR decodificado (STATIC o DYNAMIC; cobv se pliega sobre
            DYNAMIC).
          type: string
        txId:
          description: Id de conciliación (idConciliacaoRecebedor).
          type: string
      required:
        - qrCodeType
        - amount
        - payee
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, acotado al
            servicio emisor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            Una explicación legible para humanos específica de esta ocurrencia
            del problema.
          type: string
        errors:
          description: Lista opcional de detalles de error individuales
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Una referencia URI que identifica la ocurrencia específica del
            problema.
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          format: int64
          type: integer
        title:
          description: >-
            Un resumen breve y legible para humanos del tipo de problema. Este
            valor no debería cambiar entre ocurrencias del error.
          type: string
        type:
          default: about:blank
          description: >-
            Una referencia URI a la documentación legible para humanos del
            error.
          format: uri
          type: string
      type: object
    DecodePayeeResponse:
      additionalProperties: false
      properties:
        accountDigit:
          description: >-
            Dígito verificador de la cuenta del beneficiario (separado de la
            cuenta del mensaje).
          type: string
        accountNumber:
          description: >-
            Número de cuenta del beneficiario (separado de la cuenta del
            mensaje).
          type: string
        accountType:
          description: eAccountType numérico (0=Conta Corrente).
          format: int64
          type: integer
        bankId:
          description: ISPB del participante beneficiario.
          type: string
        branch:
          description: Agencia/sucursal del beneficiario.
          type: string
        document:
          description: Documento del beneficiario (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: Nombre del titular beneficiario.
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Dónde ocurrió el error, p. ej. 'body.items[3].tags' o
            'path.thing-id'
          type: string
        message:
          description: Texto del mensaje de error
          type: string
        value:
          description: El valor en la ubicación indicada
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````