> ## 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. # Reservar una retención de débito entrante de Pix Automático > Reserva una RETENCIÓN de débito en la cuenta transaccional del pagador para un pago programado de Pix Automático. El upstream llama a esto cuando comienza a procesar el pago programado. La reserva es parametrizable y está deshabilitada por defecto. Ante fondos insuficientes, el resultado se devuelve en línea (200) como un resultado=0 con motivo SGCTPIX001, nunca como un error HTTP. ## OpenAPI ````yaml es/openapi/v3-current/pix.yaml POST /v1/pix-automatico/settlements/inbound/block 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/settlements/inbound/block: post: tags: - Pix Automático API summary: Reservar una retención de débito entrante de Pix Automático description: >- Reserva una RETENCIÓN de débito en la cuenta transaccional del pagador para un pago programado de Pix Automático. El upstream llama a esto cuando comienza a procesar el pago programado. La reserva es parametrizable y está deshabilitada por defecto. Ante fondos insuficientes, el resultado se devuelve en línea (200) como un resultado=0 con motivo SGCTPIX001, nunca como un error HTTP. parameters: - description: >- Bearer access token (the financial-ingress gate; the handler fails closed with Pix-0082 when absent). in: header name: Authorization schema: description: >- Token de acceso Bearer (la puerta de ingreso financiero; el handler falla en modo cerrado con Pix-0082 cuando está ausente). type: string - description: Idempotency key (= the endToEndId of the transaction). Mandatory per in: header name: Chave-Idempotencia required: true schema: description: >- Clave de idempotencia (= el endToEndId de la transacción). Obligatorio. type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BlockScheduleBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BlockScheduleResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: BlockScheduleBody: additionalProperties: false properties: codMunIbge: description: Código IBGE del municipio del pagador (7 dígitos). format: int64 type: integer cpfCnpj: description: CPF o CNPJ del pagador (una cadena v5.5.0). type: string endToEndId: description: Id único de la instrucción de pago (32 caracteres). type: string ispb: description: ISPB del participante pagador (8 dígitos, una cadena v5.5.0). type: string nrAgencia: description: Agencia del pagador (nrAgencia, 4 dígitos, cadena). type: string nrConta: description: Número de cuenta del pagador (nrConta, una cadena). type: string tpPessoa: description: Tipo de persona del pagador (0=Pessoa Fisica, 1=Pessoa Juridica). format: int64 type: integer valor: description: Monto a reservar en reales. format: double type: number required: - endToEndId - ispb - tpPessoa - cpfCnpj - nrConta - codMunIbge - valor type: object BlockScheduleResponse: additionalProperties: false properties: dtHrRespostaSgct: description: Marca de tiempo de respuesta del settlement-gateway (UTC). type: string endToEndId: description: Id único de la instrucción de pago (32 caracteres). type: string idOperacaoSgct: description: >- Id de operación de bloqueo del settlement-gateway (GUID; presente solo cuando resultado=1). type: string motivo: description: >- Motivo de rechazo (SGCTPIX001=fondos insuficientes, SGCTPIX999=otro; presente solo cuando resultado=0). type: string motivoComplemento: description: Detalle del rechazo (presente solo cuando resultado=0). type: string resultado: description: Resultado del bloqueo (0=Rejeitado, 1=Aceito). format: int64 type: integer required: - endToEndId - resultado - dtHrRespostaSgct 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 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). ````