Pular para o conteúdo principal

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_items
MÉTODO
GET
STATUS
200

Autenticação​

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

Parâmetros de caminho​

CampoTipoObrigatórioDescriçãoTamanho
assignment_keyuuidSimChave do lote de cessão.36

Parâmetros de consulta​

CampoTipoObrigatórioDescriçãoTamanho
pageintegerNãoPágina desejada. Padrão 1.—
page_sizeintegerNãoAtivos 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​

CampoTipoObrigatórioDescriçãoTamanho
assignment_item_keyuuidSimChave do ativo no lote.36
credit_operation_keyuuidSimChave da dívida (CCB).36
contract_numberstringSimNúmero da CCB.—
requester_identifier_keystringNãoIdentificador da dívida no seu sistema, quando informado na emissão.—
control_numberstringNãoNúmero de controle do ativo, gerado pelo modelo da configuração de cessão.—
statusstringSimStatus do ativo no lote, por exemplo settled, rejected ou canceled.—
settledbooleanSimtrue quando o lote foi liquidado e o ativo não foi cancelado.—
present_amountnumberSimValor presente do ativo na data-base da cessão, em reais.—
contract_present_amountnumberNãoValor presente do contrato, em reais.—
issue_amountnumberSimValor de emissão da CCB, em reais.—
disbursed_amountnumberSimValor desembolsado ao tomador, em reais.—
disbursement_datestringSimData do desembolso, no formato AAAA-MM-DD.10
number_of_installmentsintegerSimQuantidade de parcelas da CCB.—
issuer_namestringSimNome do tomador.—
issuer_document_numberstringSimCPF ou CNPJ do tomador, só dígitos.14
purchaser_document_numberstringSimCNPJ do cessionário, só dígitos.14
endorsement_urlstringNãoURL do endosso da CCB, quando gerado.—
rejected_reasonsarrayNãoPresente só quando o ativo foi recusado. Cada item tem reason e reason_details.—
assignment_item_installmentsarraySimParcelas do ativo. Veja a tabela abaixo.—

Atributos de assignment_item_installments​

CampoTipoObrigatórioDescriçãoTamanho
installment_keyuuidSimChave da parcela.36
installment_numberintegerSimNúmero da parcela.—
due_datestringSimVencimento da parcela, no formato AAAA-MM-DD.10
total_amountnumberSimValor da parcela no vencimento, em reais.—
present_amountnumberSimValor presente da parcela na data-base, em reais.—
your_numberintegerNãoNú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​

StatusCódigoDescrição
403QIT000005O lote não pertence à sua integração.
404ASG0000011Nenhum lote encontrado com essa assignment_key.

Próximo passo​