> ## 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. # Registrar una instrucción de pago entrante de Pix Automático > Registra una instrucción de pago programada entrante entregada por el upstream al PSP Pagador. Esta es la génesis entrante: crea la fila de programación del lado del pagador (Requested en un registro aceptado, Rejected en uno rechazado) y devuelve el id local del settlement-gateway. Una instrucción reentregada resuelve en un conflicto 409. ## OpenAPI ````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/schedules/inbound/register openapi: 3.0.3 info: title: Plugin BR Pix Directo - API completa description: > API completa para el sistema de pagos instantáneos Pix de Brasil, que incluye operaciones del diccionario de claves Pix, generación/decodificación de códigos QR, transacciones y límites transaccionales. 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/inbound/register: post: tags: - Pix Automático API summary: Registrar una instrucción de pago entrante de Pix Automático description: >- Registra una instrucción de pago programada entrante entregada por el upstream al PSP Pagador. Esta es la génesis entrante: crea la fila de programación del lado del pagador (Requested en un registro aceptado, Rejected en uno rechazado) y devuelve el id local del settlement-gateway. Una instrucción reentregada resuelve en un conflicto 409. requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterScheduleBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegisterScheduleResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: RegisterScheduleBody: additionalProperties: false properties: codigoErro: description: Código de error del upstream (100 caracteres; en un rechazo). type: string descCodigoErro: description: Descripción del error del upstream (1000 caracteres). type: string devedor: $ref: '#/components/schemas/ScheduleDebtorBlock' dtHrRecepcaoPspRecebedor: description: >- Marca de tiempo de recepción del PSP receptor (UTC; obligatoria cuando finalidadeAgendamento=0). type: string dtVencimento: description: Fecha de vencimiento del cobro recurrente (aaaa-mm-dd). type: string endToEndId: description: Id único de la instrucción de pago (32 caracteres). type: string finalidadeAgendamento: description: >- Propósito de la programación (0=primero, 1=reintento posterior al vencimiento, 2=reenvío de liquidación). format: int64 type: integer idConciliacaoRecebedor: description: Id de conciliación del receptor (35 caracteres). type: string idRecorrencia: description: Id de recurrencia único (29 caracteres, RR...). type: string infEntreClientes: description: Información del receptor al pagador de texto libre (140 caracteres). type: string pagador: $ref: '#/components/schemas/SchedulePayerBlock' recebedor: $ref: '#/components/schemas/ScheduleRecipientBlock' stAgendamento: description: Estado de la programación (0=Aceito, 1=Rejeitado). format: int64 type: integer valor: description: Monto del pago recurrente en reales (un número JSON). format: double type: number required: - endToEndId - idConciliacaoRecebedor - idRecorrencia - stAgendamento - dtVencimento - recebedor - pagador - finalidadeAgendamento type: object RegisterScheduleResponse: additionalProperties: false properties: dtHrSgct: description: Marca de tiempo de registro del settlement-gateway (UTC). type: string idSgct: description: >- Id de programación local del settlement-gateway (GUID de 36 caracteres). type: string required: - idSgct - dtHrSgct type: object Detail: additionalProperties: false properties: code: description: >- Código de error de dominio estable y legible por máquina, acotado al servicio emisor (formato: -NNNN). type: string detail: description: >- Una explicación legible para humanos específica de esta ocurrencia del problema. type: string errors: description: Lista opcional de detalles de error individuales items: $ref: '#/components/schemas/ErrorDetail' type: array nullable: true instance: description: >- Una referencia URI que identifica la ocurrencia específica del problema. format: uri type: string status: description: Código de estado HTTP format: int64 type: integer title: description: >- Un resumen breve y legible para humanos del tipo de problema. Este valor no debería cambiar entre ocurrencias del error. type: string type: default: about:blank description: >- Una referencia URI a la documentación legible para humanos del error. format: uri type: string type: object ScheduleDebtorBlock: additionalProperties: false properties: cpfCnpj: description: CPF o CNPJ del deudor (una cadena v5.5.0). type: string nome: description: Nombre/razão social del deudor. type: string tpPessoa: description: Tipo de persona (0=Pessoa Fisica, 1=Pessoa Juridica). format: int64 type: integer required: - tpPessoa - cpfCnpj - nome type: object SchedulePayerBlock: additionalProperties: false properties: cpfCnpj: description: CPF o CNPJ del pagador (una cadena v5.5.0). type: string ispb: description: ISPB del participante pagador (8 dígitos, una cadena v5.5.0). type: string tpPessoa: description: Tipo de persona (0=Pessoa Fisica, 1=Pessoa Juridica). format: int64 type: integer required: - ispb - tpPessoa - cpfCnpj type: object ScheduleRecipientBlock: additionalProperties: false properties: cnpj: description: CNPJ del beneficiario (14 dígitos, una cadena v5.5.0). type: string ispb: description: ISPB del participante beneficiario (8 dígitos, una cadena v5.5.0). type: string nome: description: Razón social / nombre comercial del beneficiario (razao social). type: string nrAgencia: description: >- Agencia del beneficiario (nrAgencia, 4 dígitos, cadena; la fuente de la agencia). type: string nrConta: description: >- Número de cuenta del beneficiario (nrConta, una cadena; NUNCA la agencia). type: string tpConta: description: >- Tipo de cuenta del beneficiario (0=corrente, 2=poupanca, 3=pagamento). format: int64 type: integer required: - ispb - cnpj - nome - tpConta - nrConta type: object ErrorDetail: additionalProperties: false properties: location: description: >- Dónde ocurrió el error, p. ej. 'body.items[3].tags' o 'path.thing-id' type: string message: description: Texto del mensaje de error type: string value: description: El valor en la ubicación indicada type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Autenticación con token JWT Bearer. Obtén el token desde el endpoint `/v1/login/oauth/access_token` usando credenciales de cliente (`clientId` y `clientSecret`). Incluye el token en el encabezado Authorization: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` El token expira después de 3600 segundos (1 hora). ````