Skip to main content

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_change

A URL que recebe o webhook é configurada uma única vez para a sua integração. Veja Configurando webhooks.

Corpo do webhook​

CampoTipoObrigatórioDescriçãoTamanho
keyuuidSimChave do lote de cessão. Igual a data.assignment_key.36
webhook_typestringSimSempre assignment.status_change.—
event_datetimestringSimData e hora do evento, em UTC, no formato AAAA-MM-DDTHH:MM:SS.19
dataobjectSimDados do lote. Veja a tabela abaixo.—

Atributos de data​

CampoTipoObrigatórioDescriçãoTamanho
assignment_keyuuidSimChave do lote de cessão.36
statusstringSimStatus final do lote: settled (liquidado) ou canceled (cancelado).—
reference_datestringSimData-base da cessão, usada na precificação, no formato AAAA-MM-DD.10
number_of_itemsintegerSimQuantidade de dívidas que permaneceram no lote, depois das recusas e retiradas.—
total_number_of_itemsintegerSimQuantidade de dívidas selecionadas para o lote, antes das recusas e retiradas.—
total_amountnumberNãoSoma do valor presente das dívidas do lote, em reais. Pode vir null quando o lote é cancelado.—
term_of_assignment_urlstringNãoURL 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​