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

# Decode a PIX QR code via its payload URL

> Decodes a dynamic PIX QR code by the payee-published JWS payload URL (JDPI §8.3.10), normalizing static / immediate-dynamic / cobv sub-types into one null-safe response. Unlike the scan decode it takes a urlPayloadJson the JDPI fetches; the payer document is sourced from the CRM alias for the JDPI decode header.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/qrcodes/decode/url
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/qrcodes/decode/url:
    post:
      tags:
        - QR Codes
      summary: Decode a PIX QR code via its payload URL
      description: >-
        Decodes a dynamic PIX QR code by the payee-published JWS payload URL
        (JDPI §8.3.10), normalizing static / immediate-dynamic / cobv sub-types
        into one null-safe response. Unlike the scan decode it takes a
        urlPayloadJson the JDPI fetches; the payer document is sourced from the
        CRM alias for the JDPI decode header.
      operationId: decodeQRCodeByURL
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeURLQRBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeQRResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    DecodeURLQRBody:
      additionalProperties: false
      properties:
        accountId:
          description: >-
            The CRM account id of the scanning payer (sources the PI-PayerID
            document).
          examples:
            - acc-123
          type: string
        municipalityCode:
          description: Payer municipality code (codMun; cobv holiday calc).
          examples:
            - '3550308'
          type: string
        payloadUrl:
          description: >-
            The payee-published JWS payload URL to decode (urlPayloadJson;
            schema-less).
          examples:
            - example.com/pix/8b3da2f3
          type: string
        paymentDate:
          description: Intended payment date (dPP; aaaa-mm-dd; cobv valorFinal calc).
          examples:
            - '2026-01-30'
          type: string
      required:
        - payloadUrl
        - accountId
      type: object
    DecodeQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: The decoded amount in centavos.
          examples:
            - 10050
          format: int64
          type: integer
        amountTroco:
          description: The Pix Troco amount in centavos (troco only).
          examples:
            - 0
          format: int64
          type: integer
        city:
          description: Recipient city (cidade; §8.3.3 Obrg=Sim on every block).
          examples:
            - Sao Paulo
          type: string
        createdAt:
          description: When the dynamic charge was created (dtHrCriacao; §8.3.3 Obrg=Sim).
          examples:
            - '2020-01-20T12:29:15.043Z'
          type: string
        description:
          description: Additional data (dadosAdicionais).
          examples:
            - Invoice 42
          type: string
        dueDate:
          description: Due date (cobv/static optional).
          examples:
            - '2026-12-31'
          type: string
        endToEndId:
          description: The SPI end-to-end id.
          examples:
            - E1234567890
          type: string
        isPixSaque:
          description: Whether the QR carries a Pix Saque leg.
          examples:
            - false
          type: boolean
        isPixTroco:
          description: Whether the QR carries a Pix Troco leg.
          examples:
            - false
          type: boolean
        ispbPss:
          description: >-
            The saque/troco PSS participant ISPB (a v5.5.0 string; leading zeros
            are significant).
          examples:
            - '00360305'
          type: string
        key:
          description: The recipient PIX key.
          examples:
            - recipient@bank.com
          type: string
        payee:
          $ref: '#/components/schemas/DecodePayeeResponse'
          description: The decoded recipient identity.
        presentedAt:
          description: >-
            When the payer captured the QR, i.e. the moment of this decode
            (dtHrApresentacao; §8.3.3 Obrg=Sim).
          examples:
            - '2020-01-23T10:21:34.107Z'
          type: string
        qrCodeType:
          description: The decoded QR type (STATIC or DYNAMIC; cobv folds onto DYNAMIC).
          examples:
            - DYNAMIC
          type: string
        revision:
          description: >-
            Charge revision counter (revisao). Always present on a DYNAMIC
            decode, including at its initial value 0; absent on a STATIC one,
            whose §8.3.3 block declares no revisao.
          examples:
            - 0
          format: int64
          type: integer
        txId:
          description: Conciliation id (idConciliacaoRecebedor).
          examples:
            - TX-001
          type: string
      required:
        - qrCodeType
        - amount
        - payee
      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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    DecodePayeeResponse:
      additionalProperties: false
      properties:
        accountDigit:
          description: Recipient account check digit (split from the wire account).
          examples:
            - '7'
          type: string
        accountNumber:
          description: Recipient account number (split from the wire account).
          examples:
            - '123456'
          type: string
        accountType:
          description: Numeric eAccountType (0=Conta Corrente).
          examples:
            - 0
          format: int64
          type: integer
        branch:
          description: Recipient agency/branch.
          examples:
            - '0001'
          type: string
        document:
          description: Recipient document (CPF/CNPJ).
          examples:
            - '12345678909'
          type: string
        ispb:
          description: Recipient participant ISPB.
          examples:
            - '12345678'
          type: string
        keyType:
          description: >-
            Numeric eKeyType from §8.3.3 tpChave
            (CPF=0,CNPJ=1,EMAIL=2,PHONE=3,RANDOM=4).
          examples:
            - 2
          format: int64
          type: integer
        name:
          description: Recipient holder name.
          examples:
            - Jane Doe
          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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````