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

# Request a Pix Automático schedule send

> Requests the send of a recurring-payment instruction (agendamento) as the PSP Recebedor. Persists the schedule in the Requested state and returns the upstream acknowledgement.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  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: Request a Pix Automático schedule send
      description: >-
        Requests the send of a recurring-payment instruction (agendamento) as
        the PSP Recebedor. Persists the schedule in the Requested state and
        returns the upstream acknowledgement.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestScheduleBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestScheduleResponse'
          description: Accepted
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RequestScheduleBody:
      additionalProperties: false
      properties:
        amount:
          description: Scheduled amount in reais (valor).
          format: double
          type: number
        debtor:
          $ref: '#/components/schemas/ScheduleDebtorBody'
        dueDate:
          description: Due date (dtVencimento; aaaa-mm-dd).
          type: string
        endToEndId:
          description: Unique payment-transaction id (32-char natural key).
          type: string
        idRecorrencia:
          description: Recurrence id linking the authorization (29-char, RR...).
          type: string
        infoBetweenClients:
          description: Free-text receiver-to-payer info (infEntreClientes).
          type: string
        payer:
          $ref: '#/components/schemas/SchedulePayerBody'
        purpose:
          description: >-
            finalidadeAgendamento (0=first, 1=post-due retry, 2=settlement-error
            resend).
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/ScheduleRecipientBody'
        recipientReceivedAt:
          description: >-
            Recipient PSP reception timestamp (dtHrRecepcaoPspRecebedor, UTC;
            required when purpose=0).
          type: string
        reconciliationId:
          description: Receiver conciliation id (idConciliacaoRecebedor; 26..35-char).
          type: string
      required:
        - endToEndId
        - reconciliationId
        - idRecorrencia
        - purpose
        - dueDate
        - recipient
        - payer
      type: object
    RequestScheduleResponse:
      additionalProperties: false
      properties:
        endToEndId:
          description: The payment-transaction id (echoed).
          type: string
        idRecorrencia:
          description: The recurrence id (echoed).
          type: string
        reconciliationId:
          description: The receiver conciliation id (echoed).
          type: string
        requestedAt:
          description: Upstream request timestamp (upstream request timestamp, UTC).
          type: string
        status:
          description: The resulting local schedule status.
          type: string
      required:
        - idRecorrencia
        - reconciliationId
        - endToEndId
        - requestedAt
        - status
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          type: string
      type: object
    ScheduleDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ (string).
          type: string
        name:
          description: Debtor name.
          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: Payer CPF or CNPJ (string).
          type: string
        ispb:
          description: Payer participant ISPB (8 digits, string).
          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: Recipient account number (nrConta, string).
          type: string
        accountType:
          description: tpConta (0=corrente, 2=poupanca, 3=pagamento).
          format: int64
          type: integer
        agency:
          description: Recipient branch (nrAgencia, 4 digits, string).
          type: string
        cnpj:
          description: Recipient CNPJ (14 digits, string).
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, string).
          type: string
      required:
        - ispb
        - cnpj
        - accountType
        - account
      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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````