> ## 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 envio de agendamento de Pix Automático

> Solicita o envio de uma instrução de pagamento recorrente (agendamento) como PSP Recebedor. Persiste o agendamento no estado Requested e retorna o reconhecimento do upstream.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  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 envio de agendamento de Pix Automático
      description: >-
        Solicita o envio de uma instrução de pagamento recorrente (agendamento)
        como PSP Recebedor. Persiste o agendamento no estado Requested e retorna
        o reconhecimento do upstream.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestScheduleBody'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestScheduleResponse'
          description: Aceito
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    RequestScheduleBody:
      additionalProperties: false
      properties:
        amount:
          description: Valor agendado em reais (valor).
          format: double
          type: number
        debtor:
          $ref: '#/components/schemas/ScheduleDebtorBody'
        dueDate:
          description: Data de vencimento (dtVencimento; aaaa-mm-dd).
          type: string
        endToEndId:
          description: Id único de transação de pagamento (chave natural de 32 caracteres).
          type: string
        idRecorrencia:
          description: Id da recorrência vinculando a autorização (29 caracteres, RR...).
          type: string
        infoBetweenClients:
          description: >-
            Informação em texto livre do recebedor para o pagador
            (infEntreClientes).
          type: string
        payer:
          $ref: '#/components/schemas/SchedulePayerBody'
        purpose:
          description: >-
            finalidadeAgendamento (0=primeiro, 1=retentativa pós-vencimento,
            2=reenvio por erro de liquidação).
          format: int64
          type: integer
        recipient:
          $ref: '#/components/schemas/ScheduleRecipientBody'
        recipientReceivedAt:
          description: >-
            Data/hora de recepção do PSP recebedor (dtHrRecepcaoPspRecebedor,
            UTC; obrigatório quando purpose=0).
          type: string
        reconciliationId:
          description: >-
            Id de conciliação do recebedor (idConciliacaoRecebedor; 26..35
            caracteres).
          type: string
      required:
        - endToEndId
        - reconciliationId
        - idRecorrencia
        - purpose
        - dueDate
        - recipient
        - payer
      type: object
    RequestScheduleResponse:
      additionalProperties: false
      properties:
        endToEndId:
          description: O id da transação de pagamento (ecoado).
          type: string
        idRecorrencia:
          description: O id da recorrência (ecoado).
          type: string
        reconciliationId:
          description: O id de conciliação do recebedor (ecoado).
          type: string
        requestedAt:
          description: Data/hora da requisição upstream (upstream request timestamp, UTC).
          type: string
        status:
          description: O status local resultante do agendamento.
          type: string
      required:
        - idRecorrencia
        - reconciliationId
        - endToEndId
        - requestedAt
        - status
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    ScheduleDebtorBody:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF ou CNPJ do devedor (string).
          type: string
        name:
          description: Nome do devedor.
          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 ou CNPJ do pagador (string).
          type: string
        ispb:
          description: ISPB do participante pagador (8 dígitos, 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: Número da conta do recebedor (nrConta, string).
          type: string
        accountType:
          description: tpConta (0=corrente, 2=poupanca, 3=pagamento).
          format: int64
          type: integer
        agency:
          description: Agência do recebedor (nrAgencia, 4 dígitos, string).
          type: string
        cnpj:
          description: CNPJ do recebedor (14 dígitos, string).
          type: string
        ispb:
          description: ISPB do participante recebedor (8 dígitos, string).
          type: string
      required:
        - ispb
        - cnpj
        - accountType
        - account
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````