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

# Solicitar el envío de una programación de Pix Automático

> Solicita el envío de una instrucción de pago recurrente (agendamento) como PSP Recebedor. Persiste la programación en el estado Requested y devuelve el acuse del upstream.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules
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/schedules:
    post:
      tags:
        - Pix Automático API
      summary: Solicitar el envío de una programación de Pix Automático
      description: >-
        Solicita el envío de una instrucción de pago recurrente (agendamento)
        como PSP Recebedor. Persiste la programación en el estado Requested y
        devuelve el acuse del upstream.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestScheduleBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestScheduleResponse'
          description: Aceptado
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RequestScheduleBody:
      additionalProperties: false
      properties:
        amount:
          description: Monto programado en reales (valor).
          format: double
          type: number
        debtor:
          $ref: '#/components/schemas/ScheduleDebtorBody'
        dueDate:
          description: Fecha de vencimiento (dtVencimento; aaaa-mm-dd).
          type: string
        endToEndId:
          description: Id único de la transacción de pago (clave natural de 32 caracteres).
          type: string
        idRecorrencia:
          description: >-
            Id de recurrencia que vincula la autorización (29 caracteres,
            RR...).
          type: string
        infoBetweenClients:
          description: >-
            Información del receptor al pagador de texto libre
            (infEntreClientes).
          type: string
        payer:
          $ref: '#/components/schemas/SchedulePayerBody'
        purpose:
          description: >-
            finalidadeAgendamento (0=primero, 1=reintento posterior al
            vencimiento, 2=reenvío por error de liquidación).
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/ScheduleRecipientBody'
        recipientReceivedAt:
          description: >-
            Marca de tiempo de recepción del PSP beneficiario
            (dtHrRecepcaoPspRecebedor, UTC; obligatoria cuando purpose=0).
          type: string
        reconciliationId:
          description: >-
            Id de conciliación del receptor (idConciliacaoRecebedor; 26..35
            caracteres).
          type: string
      required:
        - endToEndId
        - reconciliationId
        - idRecorrencia
        - purpose
        - dueDate
        - recipient
        - payer
      type: object
    RequestScheduleResponse:
      additionalProperties: false
      properties:
        endToEndId:
          description: El id de la transacción de pago (reflejado).
          type: string
        idRecorrencia:
          description: El id de recurrencia (reflejado).
          type: string
        reconciliationId:
          description: El id de conciliación del receptor (reflejado).
          type: string
        requestedAt:
          description: >-
            Marca de tiempo de la solicitud en el upstream (marca de tiempo de
            la solicitud del upstream, UTC).
          type: string
        status:
          description: El estado local resultante de la programación.
          type: string
      required:
        - idRecorrencia
        - reconciliationId
        - endToEndId
        - requestedAt
        - status
      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
    ScheduleDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF o CNPJ del deudor (cadena).
          type: string
        name:
          description: Nombre del deudor.
          type: string
        personType:
          description: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    SchedulePayerBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF o CNPJ del pagador (cadena).
          type: string
        ispb:
          description: ISPB del participante pagador (8 dígitos, cadena).
          type: string
        personType:
          description: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - ispb
        - personType
        - cpfCnpj
      type: object
    ScheduleRecipientBody:
      additionalProperties: false
      properties:
        account:
          description: Número de cuenta del beneficiario (nrConta, cadena).
          type: string
        accountType:
          description: tpConta (0=corrente, 2=poupanca, 3=pagamento).
          format: int64
          type: integer
        agency:
          description: Agencia del beneficiario (nrAgencia, 4 dígitos, cadena).
          type: string
        cnpj:
          description: CNPJ del beneficiario (14 dígitos, cadena).
          type: string
        ispb:
          description: ISPB del participante beneficiario (8 dígitos, cadena).
          type: string
      required:
        - ispb
        - cnpj
        - accountType
        - account
      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
  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).

````