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.
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.
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.
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, e a reserva é endereçada pela chave da operação que a originou (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
| Campo | Tipo | Descrição |
|---|---|---|
| balance_inquiry_key | string | Chave da consulta |
| status | string | Situação final. Enum: Status da consulta |
| reason | object | Motivo, quando a consulta falha. null em completed. Ver Motivos |
{
"webhook_type": "laas.public_payroll.balance_inquiry_status_change",
"balance_inquiry_key": "b1b9f0a6-9a3e-4f9b-9d6f-3a5f8c1d2e7b",
"status": "completed",
"reason": null
}
A notificação carrega apenas a chave, o status e o motivo. Os dados da consulta — matrículas, órgãos e margens — ficam no GET da consulta, que é autenticado e devolve o documento completo. Ver Consultar o resultado.
Reserva de margem
| Campo | Tipo | Descrição |
|---|---|---|
| reservation_key | string | Chave da reserva |
| origin_key | string | Chave da operação que originou a reserva — o cartão ou a operação de crédito |
| status | string | Novo status. Enum: Status da reserva |
| reason | object | Motivo da mudança, quando há. Ver Motivos |
{
"webhook_type": "laas.public_payroll.reservation_status_change",
"reservation_key": "6f4c2a19-8e3b-4d7a-b0c5-1e2f3a4b5c6d",
"origin_key": "a7c3e1f0-4b2d-4c8e-9f11-5d6a7b8c9d0e",
"status": "reserved",
"reason": null
}
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 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.