Consignado Público - Webhooks

Os fluxos do Consignado Público são assíncronos: a requisição registra a intenção e devolve 202, e o resultado chega por webhook. Esta página lista as notificações publicadas hoje.

API em desenvolvimento

Esta API está em fase de desenvolvimento, sendo assim, esta página está sujeita a alterações. Os webhooks das etapas de crédito — simulação, emissão, formalização e desembolso — são publicados junto com aquelas modalidades.

Atenção!

Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Notificações

webhook_type	Quando é enviado
laas.public_payroll.balance_inquiry_status_change	A consulta de margem termina, em completed ou failed
laas.public_payroll.reservation_status_change	A reserva muda de status

Cada parceiro recebe apenas as suas operações. O webhook da reserva traz também a chave da operação que a originou (data.origin_key) — a mesma chave que o parceiro já usa para acompanhar o cartão ou a operação de crédito.

Consulta de margem

Enviado uma vez por consulta, quando ela termina em completed ou failed.

Campo	Tipo	Descrição
webhook_type	string	laas.public_payroll.balance_inquiry_status_change
key	string	Chave da consulta (balance_inquiry_key)
status	string	Situação final. Enum: Status da consulta
event_datetime	string	Momento do envio, em UTC
data	object	Em completed, a consulta exatamente como o GET da consulta a devolve, sem expansões. Em failed, o motivo, {reason}. Ver Motivos

completed

{
  "webhook_type": "laas.public_payroll.balance_inquiry_status_change",
  "key": "b1b9f0a6-9a3e-4f9b-9d6f-3a5f8c1d2e7b",
  "status": "completed",
  "event_datetime": "2026-08-26T13:02:41Z",
  "data": {
    "balance_inquiry_key": "b1b9f0a6-9a3e-4f9b-9d6f-3a5f8c1d2e7b",
    "requester_key": "4d1e8c2a-7b3f-4e9a-8c5d-2f6a1b0e9c3d",
    "status": "completed",
    "observed_at": "2026-08-26T13:02:40Z",
    "consignment_entity": { ... },
    "employee": { ... },
    "authorization_term": null,
    "employment_relationships": [ ... ]
  }
}

failed

{
  "webhook_type": "laas.public_payroll.balance_inquiry_status_change",
  "key": "b1b9f0a6-9a3e-4f9b-9d6f-3a5f8c1d2e7b",
  "status": "failed",
  "event_datetime": "2026-08-26T13:02:41Z",
  "data": {
    "reason": {
      "code": "LSCC0001",
      "enumerator": "employee_not_authorized",
      "description": "The employee did not authorize the margin inquiry",
      "translation": "O servidor não autorizou a consulta de margem"
    }
  }
}

As expansões (expand=appointments, expand=history) ficam apenas no GET da consulta. Ver Detalhar por provimento.

Reserva de margem

Enviado a cada mudança de status da reserva depois da criação.

pending_confirmation

O webhook também é enviado em pending_confirmation, quando o ente registra a averbação. Nos órgãos que exigem a aprovação do servidor, é o momento de orientá-lo a aprovar no aplicativo do ente, ainda no mesmo dia.

Campo	Tipo	Descrição
webhook_type	string	laas.public_payroll.reservation_status_change
key	string	Chave da reserva (reservation_key)
status	string	Novo status. Enum: Status da reserva
event_datetime	string	Momento do envio, em UTC
data	object	A mudança de status, nos campos abaixo

Campo	Tipo	Descrição
data.reservation_key	string	Chave da reserva
data.origin_key	string	Chave da operação que originou a reserva — o cartão ou a operação de crédito
data.status	string	Novo status, o mesmo de status
data.reason	object	Motivo da mudança, ou null quando o status não tem motivo. Ver Motivos

reserved

{
  "webhook_type": "laas.public_payroll.reservation_status_change",
  "key": "6f4c2a19-8e3b-4d7a-b0c5-1e2f3a4b5c6d",
  "status": "reserved",
  "event_datetime": "2026-08-18T12:15:03Z",
  "data": {
    "reservation_key": "6f4c2a19-8e3b-4d7a-b0c5-1e2f3a4b5c6d",
    "origin_key": "a7c3e1f0-4b2d-4c8e-9f11-5d6a7b8c9d0e",
    "status": "reserved",
    "reason": null
  }
}

canceled

{
  "webhook_type": "laas.public_payroll.reservation_status_change",
  "key": "6f4c2a19-8e3b-4d7a-b0c5-1e2f3a4b5c6d",
  "status": "canceled",
  "event_datetime": "2026-08-17T17:05:12Z",
  "data": {
    "reservation_key": "6f4c2a19-8e3b-4d7a-b0c5-1e2f3a4b5c6d",
    "origin_key": "a7c3e1f0-4b2d-4c8e-9f11-5d6a7b8c9d0e",
    "status": "canceled",
    "reason": {
      "code": "ESCC0050",
      "enumerator": "insufficient_margin",
      "description": "The employee's payroll margin is lower than the installment amount",
      "translation": "A margem consignável do servidor é menor que o valor da parcela"
    }
  }
}

Os status que encerram a contratação são reserved — margem comprometida, operação garantida — e deleted ou canceled, quando a averbação não existe mais ou nunca chegou a existir. O data.reason é o que distingue os motivos, e em particular identifica a falta de aprovação do servidor, o único caso em que refazer a contratação é o caminho. Ver Confirmação.