> ## 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 bloqueio de débito de Pix Automático de entrada > Reserva um HOLD de débito na conta transacional do pagador para um pagamento de Pix Automático agendado. O upstream chama isto quando começa a processar o pagamento agendado. A reserva é parametrizável e desabilitada por padrão. Em caso de saldo insuficiente o resultado é retornado inline (200) como um desfecho resultado=0 com motivo SGCTPIX001, nunca um erro HTTP. ## OpenAPI ````yaml pt/openapi/v3-current/pix.yaml POST /v1/pix-automatico/settlements/inbound/block 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/settlements/inbound/block: post: tags: - Pix Automático API summary: Reservar bloqueio de débito de Pix Automático de entrada description: >- Reserva um HOLD de débito na conta transacional do pagador para um pagamento de Pix Automático agendado. O upstream chama isto quando começa a processar o pagamento agendado. A reserva é parametrizável e desabilitada por padrão. Em caso de saldo insuficiente o resultado é retornado inline (200) como um desfecho resultado=0 com motivo SGCTPIX001, nunca um erro HTTP. 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: >- Chave de idempotência (= o endToEndId da transação). Obrigatório conforme in: header name: Chave-Idempotencia required: true schema: description: >- Chave de idempotência (= o endToEndId da transação). Obrigatório conforme 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: Erro components: schemas: BlockScheduleBody: additionalProperties: false properties: codMunIbge: description: Código IBGE do município do pagador (7 dígitos). format: int64 type: integer cpfCnpj: description: CPF ou CNPJ do pagador (uma string v5.5.0). type: string endToEndId: description: Id único de instrução de pagamento (32 caracteres). type: string ispb: description: ISPB do participante pagador (8 dígitos, uma string v5.5.0). type: string nrAgencia: description: Agência do pagador (nrAgencia, 4 dígitos, string). type: string nrConta: description: Número da conta do pagador (nrConta, uma string). type: string tpPessoa: description: Tipo de pessoa do pagador (0=Pessoa Fisica, 1=Pessoa Juridica). format: int64 type: integer valor: description: Valor da reserva em reais. format: double type: number required: - endToEndId - ispb - tpPessoa - cpfCnpj - nrConta - codMunIbge - valor type: object BlockScheduleResponse: additionalProperties: false properties: dtHrRespostaSgct: description: carimbo de data/hora de resposta do gateway de liquidação (UTC). type: string endToEndId: description: Id único de instrução de pagamento (32 caracteres). type: string idOperacaoSgct: description: >- id da operação de bloqueio do gateway de liquidação (GUID; presente somente quando resultado=1). type: string motivo: description: >- Motivo de rejeição (SGCTPIX001=saldo insuficiente, SGCTPIX999=outro; presente somente quando resultado=0). type: string motivoComplemento: description: Detalhe de rejeição (presente somente quando resultado=0). type: string resultado: description: Resultado do bloqueio (0=Rejeitado, 1=Aceito). format: int64 type: integer required: - endToEndId - resultado - dtHrRespostaSgct 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: -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 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). ````