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

# Receive a Pix Automático schedule registration event

> Receives the upstream push event: an async re-delivery of the payer-side schedule registration. It reuses the inbound 5.3.3 register use case (inbound genesis). Idempotent: a re-delivered instruction resolves to a 409 conflict, never a 500. No response body.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml POST /v1/pix-automatico/events/schedule-registered
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/events/schedule-registered:
    post:
      tags:
        - Pix Automático API
      summary: Receive a Pix Automático schedule registration event
      description: >-
        Receives the upstream push event: an async re-delivery of the payer-side
        schedule registration. It reuses the inbound 5.3.3 register use case
        (inbound genesis). Idempotent: a re-delivered instruction resolves to a
        409 conflict, never a 500. No response body.
      parameters:
        - description: >-
            Bearer access token (the financial-ingress gate; the handler fails
            closed with Pix-0082 when absent).
          in: header
          name: Authorization
          schema:
            description: >-
              Bearer access token (the financial-ingress gate; the handler fails
              closed with Pix-0082 when absent).
            type: string
        - description: >-
            Event registration instant (UTC: aaaa-mm-ddTHH:mm:ss.sssZ).
            Mandatory per
          in: header
          name: X-DataHoraEvento
          required: true
          schema:
            description: >-
              Event registration instant (UTC: aaaa-mm-ddTHH:mm:ss.sssZ).
              Mandatory per
            type: string
        - description: Event name. Mandatory per; informational passthrough.
          in: header
          name: X-NomeEvento
          required: true
          schema:
            description: Event name. Mandatory per; informational passthrough.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterScheduleBody'
        required: true
      responses:
        '204':
          description: No Content
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RegisterScheduleBody:
      additionalProperties: false
      properties:
        codigoErro:
          description: Upstream error code (100-char; on a rejection).
          type: string
        descCodigoErro:
          description: Upstream error description (1000-char).
          type: string
        devedor:
          $ref: '#/components/schemas/ScheduleDebtorBlock'
        dtHrRecepcaoPspRecebedor:
          description: >-
            PSP-receiver reception timestamp (UTC; required when
            finalidadeAgendamento=0).
          type: string
        dtVencimento:
          description: Recurring charge due date (aaaa-mm-dd).
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char).
          type: string
        finalidadeAgendamento:
          description: Schedule purpose (0=first, 1=post-due retry, 2=settlement resend).
          format: int64
          type: integer
        idConciliacaoRecebedor:
          description: Receiver conciliation id (35-char).
          type: string
        idRecorrencia:
          description: Unique recurrence id (29-char, RR...).
          type: string
        infEntreClientes:
          description: Free-text receiver-to-payer info (140-char).
          type: string
        pagador:
          $ref: '#/components/schemas/SchedulePayerBlock'
        recebedor:
          $ref: '#/components/schemas/ScheduleRecipientBlock'
        stAgendamento:
          description: Schedule status (0=Aceito, 1=Rejeitado).
          format: int64
          type: integer
        valor:
          description: Recurring payment amount in reais (a JSON number).
          format: double
          type: number
      required:
        - endToEndId
        - idConciliacaoRecebedor
        - idRecorrencia
        - stAgendamento
        - dtVencimento
        - recebedor
        - pagador
        - finalidadeAgendamento
      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
    ScheduleDebtorBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ (a v5.5.0 string).
          type: string
        nome:
          description: Debtor name/razao social.
          type: string
        tpPessoa:
          description: Person type (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - tpPessoa
        - cpfCnpj
        - nome
      type: object
    SchedulePayerBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Payer CPF or CNPJ (a v5.5.0 string).
          type: string
        ispb:
          description: Payer participant ISPB (8 digits, a v5.5.0 string).
          type: string
        tpPessoa:
          description: Person type (0=Pessoa Fisica, 1=Pessoa Juridica).
          format: int64
          type: integer
      required:
        - ispb
        - tpPessoa
        - cpfCnpj
      type: object
    ScheduleRecipientBlock:
      additionalProperties: false
      properties:
        cnpj:
          description: Recipient CNPJ (14 digits, a v5.5.0 string).
          type: string
        ispb:
          description: Recipient participant ISPB (8 digits, a v5.5.0 string).
          type: string
        nome:
          description: Recipient legal/trade name (razao social).
          type: string
        nrAgencia:
          description: Recipient branch (nrAgencia, 4 digits, string; the branch source).
          type: string
        nrConta:
          description: Recipient account number (nrConta, a string; NEVER the branch).
          type: string
        tpConta:
          description: Recipient account type (0=corrente, 2=poupanca, 3=pagamento).
          format: int64
          type: integer
      required:
        - ispb
        - cnpj
        - nome
        - tpConta
        - nrConta
      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).

````