> ## 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. # Reserve an inbound PIX Automatico debit hold > Reserves a debit HOLD on the payer's transactional account for a scheduled PIX Automatico payment (section 5.4.1, the plugin is the SGCT server). JDPI calls this when it begins processing the scheduled payment. The reserve is parameterizable and disabled by default. On insufficient funds the result is returned inline (200) as a resultado=0 outcome with motivo SGCTPIX001, never an HTTP error. A schedule that is still in flight — registered but not yet confirmed by the section 6 situacao stream — is NOT refused: it answers 422 with code PIX-0022 and MUST be re-delivered, and the re-delivery is accepted once the confirmation lands. ## OpenAPI ````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/settlements/inbound/block 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/settlements/inbound/block: post: tags: - PIX Automatico summary: Reserve an inbound PIX Automatico debit hold description: >- Reserves a debit HOLD on the payer's transactional account for a scheduled PIX Automatico payment (section 5.4.1, the plugin is the SGCT server). JDPI calls this when it begins processing the scheduled payment. The reserve is parameterizable and disabled by default. On insufficient funds the result is returned inline (200) as a resultado=0 outcome with motivo SGCTPIX001, never an HTTP error. A schedule that is still in flight — registered but not yet confirmed by the section 6 situacao stream — is NOT refused: it answers 422 with code PIX-0022 and MUST be re-delivered, and the re-delivery is accepted once the confirmation lands. operationId: blockInboundPixAutomaticoSettlement 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). examples: - Bearer eyJ... type: string - description: >- Idempotency key (= the endToEndId of the transaction). Mandatory per section 5.4. in: header name: Chave-Idempotencia required: true schema: description: >- Idempotency key (= the endToEndId of the transaction). Mandatory per section 5.4. examples: - E11111111202409181500y6j6mt9l1pi 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 '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: BlockScheduleBody: additionalProperties: true properties: codMunIbge: description: Payer IBGE municipality code (7 digits). examples: - 3550308 format: int64 type: integer cpfCnpj: description: Payer CPF or CNPJ (a v5.5.0 string). examples: - '11111111111' type: string endToEndId: description: Unique payment-instruction id (32-char). examples: - E11111111202409181500y6j6mt9l1pi type: string ispb: description: Payer participant ISPB (8 digits, a v5.5.0 string). examples: - '04358798' type: string nrAgencia: description: Payer branch (nrAgencia, 4 digits, string). examples: - '1234' type: string nrConta: description: Payer account number (nrConta, a string). examples: - '12345678' type: string tpPessoa: description: Payer person type (0=Pessoa Fisica, 1=Pessoa Juridica). examples: - 0 format: int64 type: integer valor: description: >- Reserve amount in reais (a JSON number; the only money field in section 5.4). examples: - 1500.25 format: double type: number required: - endToEndId - ispb - tpPessoa - cpfCnpj - nrConta - codMunIbge - valor type: object BlockScheduleResponse: additionalProperties: false properties: dtHrRespostaSgct: description: SGCT response timestamp (UTC). examples: - '2024-09-20T04:00:01.001Z' type: string endToEndId: description: Unique payment-instruction id (32-char). examples: - E11111111202409181500y6j6mt9l1pi type: string idOperacaoSgct: description: SGCT block-operation id (GUID; present only when resultado=1). examples: - 58F752C5-6376-3252-8305-A2DE3A8525D3 type: string motivo: description: >- Rejection reason (SGCTPIX001=insufficient funds, SGCTPIX999=other; present only when resultado=0). examples: - SGCTPIX001 type: string motivoComplemento: description: Rejection detail (present only when resultado=0). examples: - Cliente nao possui saldo suficiente para o bloqueio solicitado type: string resultado: description: Block result (0=Rejeitado, 1=Aceito). examples: - 1 format: int64 type: integer required: - endToEndId - resultado - dtHrRespostaSgct 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 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 ````