Listar ativos do lote
Lista, de forma paginada, as dívidas (CCBs) de um lote de cessão: valor presente, status de cada uma, parcelas e, quando houver, o motivo da recusa pelo cessionário.
Endpoint
ENDPOINT
/v2/assignment/ASSIGNMENT_KEY/assignment_itemsMÉTODO
GETSTATUS
200Autenticaçã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 |
Parâmetros de consulta
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
page | integer | Não | Página desejada. Padrão 1. | — |
page_size | integer | Não | Ativos por página. Padrão 10. | — |
Resposta
A resposta tem data (os ativos da página) e pagination (page e page_size). A resposta não traz o total; pare quando data vier com menos itens que page_size.
Atributos de cada ativo
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
assignment_item_key | uuid | Sim | Chave do ativo no lote. | 36 |
credit_operation_key | uuid | Sim | Chave da dívida (CCB). | 36 |
contract_number | string | Sim | Número da CCB. | — |
requester_identifier_key | string | Não | Identificador da dívida no seu sistema, quando informado na emissão. | — |
control_number | string | Não | Número de controle do ativo, gerado pelo modelo da configuração de cessão. | — |
status | string | Sim | Status do ativo no lote, por exemplo settled, rejected ou canceled. | — |
settled | boolean | Sim | true quando o lote foi liquidado e o ativo não foi cancelado. | — |
present_amount | number | Sim | Valor presente do ativo na data-base da cessão, em reais. | — |
contract_present_amount | number | Não | Valor presente do contrato, em reais. | — |
issue_amount | number | Sim | Valor de emissão da CCB, em reais. | — |
disbursed_amount | number | Sim | Valor desembolsado ao tomador, em reais. | — |
disbursement_date | string | Sim | Data do desembolso, no formato AAAA-MM-DD. | 10 |
number_of_installments | integer | Sim | Quantidade de parcelas da CCB. | — |
issuer_name | string | Sim | Nome do tomador. | — |
issuer_document_number | string | Sim | CPF ou CNPJ do tomador, só dígitos. | 14 |
purchaser_document_number | string | Sim | CNPJ do cessionário, só dígitos. | 14 |
endorsement_url | string | Não | URL do endosso da CCB, quando gerado. | — |
rejected_reasons | array | Não | Presente só quando o ativo foi recusado. Cada item tem reason e reason_details. | — |
assignment_item_installments | array | Sim | Parcelas do ativo. Veja a tabela abaixo. | — |
Atributos de assignment_item_installments
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
installment_key | uuid | Sim | Chave da parcela. | 36 |
installment_number | integer | Sim | Número da parcela. | — |
due_date | string | Sim | Vencimento da parcela, no formato AAAA-MM-DD. | 10 |
total_amount | number | Sim | Valor da parcela no vencimento, em reais. | — |
present_amount | number | Sim | Valor presente da parcela na data-base, em reais. | — |
your_number | integer | Não | Número de identificação da parcela. | — |
Exemplo de resposta
{
"data": [
{
"assignment_item_key": "cbd84a21-77a7-42b4-a58d-1202103490cd",
"credit_operation_key": "684c24b6-33b7-4b4d-b9b4-6ca3f1bb3740",
"contract_number": "0000000001/CCB",
"requester_identifier_key": "SEU-ID-0001",
"control_number": "0000000001",
"status": "settled",
"settled": true,
"present_amount": 727.36,
"contract_present_amount": 730.12,
"issue_amount": 800.0,
"disbursed_amount": 750.0,
"disbursement_date": "2026-09-25",
"number_of_installments": 1,
"issuer_name": "NOME DO TOMADOR",
"issuer_document_number": "96969879003",
"purchaser_document_number": "12345678000190",
"endorsement_url": null,
"assignment_item_installments": [
{
"installment_key": "0f3b6a1e-5d2c-4b7a-9e8f-1a2b3c4d5e6f",
"installment_number": 1,
"due_date": "2026-10-25",
"total_amount": 800.0,
"present_amount": 727.36,
"your_number": null
}
]
}
],
"pagination": {
"page": 1,
"page_size": 10
}
}
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. |