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.
Autorizações
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).
Cabeçalhos
Token de acesso Bearer (o portão de entrada financeira; o handler falha de forma fechada com Pix-0082 quando ausente).
Chave de idempotência (= o endToEndId da transação). Obrigatório conforme
Corpo
Código IBGE do município do pagador (7 dígitos).
CPF ou CNPJ do pagador (uma string v5.5.0).
Id único de instrução de pagamento (32 caracteres).
ISPB do participante pagador (8 dígitos, uma string v5.5.0).
Número da conta do pagador (nrConta, uma string).
Tipo de pessoa do pagador (0=Pessoa Fisica, 1=Pessoa Juridica).
Valor da reserva em reais.
Agência do pagador (nrAgencia, 4 dígitos, string).
Resposta
OK
carimbo de data/hora de resposta do gateway de liquidação (UTC).
Id único de instrução de pagamento (32 caracteres).
Resultado do bloqueio (0=Rejeitado, 1=Aceito).
id da operação de bloqueio do gateway de liquidação (GUID; presente somente quando resultado=1).
Motivo de rejeição (SGCTPIX001=saldo insuficiente, SGCTPIX999=outro; presente somente quando resultado=0).
Detalhe de rejeição (presente somente quando resultado=0).

