Webhook de lote de cessão
A QI Tech envia este webhook ao originador quando um lote de cessão chega a um status final: liquidado (settled) ou cancelado (canceled). Ele descreve o lote como um todo. Para saber quais dívidas (CCBs) entraram no lote, liste os ativos do lote.
WEBHOOK_TYPE
assignment.status_changeA URL que recebe o webhook é configurada uma única vez para a sua integração. Veja Configurando webhooks.
Corpo do webhook
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
key | uuid | Sim | Chave do lote de cessão. Igual a data.assignment_key. | 36 |
webhook_type | string | Sim | Sempre assignment.status_change. | — |
event_datetime | string | Sim | Data e hora do evento, em UTC, no formato AAAA-MM-DDTHH:MM:SS. | 19 |
data | object | Sim | Dados do lote. Veja a tabela abaixo. | — |
Atributos de data
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
assignment_key | uuid | Sim | Chave do lote de cessão. | 36 |
status | string | Sim | Status final do lote: settled (liquidado) ou canceled (cancelado). | — |
reference_date | string | Sim | Data-base da cessão, usada na precificação, no formato AAAA-MM-DD. | 10 |
number_of_items | integer | Sim | Quantidade de dívidas que permaneceram no lote, depois das recusas e retiradas. | — |
total_number_of_items | integer | Sim | Quantidade de dívidas selecionadas para o lote, antes das recusas e retiradas. | — |
total_amount | number | Não | Soma do valor presente das dívidas do lote, em reais. Pode vir null quando o lote é cancelado. | — |
term_of_assignment_url | string | Não | URL do termo de cessão, quando o fluxo gera o termo. null quando não há termo. | 2048 |
Exemplo — lote liquidado
{
"key": "8a369478-8024-4e55-97f0-f9e6f29cbbee",
"webhook_type": "assignment.status_change",
"event_datetime": "2026-09-29T14:50:53",
"data": {
"assignment_key": "8a369478-8024-4e55-97f0-f9e6f29cbbee",
"status": "settled",
"reference_date": "2026-09-29",
"number_of_items": 459,
"total_number_of_items": 459,
"total_amount": 63848.05,
"term_of_assignment_url": null
}
}
Exemplo — lote cancelado
{
"key": "60055b72-62aa-4daa-b6ad-adcaeedfe5ff",
"webhook_type": "assignment.status_change",
"event_datetime": "2026-09-29T14:33:36",
"data": {
"assignment_key": "60055b72-62aa-4daa-b6ad-adcaeedfe5ff",
"status": "canceled",
"reference_date": "2026-09-29",
"number_of_items": 0,
"total_number_of_items": 226,
"total_amount": null,
"term_of_assignment_url": null
}
}
Erros
Este webhook não devolve erro ao originador. A sua URL deve responder com um status 2xx; o comportamento de entrega está em Configurando webhooks.
Próximo passo
- Listar ativos do lote: as dívidas do lote, com o status de cada uma.
- Consultar lote de cessão: o estado atual do lote, a qualquer momento.