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

# Criar QR code composto de Pix Automático CobV (com vencimento)

> Gera um QR code Pix composto embutindo dados de QR dinâmico com vencimento (cobrança com vencimento) e uma autorização de pagamento recorrente (Pix Automático). O nome e a cidade do recebedor vêm do CRM a partir da conta.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/composite/cobv
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/cobv:
    post:
      tags:
        - Pix Automático API
      summary: Criar QR code composto de Pix Automático CobV (com vencimento)
      description: >-
        Gera um QR code Pix composto embutindo dados de QR dinâmico com
        vencimento (cobrança com vencimento) e uma autorização de pagamento
        recorrente (Pix Automático). O nome e a cidade do recebedor vêm do CRM a
        partir da conta.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CobvCompositeBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositeResponse'
          description: Criado
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    CobvCompositeBody:
      additionalProperties: false
      properties:
        accountId:
          description: O id da conta no CRM do recebedor (fonte de nome + cidade).
          type: string
        certificateIspb:
          description: ISPB do certificado do PSP indireto (ispbCertificadoJws, string).
          type: string
        daysAfterDue:
          description: >-
            Dias após a data de vencimento em que a cobrança ainda pode ser paga
            (diasAposVenc).
          format: int64
          type: integer
        description:
          description: Entradas opcionais de dados adicionais (dadosAdicionais).
          items:
            $ref: '#/components/schemas/CompositeAdditionalDataBody'
          type: array
          nullable: true
        discount:
          description: Desconto em reais (desconto; omita/0 para pular).
          format: double
          type: number
        dueDate:
          description: Data de vencimento para pagamento (dtVenc; aaaa-mm-dd).
          type: string
        finalAmount:
          description: Valor final da cobrança em reais (valorFinal, após ajustes).
          format: double
          type: number
        fine:
          description: Multa em reais (multa; omita/0 para pular).
          format: double
          type: number
        interest:
          description: Juros em reais (juros; omita/0 para pular).
          format: double
          type: number
        jwkUrl:
          description: URL do JWK Set (urlJwk; sem esquema).
          type: string
        key:
          description: A chave Pix na qual o QR composto recebe.
          type: string
        originalAmount:
          description: >-
            Valor original da cobrança em reais (valorOriginal, antes de
            ajustes).
          format: double
          type: number
        payer:
          $ref: '#/components/schemas/CompositePayerBody'
        paymentPayloadUrl:
          description: URL do host JWS da CobV (urlPayloadJson; sem esquema).
          type: string
        rebate:
          description: Abatimento em reais (abatimento; omita/0 para pular).
          format: double
          type: number
        recipientStreet:
          description: Logradouro do recebedor (logradouroRecebedor).
          type: string
        recurrence:
          $ref: '#/components/schemas/CompositeRecurrenceBody'
        recurrencePayloadUrl:
          description: URL do host JWS de recorrência (urlPayloadJsonRec; sem esquema).
          type: string
        state:
          description: UF do recebedor (uf).
          type: string
        txId:
          description: Id de conciliação (idConciliacaoRecebedor).
          type: string
        zipCode:
          description: CEP do recebedor (cep).
          type: string
      required:
        - key
        - accountId
        - recipientStreet
        - state
        - zipCode
        - finalAmount
        - dueDate
        - daysAfterDue
        - txId
        - paymentPayloadUrl
        - recurrencePayloadUrl
        - jwkUrl
        - recurrence
      type: object
    CompositeResponse:
      additionalProperties: false
      properties:
        documentId:
          description: O id do documento da recorrência/cobrança (idDocumento, GUID).
          type: string
        qrCode:
          description: >-
            A EMV composta-QR gerada (payload decodificado em base64, pronto
            para renderizar).
          type: string
        recurrencePayload:
          description: O JWS de recorrência assinado (payloadJwsRecorrencia).
          type: string
      required:
        - qrCode
      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
    CompositeAdditionalDataBody:
      additionalProperties: false
      properties:
        name:
          description: O nome da entrada de dados adicionais.
          type: string
        value:
          description: O valor da entrada de dados adicionais.
          type: string
      required:
        - name
        - value
      type: object
    CompositePayerBody:
      additionalProperties: false
      properties:
        document:
          description: Documento do pagador (CPF/CNPJ, string).
          type: string
        name:
          description: Nome do pagador (só encaminhado com um documento).
          type: string
        request:
          description: Solicitação em texto livre ao pagador (solicitacaoPagador).
          type: string
      type: object
    CompositeRecurrenceBody:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Valor fixo de pagamento em reais (omita/0 para uma recorrência
            variável).
          format: double
          type: number
        contractDesc:
          description: Descrição de contrato em texto livre.
          type: string
        contractNumber:
          description: Identificador de contrato/pedido (nrContrato).
          type: string
        debtor:
          $ref: '#/components/schemas/CompositeDebtorBody'
        endDate:
          description: Data do último pagamento (aaaa-mm-dd).
          type: string
        frequency:
          description: tpFrequencia (0=Semanal,1=Mensal,2=Trimestral,3=Semestral,4=Anual).
          format: int64
          type: integer
        maxFloorAmount:
          description: >-
            Valor mínimo em reais (pisoValorMaximo; não válido com um valor
            fixo).
          format: double
          type: number
        recipient:
          $ref: '#/components/schemas/CompositeRecipientBody'
        recurrenceId:
          description: Id único de recorrência (29 caracteres, formato RR...).
          type: string
        retry:
          description: política retentativa (0=nenhuma, 1=até 3 retentativas em 7 dias).
          format: int64
          type: integer
        startDate:
          description: Data do primeiro pagamento (aaaa-mm-dd).
          type: string
      required:
        - recurrenceId
        - frequency
        - startDate
        - recipient
        - debtor
        - contractNumber
        - retry
      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
    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
  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).

````