> ## 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 composto de Pix Automático a partir de sua URL

> Decodifica um QR code Pix composto a partir de sua URL de recorrência embutida (urlPayloadJsonRec), retornando a configuração da autorização de pagamento recorrente.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/composite/decode
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/pix-automatico/composite/decode:
    post:
      tags:
        - Pix Automático API
      summary: Decodificar QR code composto de Pix Automático a partir de sua URL
      description: >-
        Decodifica um QR code Pix composto a partir de sua URL de recorrência
        embutida (urlPayloadJsonRec), retornando a configuração da autorização
        de pagamento recorrente.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeCompositeBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeCompositeResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    DecodeCompositeBody:
      additionalProperties: false
      properties:
        recurrencePayloadUrl:
          description: >-
            A URL do host JWS de recorrência a decodificar (urlPayloadJsonRec;
            sem esquema).
          type: string
      required:
        - recurrencePayloadUrl
      type: object
    DecodeCompositeResponse:
      additionalProperties: false
      properties:
        amount:
          description: Valor fixo de pagamento em reais.
          format: double
          type: number
        contractDesc:
          description: Descrição de contrato em texto livre.
          type: string
        contractNumber:
          description: Identificador de contrato/pedido (nrContrato).
          type: string
        createdDateTime:
          description: Data/hora de criação do QR (dtHrCriacao).
          type: string
        debtor:
          $ref: '#/components/schemas/CompositeDebtorBody'
        endDate:
          description: Data do último pagamento (aaaa-mm-dd).
          type: string
        frequency:
          description: tpFrequencia.
          format: int64
          type: integer
        maxFloorAmount:
          description: Valor mínimo em reais (pisoValorMaximo).
          format: double
          type: number
        presentedDateTime:
          description: Data/hora de apresentação do QR (dtHrApresentacao).
          type: string
        recipient:
          $ref: '#/components/schemas/CompositeRecipientBody'
        recurrenceId:
          description: Id único de recorrência.
          type: string
        retry:
          description: política retentativa.
          format: int64
          type: integer
        startDate:
          description: Data do primeiro pagamento (aaaa-mm-dd).
          type: string
        updates:
          description: Histórico de status da recorrência (atualizacoes).
          items:
            $ref: '#/components/schemas/CompositeRecurrenceUpdateResponse'
          type: array
          nullable: true
      required:
        - recurrenceId
        - frequency
        - startDate
        - recipient
        - debtor
        - contractNumber
        - retry
      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
    CompositeDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF ou CNPJ do devedor (string).
          type: string
        name:
          description: Nome do devedor.
          type: string
        personType:
          description: Tipo de pessoa do devedor (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    CompositeRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: CNPJ do recebedor (14 dígitos, string).
          type: string
        ispb:
          description: ISPB do participante recebedor (8 dígitos, string).
          type: string
        name:
          description: Razão social/nome fantasia do recebedor.
          type: string
      required:
        - ispb
        - cnpj
        - name
      type: object
    CompositeRecurrenceUpdateResponse:
      additionalProperties: false
      properties:
        status:
          description: >-
            stRecorrencia
            (0=Created,1=Approved,2=Rejected,3=Expired,4=Cancelled).
          format: int64
          type: integer
        statusDateTime:
          description: Data/hora de atualização do status (ISO-8601).
          type: string
      required:
        - status
        - statusDateTime
      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).

````