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

# Receber evento de registro de agendamento de Pix Automático

> Recebe o evento de push do upstream: uma reentrega assíncrona do registro de agendamento do lado do pagador. Reutiliza o caso de uso de registro de entrada 5.3.3 (gênese de entrada). Idempotente: uma instrução reentregue resolve em um conflito 409, nunca em um 500. Sem corpo de resposta.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/events/schedule-registered
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/events/schedule-registered:
    post:
      tags:
        - Pix Automático API
      summary: Receber evento de registro de agendamento de Pix Automático
      description: >-
        Recebe o evento de push do upstream: uma reentrega assíncrona do
        registro de agendamento do lado do pagador. Reutiliza o caso de uso de
        registro de entrada 5.3.3 (gênese de entrada). Idempotente: uma
        instrução reentregue resolve em um conflito 409, nunca em um 500. Sem
        corpo de resposta.
      parameters:
        - description: >-
            Token de acesso Bearer (o portão de entrada financeira; o handler
            falha de forma fechada com Pix-0082 quando ausente).
          in: header
          name: Authorization
          schema:
            description: >-
              Token de acesso Bearer (o portão de entrada financeira; o handler
              falha de forma fechada com Pix-0082 quando ausente).
            type: string
        - description: >-
            Instante de registro do evento (UTC: aaaa-mm-ddTHH:mm:ss.sssZ).
            Obrigatório conforme
          in: header
          name: X-DataHoraEvento
          required: true
          schema:
            description: >-
              Instante de registro do evento (UTC: aaaa-mm-ddTHH:mm:ss.sssZ).
              Obrigatório conforme
            type: string
        - description: Nome do evento. Obrigatório conforme; passthrough informativo.
          in: header
          name: X-NomeEvento
          required: true
          schema:
            description: Nome do evento. Obrigatório conforme; passthrough informativo.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterScheduleBody'
        required: true
      responses:
        '204':
          description: Sem Conteúdo
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    RegisterScheduleBody:
      additionalProperties: false
      properties:
        codigoErro:
          description: Código de erro do upstream (100 caracteres; em uma rejeição).
          type: string
        descCodigoErro:
          description: Descrição de erro do upstream (1000 caracteres).
          type: string
        devedor:
          $ref: '#/components/schemas/ScheduleDebtorBlock'
        dtHrRecepcaoPspRecebedor:
          description: >-
            Data/hora de recepção do PSP recebedor (UTC; obrigatório quando
            finalidadeAgendamento=0).
          type: string
        dtVencimento:
          description: Data de vencimento da cobrança recorrente (aaaa-mm-dd).
          type: string
        endToEndId:
          description: Id único de instrução de pagamento (32 caracteres).
          type: string
        finalidadeAgendamento:
          description: >-
            Finalidade do agendamento (0=primeiro, 1=retentativa pós-vencimento,
            2=reenvio de liquidação).
          format: int64
          type: integer
        idConciliacaoRecebedor:
          description: Id de conciliação do recebedor (35 caracteres).
          type: string
        idRecorrencia:
          description: Id único de recorrência (29 caracteres, RR...).
          type: string
        infEntreClientes:
          description: >-
            Informação em texto livre do recebedor para o pagador (140
            caracteres).
          type: string
        pagador:
          $ref: '#/components/schemas/SchedulePayerBlock'
        recebedor:
          $ref: '#/components/schemas/ScheduleRecipientBlock'
        stAgendamento:
          description: Status do agendamento (0=Aceito, 1=Rejeitado).
          format: int64
          type: integer
        valor:
          description: Valor de pagamento recorrente em reais (um número JSON).
          format: double
          type: number
      required:
        - endToEndId
        - idConciliacaoRecebedor
        - idRecorrencia
        - stAgendamento
        - dtVencimento
        - recebedor
        - pagador
        - finalidadeAgendamento
      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
    ScheduleDebtorBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF ou CNPJ do devedor (uma string v5.5.0).
          type: string
        nome:
          description: Nome/razão social do devedor.
          type: string
        tpPessoa:
          description: Tipo de pessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - tpPessoa
        - cpfCnpj
        - nome
      type: object
    SchedulePayerBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF ou CNPJ do pagador (uma string v5.5.0).
          type: string
        ispb:
          description: ISPB do participante pagador (8 dígitos, uma string v5.5.0).
          type: string
        tpPessoa:
          description: Tipo de pessoa (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - ispb
        - tpPessoa
        - cpfCnpj
      type: object
    ScheduleRecipientBlock:
      additionalProperties: false
      properties:
        cnpj:
          description: CNPJ do recebedor (14 dígitos, uma string v5.5.0).
          type: string
        ispb:
          description: ISPB do participante recebedor (8 dígitos, uma string v5.5.0).
          type: string
        nome:
          description: Razão social/nome fantasia do recebedor (razão social).
          type: string
        nrAgencia:
          description: >-
            Agência do recebedor (nrAgencia, 4 dígitos, string; a fonte da
            agência).
          type: string
        nrConta:
          description: Número da conta do recebedor (nrConta, uma string; NUNCA a agência).
          type: string
        tpConta:
          description: Tipo de conta do recebedor (0=corrente, 2=poupanca, 3=pagamento).
          format: int64
          type: integer
      required:
        - ispb
        - cnpj
        - nome
        - tpConta
        - nrConta
      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).

````