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

# Create a CobV (due-date) composite PIX Automatico QR code

> Generates a composite PIX QR code embedding due-date dynamic-QR data (cobrança com vencimento) and a recurring-payment authorization (PIX Automatico). The recipient name and city are CRM-sourced from the account.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/cobv
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/pix-automatico/composite/cobv:
    post:
      tags:
        - PIX Automatico
      summary: Create a CobV (due-date) composite PIX Automatico QR code
      description: >-
        Generates a composite PIX QR code embedding due-date dynamic-QR data
        (cobrança com vencimento) and a recurring-payment authorization (PIX
        Automatico). The recipient name and city are CRM-sourced from the
        account.
      operationId: createCobvCompositeQRCode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CobvCompositeBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositeResponse'
          description: Created
        '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:
    CobvCompositeBody:
      additionalProperties: false
      properties:
        accountId:
          description: The CRM account id of the recipient (sources name + city).
          examples:
            - acc-123
          type: string
        certificateIspb:
          description: Indirect-PSP certificate ISPB (ispbCertificadoJws, string).
          examples:
            - '04358798'
          type: string
        daysAfterDue:
          description: Days after the due date the charge can still be paid (diasAposVenc).
          examples:
            - 365
          format: int64
          type: integer
        description:
          description: Optional additional-data entries (dadosAdicionais).
          items:
            $ref: '#/components/schemas/CompositeAdditionalDataBody'
          type:
            - array
            - 'null'
        discount:
          description: Discount in centavos (desconto; omit/0 to skip).
          examples:
            - 4
          format: int64
          type: integer
        dueDate:
          description: Due date for payment (dtVenc; aaaa-mm-dd).
          examples:
            - '2021-06-17'
          type: string
        finalAmount:
          description: Final charge amount in centavos (valorFinal, after adjustments).
          examples:
            - 100001
          format: int64
          type: integer
        fine:
          description: Fine in centavos (multa; omit/0 to skip).
          examples:
            - 20022
          format: int64
          type: integer
        interest:
          description: Interest in centavos (juros; omit/0 to skip).
          examples:
            - 1015
          format: int64
          type: integer
        jwkUrl:
          description: JWK Set URL (urlJwk; no scheme).
          examples:
            - example.com/jwks
          type: string
        key:
          description: The recipient PIX key the composite QR pays into.
          examples:
            - fulano.tal@provedor.com.br
          type: string
        originalAmount:
          description: >-
            Original charge amount in centavos (valorOriginal, before
            adjustments).
          examples:
            - 100116
          format: int64
          type: integer
        payer:
          $ref: '#/components/schemas/CompositePayerBody'
          description: Optional payer block.
        paymentPayloadUrl:
          description: CobV JWS host URL (urlPayloadJson; no scheme).
          examples:
            - pix.example.com/cobv/abc
          type: string
        rebate:
          description: Rebate in centavos (abatimento; omit/0 to skip).
          examples:
            - 111
          format: int64
          type: integer
        recipientStreet:
          description: Recipient street (logradouroRecebedor).
          examples:
            - Rua Pix, 123
          type: string
        recurrence:
          $ref: '#/components/schemas/CompositeRecurrenceBody'
          description: The embedded recurrence configuration (dadosRecorrencia).
        recurrencePayloadUrl:
          description: Recurrence JWS host URL (urlPayloadJsonRec; no scheme).
          examples:
            - pix.example.com/rec/def
          type: string
        state:
          description: Recipient state (uf).
          examples:
            - SP
          type: string
        txId:
          description: Conciliation id (idConciliacaoRecebedor).
          examples:
            - JDPI2020010300000000000000000000001
          type: string
        zipCode:
          description: Recipient postal code (cep).
          examples:
            - '01227200'
          type: string
      required:
        - key
        - accountId
        - recipientStreet
        - state
        - zipCode
        - finalAmount
        - dueDate
        - daysAfterDue
        - txId
        - paymentPayloadUrl
        - recurrencePayloadUrl
        - jwkUrl
        - recurrence
      type: object
    CompositeResponse:
      additionalProperties: false
      properties:
        documentId:
          description: The recurrence/charge document id (idDocumento, GUID).
          examples:
            - 52c43361-caa1-4ddb-9152-708426a25db3
          type: string
        qrCode:
          description: >-
            The generated EMV composite-QR payload (base64-decoded, ready to
            render).
          examples:
            - 00020126...
          type: string
        recurrencePayload:
          description: The signed recurrence JWS (payloadJwsRecorrencia).
          examples:
            - eyJhbGciOiJQUzUxMi...
          type: string
      required:
        - qrCode
      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
    CompositeAdditionalDataBody:
      additionalProperties: false
      properties:
        name:
          description: The additional-data entry name.
          examples:
            - Detalhes do Pagamento
          type: string
        value:
          description: The additional-data entry value.
          examples:
            - Informacao Adicional
          type: string
      required:
        - name
        - value
      type: object
    CompositePayerBody:
      additionalProperties: false
      properties:
        document:
          description: Payer document (CPF/CNPJ, string).
          examples:
            - '04623217035'
          type: string
        name:
          description: Payer name (only forwarded with a document).
          examples:
            - Ciclano de Tal
          type: string
        request:
          description: Free-text request to the payer (solicitacaoPagador).
          examples:
            - Pesquisa de satisfacao
          type: string
      type: object
    CompositeRecurrenceBody:
      additionalProperties: false
      properties:
        amount:
          description: Fixed payment amount in centavos (omit/0 for a variable recurrence).
          examples:
            - 110001
          format: int64
          type: integer
        contractDesc:
          description: Free-text contract description.
          examples:
            - Conta de energia
          type: string
        contractNumber:
          description: Contract/order identifier (nrContrato).
          examples:
            - 1234567890ABC
          type: string
        debtor:
          $ref: '#/components/schemas/CompositeDebtorBody'
          description: The recurrence devedor (authorized payer).
        endDate:
          description: Last payment date (aaaa-mm-dd).
          examples:
            - '2026-01-10'
          type: string
        frequency:
          description: tpFrequencia (0=Weekly,1=Monthly,2=Quarterly,3=Semiannual,4=Annual).
          examples:
            - 1
          format: int64
          type: integer
        maxFloorAmount:
          description: >-
            Floor amount in centavos (pisoValorMaximo; not valid with a fixed
            amount).
          examples:
            - 55000
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/CompositeRecipientBody'
          description: The recurrence recebedor (authorized charging entity).
        recurrenceId:
          description: Unique recurrence id (29-char, format RR...).
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        retry:
          description: retentativa policy (0=none, 1=up to 3 retries within 7 days).
          examples:
            - 1
          format: int64
          type: integer
        startDate:
          description: First payment date (aaaa-mm-dd).
          examples:
            - '2024-01-10'
          type: string
      required:
        - recurrenceId
        - frequency
        - startDate
        - recipient
        - debtor
        - contractNumber
        - retry
      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
    CompositeDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ (string).
          examples:
            - '04623217035'
          type: string
        name:
          description: Debtor name.
          examples:
            - Ciclano da Silva
          type: string
        personType:
          description: Debtor person type (0=Pessoa Fisica, 1=Pessoa Juridica).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    CompositeRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: Recipient CNPJ (14 digits, string).
          examples:
            - '61695227000193'
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, string).
          examples:
            - '04358798'
          type: string
        name:
          description: Recipient legal/trade name.
          examples:
            - Enel
          type: string
      required:
        - ispb
        - cnpj
        - name
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````