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

# Crear un QR compuesto de Pix Automático solo de recurrencia

> Genera un QR Pix compuesto que lleva SOLO una autorización de pago recurrente (Pix Automático), sin datos de QR estático ni dinámico. La ciudad del beneficiario se obtiene del CRM a partir de la cuenta.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/composite/recurrence
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/pix-automatico/composite/recurrence:
    post:
      tags:
        - Pix Automático API
      summary: Crear un QR compuesto de Pix Automático solo de recurrencia
      description: >-
        Genera un QR Pix compuesto que lleva SOLO una autorización de pago
        recurrente (Pix Automático), sin datos de QR estático ni dinámico. La
        ciudad del beneficiario se obtiene del CRM a partir de la cuenta.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurrenceCompositeBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompositeResponse'
          description: Creado
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RecurrenceCompositeBody:
      additionalProperties: false
      properties:
        accountId:
          description: El id de cuenta del CRM del beneficiario (aporta nombre + ciudad).
          type: string
        certificateIspb:
          description: ISPB del certificado del PSP indirecto (ispbCertificadoJws, cadena).
          type: string
        jwkUrl:
          description: URL del JWK Set (urlJwk; sin esquema).
          type: string
        recurrence:
          $ref: '#/components/schemas/CompositeRecurrenceBody'
        recurrencePayloadUrl:
          description: URL del host JWS de la recurrencia (urlPayloadJsonRec; sin esquema).
          type: string
        txId:
          description: Id de conciliación (idConciliacaoRecebedor).
          type: string
      required:
        - accountId
        - recurrencePayloadUrl
        - jwkUrl
        - recurrence
      type: object
    CompositeResponse:
      additionalProperties: false
      properties:
        documentId:
          description: El id de documento de la recurrencia/cobro (idDocumento, GUID).
          type: string
        qrCode:
          description: >-
            El payload del QR compuesto EMV generado (decodificado de base64,
            listo para renderizar).
          type: string
        recurrencePayload:
          description: El JWS de recurrencia firmado (payloadJwsRecorrencia).
          type: string
      required:
        - qrCode
      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
    CompositeRecurrenceBody:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Monto fijo del pago en reales (omite/0 para una recurrencia
            variable).
          format: double
          type: number
        contractDesc:
          description: Descripción de contrato de texto libre.
          type: string
        contractNumber:
          description: Identificador de contrato/orden (nrContrato).
          type: string
        debtor:
          $ref: '#/components/schemas/CompositeDebtorBody'
        endDate:
          description: Fecha del último pago (aaaa-mm-dd).
          type: string
        frequency:
          description: tpFrequencia (0=Weekly,1=Monthly,2=Quarterly,3=Semiannual,4=Annual).
          format: int64
          type: integer
        maxFloorAmount:
          description: >-
            Monto mínimo en reales (pisoValorMaximo; no válido junto con un
            monto fijo).
          format: double
          type: number
        recipient:
          $ref: '#/components/schemas/CompositeRecipientBody'
        recurrenceId:
          description: Id de recurrencia único (29 caracteres, formato RR...).
          type: string
        retry:
          description: Política de retentativa (0=ninguna, 1=hasta 3 reintentos en 7 días).
          format: int64
          type: integer
        startDate:
          description: Fecha del primer pago (aaaa-mm-dd).
          type: string
      required:
        - recurrenceId
        - frequency
        - startDate
        - recipient
        - debtor
        - contractNumber
        - retry
      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
    CompositeDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF o CNPJ del deudor (cadena).
          type: string
        name:
          description: Nombre del deudor.
          type: string
        personType:
          description: Tipo de persona del deudor (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    CompositeRecipientBody:
      additionalProperties: false
      properties:
        cnpj:
          description: CNPJ del beneficiario (14 dígitos, cadena).
          type: string
        ispb:
          description: ISPB del participante beneficiario (8 dígitos, cadena).
          type: string
        name:
          description: Razón social / nombre comercial del beneficiario.
          type: string
      required:
        - ispb
        - cnpj
        - name
      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).

````