Reserve an inbound Pix Automático debit hold
Reserves a debit HOLD on the payer’s transactional account for a scheduled Pix Automático payment. Upstream 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.
Authorizations
JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint
using client credentials (clientId and clientSecret).
Include token in Authorization header:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Token expires after 3600 seconds (1 hour).
Headers
Bearer access token (the financial-ingress gate; the handler fails closed with Pix-0082 when absent).
Idempotency key (= the endToEndId of the transaction). Mandatory per
Body
Payer IBGE municipality code (7 digits).
Payer CPF or CNPJ (a v5.5.0 string).
Unique payment-instruction id (32-char).
Payer participant ISPB (8 digits, a v5.5.0 string).
Payer account number (nrConta, a string).
Payer person type (0=Pessoa Fisica, 1=Pessoa Juridica).
Reserve amount in reais.
Payer branch (nrAgencia, 4 digits, string).
Response
OK
settlement-gateway response timestamp (UTC).
Unique payment-instruction id (32-char).
Block result (0=Rejeitado, 1=Aceito).
settlement-gateway block-operation id (GUID; present only when resultado=1).
Rejection reason (SGCTPIX001=insufficient funds, SGCTPIX999=other; present only when resultado=0).
Rejection detail (present only when resultado=0).

