> ## 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 Automatico schedule send

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


## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules
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/schedules:
    post:
      tags:
        - PIX Automatico
      summary: Request a PIX Automatico schedule send
      description: >-
        Requests the send of a recurring-payment instruction (agendamento) as
        the PSP Recebedor (JDPI 4.4.1). Persists the schedule in the Requested
        state and returns the JDPI acknowledgement.
      operationId: requestPixAutomaticoSchedule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestScheduleBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestScheduleResponse'
          description: Accepted
        '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:
    RequestScheduleBody:
      additionalProperties: false
      properties:
        amount:
          description: Scheduled amount in centavos (valor).
          examples:
            - 55000
          format: int64
          type: integer
        debtor:
          $ref: '#/components/schemas/ScheduleDebtorBody'
          description: The devedor, sent only when it differs from the payer.
        dueDate:
          description: Due date (dtVencimento; aaaa-mm-dd).
          examples:
            - '2024-09-24'
          type: string
        endToEndId:
          description: Unique payment-transaction id (32-char natural key).
          examples:
            - E00038166202409171500y6j6mt9l0pi
          type: string
        idRecorrencia:
          description: Recurrence id linking the authorization (29-char, RR...).
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        infoBetweenClients:
          description: Free-text receiver-to-payer info (infEntreClientes).
          examples:
            - ''
          type: string
        payer:
          $ref: '#/components/schemas/SchedulePayerBody'
          description: The scheduled pagador (account being charged).
        purpose:
          description: >-
            finalidadeAgendamento (0=first, 1=post-due retry, 2=settlement-error
            resend).
          examples:
            - 0
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/ScheduleRecipientBody'
          description: The scheduled recebedor (account receiving the charge).
        recipientReceivedAt:
          description: >-
            Recipient PSP reception timestamp (dtHrRecepcaoPspRecebedor, UTC;
            required when purpose=0).
          examples:
            - '2024-09-17T10:25:49.025Z'
          type: string
        reconciliationId:
          description: Receiver conciliation id (idConciliacaoRecebedor; 26..35-char).
          examples:
            - JDPI2024091700000000000000000000001
          type: string
      required:
        - endToEndId
        - reconciliationId
        - idRecorrencia
        - purpose
        - dueDate
        - recipient
        - payer
      type: object
    RequestScheduleResponse:
      additionalProperties: false
      properties:
        endToEndId:
          description: The payment-transaction id (echoed).
          examples:
            - E00038166202409171500y6j6mt9l0pi
          type: string
        idRecorrencia:
          description: The recurrence id (echoed).
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        reconciliationId:
          description: The receiver conciliation id (echoed).
          examples:
            - JDPI2024091700000000000000000000001
          type: string
        requestedAt:
          description: JDPI request timestamp (dtHrReqJdPi, UTC).
          examples:
            - '2024-09-17T10:10:05Z'
          type: string
        status:
          description: The resulting local schedule status.
          examples:
            - Requested
          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).
          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
    ScheduleDebtorBody:
      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: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    SchedulePayerBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Payer CPF or CNPJ (string).
          examples:
            - '04623217035'
          type: string
        ispb:
          description: Payer participant ISPB (8 digits, string).
          examples:
            - '00038166'
          type: string
        personType:
          description: tpPessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - ispb
        - personType
        - cpfCnpj
      type: object
    ScheduleRecipientBody:
      additionalProperties: false
      properties:
        account:
          description: Recipient account number (nrConta, string).
          examples:
            - '0007654321'
          type: string
        accountType:
          description: tpConta (0=corrente, 2=poupanca, 3=pagamento).
          examples:
            - 0
          format: int64
          type: integer
        agency:
          description: Recipient branch (nrAgencia, 4 digits, string).
          examples:
            - '0001'
          type: string
        cnpj:
          description: Recipient CNPJ (14 digits, string).
          examples:
            - '61695227000193'
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, string).
          examples:
            - '04358798'
          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
    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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````