> ## 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. # Register an inbound PIX Automatico payment instruction > Registers an inbound scheduled payment instruction delivered by JDPI to the PSP Pagador (section 5.3.3, the plugin is the server). This is inbound genesis: it creates the payer-side schedule row (Requested on an accepted registration, Rejected on a rejected one) and returns the local SGCT id. A re-delivered instruction resolves to a 409 conflict. ## OpenAPI ````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/register 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/inbound/register: post: tags: - PIX Automatico summary: Register an inbound PIX Automatico payment instruction description: >- Registers an inbound scheduled payment instruction delivered by JDPI to the PSP Pagador (section 5.3.3, the plugin is the server). This is inbound genesis: it creates the payer-side schedule row (Requested on an accepted registration, Rejected on a rejected one) and returns the local SGCT id. A re-delivered instruction resolves to a 409 conflict. operationId: registerInboundPixAutomaticoSchedule requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterScheduleBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegisterScheduleResponse' description: OK '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: RegisterScheduleBody: additionalProperties: true properties: codigoErro: description: JDPI error code (100-char; on a rejection). examples: - '' type: string descCodigoErro: description: JDPI error description (1000-char). examples: - '' type: string devedor: $ref: '#/components/schemas/ScheduleDebtorBlock' description: The devedor, sent only when it differs from the payer. dtHrRecepcaoPspRecebedor: description: >- PSP-receiver reception timestamp (UTC; required when finalidadeAgendamento=0). examples: - '2024-09-20T09:25:49.025Z' type: string dtVencimento: description: Recurring charge due date (aaaa-mm-dd). examples: - '2024-09-26' type: string endToEndId: description: Unique payment-instruction id (32-char). examples: - E00038166202409201500y6j6mt9l0pi type: string finalidadeAgendamento: description: Schedule purpose (0=first, 1=post-due retry, 2=settlement resend). examples: - 0 format: int64 type: integer idConciliacaoRecebedor: description: Receiver conciliation id (35-char). examples: - JDPI2024092000000000000000000000001 type: string idRecorrencia: description: Unique recurrence id (29-char, RR...). examples: - RR0435879820240919njua7shf40o type: string infEntreClientes: description: Free-text receiver-to-payer info (140-char). examples: - Cobranca da Enel type: string pagador: $ref: '#/components/schemas/SchedulePayerBlock' description: The instruction pagador. recebedor: $ref: '#/components/schemas/ScheduleRecipientBlock' description: The instruction recebedor. stAgendamento: description: Schedule status (0=Aceito, 1=Rejeitado). examples: - 0 format: int64 type: integer valor: description: Recurring payment amount in reais (a JSON number). examples: - 550 format: double type: number required: - endToEndId - idConciliacaoRecebedor - idRecorrencia - stAgendamento - dtVencimento - recebedor - pagador - finalidadeAgendamento type: object RegisterScheduleResponse: additionalProperties: false properties: dtHrSgct: description: SGCT registration timestamp (UTC). examples: - '2024-11-27T22:10:05.025Z' type: string idSgct: description: Local SGCT schedule id (36-char GUID). examples: - 69F963C6-7487-4363-9406-A1DE2A9636D4 type: string required: - idSgct - dtHrSgct type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -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 ScheduleDebtorBlock: additionalProperties: true properties: cpfCnpj: description: Debtor CPF or CNPJ (a v5.5.0 string). examples: - '04623217035' type: string nome: description: Debtor name/razao social. examples: - Ciclano da Silva type: string tpPessoa: description: Person type (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer required: - tpPessoa - cpfCnpj - nome type: object SchedulePayerBlock: additionalProperties: true properties: cpfCnpj: description: Payer CPF or CNPJ (a v5.5.0 string). examples: - '11111111111' type: string ispb: description: Payer participant ISPB (8 digits, a v5.5.0 string). examples: - '99999004' type: string tpPessoa: description: Person type (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer required: - ispb - tpPessoa - cpfCnpj type: object ScheduleRecipientBlock: additionalProperties: true properties: cnpj: description: Recipient CNPJ (14 digits, a v5.5.0 string). examples: - '61695227000193' type: string ispb: description: Recipient participant ISPB (8 digits, a v5.5.0 string). examples: - '04358798' type: string nome: description: Recipient legal/trade name (razao social). examples: - Enel type: string nrAgencia: description: Recipient branch (nrAgencia, 4 digits, string; the branch source). examples: - '1234' type: string nrConta: description: Recipient account number (nrConta, a string; NEVER the branch). examples: - '12345678' type: string tpConta: description: Recipient account type (0=corrente, 2=poupanca, 3=pagamento). examples: - 0 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 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 ````