Consultar lote de cessão

Devolve o estado atual de um lote de cessão: status, data-base, quantidade de dívidas, valor total e termo de cessão. Use para acompanhar um lote recebido no webhook de lote de cessão.

Endpoint

ENDPOINT

/v2/assignment/ASSIGNMENT_KEY

MÉTODO

GET

STATUS

200

Autenticação

Requer assinatura da requisição. Veja Troca de chaves.

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição	Tamanho
`assignment_key`	`uuid`	Sim	Chave do lote de cessão.	36

Resposta

Campo	Tipo	Obrigatório	Descrição	Tamanho
`assignment_key`	`uuid`	Sim	Chave do lote de cessão.	36
`status`	`string`	Sim	Status atual do lote. Os status finais são `settled` (liquidado) e `canceled` (cancelado).	—
`settled`	`boolean`	Sim	`true` quando a liquidação financeira do lote já ocorreu.	—
`reference_date`	`string`	Sim	Data-base da cessão, no formato `AAAA-MM-DD`.	10
`creation_datetime`	`string`	Sim	Data e hora de criação do lote, em ISO 8601.	—
`number_of_items`	`integer`	Sim	Quantidade de dívidas que permanecem no lote.	—
`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.	—
`term_of_assignment_url`	`string`	Não	URL do termo de cessão assinado. `null` enquanto não houver termo.	2048
`signable_term_url`	`string`	Não	URL para assinar o termo de cessão, quando ele existe e ainda não foi assinado.	—
`external_identifier`	`string`	Não	Identificador externo do lote, quando informado.	—

信息

Enquanto o lote está em andamento, status passa por status intermediários (seleção, cálculo, registro, envio ao cessionário, assinatura do termo). Para integrar, trate settled e canceled como finais e os demais como "em andamento".

{
    "assignment_key": "8a369478-8024-4e55-97f0-f9e6f29cbbee",
    "status": "settled",
    "settled": true,
    "reference_date": "2026-09-29",
    "creation_datetime": "2026-09-29T06:00:12",
    "number_of_items": 459,
    "total_number_of_items": 459,
    "total_amount": 63848.05,
    "term_of_assignment_url": null,
    "signable_term_url": null,
    "external_identifier": null
}

Erros

Status	Código	Descrição
403	`QIT000005`	O lote não pertence à sua integração.
404	`ASG0000011`	Nenhum lote encontrado com essa `assignment_key`.

Webhooks relacionados

Webhook de lote de cessão

Endpoint​

Autenticação​

Parâmetros de caminho​

Resposta​

Erros​

Webhooks relacionados​

Próximo passo​