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.
Autorizaciones
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).
Encabezados
Bearer access token (the financial-ingress gate; the handler fails closed with Pix-0082 when absent). Token de acceso Bearer (la puerta de ingreso financiero; el handler falla en modo cerrado con Pix-0082 cuando está ausente).
Idempotency key (= the endToEndId of the transaction). Mandatory per Clave de idempotencia (= el endToEndId de la transacción). Obligatorio.
Cuerpo
Código IBGE del municipio del pagador (7 dígitos).
CPF o CNPJ del pagador (una cadena v5.5.0).
Id único de la instrucción de pago (32 caracteres).
ISPB del participante pagador (8 dígitos, una cadena v5.5.0).
Número de cuenta del pagador (nrConta, una cadena).
Tipo de persona del pagador (0=Pessoa Fisica, 1=Pessoa Juridica).
Monto a reservar en reales.
Agencia del pagador (nrAgencia, 4 dígitos, cadena).
Respuesta
OK
Marca de tiempo de respuesta del settlement-gateway (UTC).
Id único de la instrucción de pago (32 caracteres).
Resultado del bloqueo (0=Rejeitado, 1=Aceito).
Id de operación de bloqueo del settlement-gateway (GUID; presente solo cuando resultado=1).
Motivo de rechazo (SGCTPIX001=fondos insuficientes, SGCTPIX999=otro; presente solo cuando resultado=0).
Detalle del rechazo (presente solo cuando resultado=0).

