Pular para o conteúdo principal

Consulta de Ativos do Lote

Endpoints para consultar os ativos inseridos em um lote de cessão. Existem dois modos de consulta: a listagem paginada de todos os ativos de um lote, e a consulta individual de um ativo específico.

Quando utilizar

Utilize estes endpoints para acompanhar o status dos ativos após a inserção, verificar quais foram aprovados ou reprovados na elegibilidade, e consultar os motivos de reprovação quando houver.

A listagem aceita filtros — inclusive por status — o que permite consultar diretamente apenas os ativos reprovados, sem precisar paginar o lote inteiro. Veja Consultar apenas os ativos reprovados.

Listagem de ativos

Retorna a lista paginada dos ativos de um lote, com suporte a filtros.

Request

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment/{assignment_external_id}/assets
MÉTODO
GET

Query params

Todos os filtros são opcionais e podem ser combinados entre si. Quando nenhum filtro é informado, a rota devolve todos os ativos do lote.

ParâmetroTipoPadrãoDescrição
pageinteger0Número da página (começa em 0).
limitinteger10Quantidade de registros por página. Máximo: 100.
statusstringFiltra por um status de ativo. Aceita um único valor, que deve ser um dos enumeradores de status. Use denied para obter apenas os ativos reprovados.
external_idstringFiltra pelo external_id do ativo informado na criação.
contract_numberstringFiltra pelo número do contrato da operação.
borrower_document_numberstringFiltra pelo CPF/CNPJ do devedor (sacado ou tomador, conforme o tipo de ativo).
purchase_value_minnumberValor mínimo de compra do ativo (inclusive).
purchase_value_maxnumberValor máximo de compra do ativo (inclusive).
maturity_date_startstring (AAAA-MM-DD)Data de vencimento inicial do intervalo.
maturity_date_endstring (AAAA-MM-DD)Data de vencimento final do intervalo.
Exemplo — listagem simples
GET /trade_receivables/fund_class/{fund_class_key}/assignment/{assignment_external_id}/assets?page=0&limit=10
Exemplo — filtros combinados
GET /trade_receivables/fund_class/{fund_class_key}/assignment/{assignment_external_id}/assets?status=denied&limit=100&maturity_date_start=2024-01-01&maturity_date_end=2024-12-31
Status inválido

Se o valor enviado em status não corresponder a nenhum enumerador válido, a requisição retorna erro. Consulte a tabela de enumeradores antes de montar o filtro.

Response

STATUS
200
Response Body
{
"data": [
{
"asset_key": "f4348106-01c4-4c59-a261-7c09db811c47",
"external_id": "e292656f-f7fb-44dc-96f3-667c36c88442",
"total_purchase_value": 1231.21,
"asset_type": "duplicata_mercantil",
"status": "denied",
"duration": 9177,
"denied_by": "document",
"denial_reason": "Invalid documents"
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}

Atributos da resposta

CampoTipoDescrição
dataarrayLista de objetos de ativo. Veja tabela abaixo.
pageintegerNúmero da página atual.
limitintegerQuantidade de registros por página.
is_last_pagebooleanIndica se esta é a última página de resultados.

Atributos de cada ativo (objetos dentro de data)

CampoTipoDescrição
asset_keystringIdentificador único do ativo (UUID).
external_idstringChave externa fornecida pelo parceiro na criação.
total_purchase_valuenumberValor total de compra do ativo.
asset_typestringTipo do ativo (ex: ccb, duplicata_mercantil, discounted_contract).
statusstringStatus atual do ativo. Consulte a tabela de status abaixo.
durationintegerDuração do ativo em dias. Pode não estar presente se ainda não foi calculada.
denied_bystringOrigem da reprovação. Presente apenas quando o ativo foi reprovado. Consulte a tabela de origens.
denial_reasonstringDescrição do motivo da reprovação. Presente apenas quando o ativo foi reprovado.
Objetos aninhados

Dependendo do tipo de ativo, a resposta incluirá o objeto credit_operation (para CCBs) ou discounted_credit_right (para duplicatas e contratos descontados) com todos os dados da operação de crédito.

Consultar apenas os ativos reprovados

Este é o uso mais comum da listagem: descobrir quais contratos do lote foram reprovados, para refletir a decisão da QI Tech no controle interno do parceiro e decidir se algum ativo precisa ser removido do lote.

Basta informar status=denied:

Request
GET /trade_receivables/fund_class/{fund_class_key}/assignment/{assignment_external_id}/assets?status=denied&limit=100

A resposta traz somente os ativos reprovados, cada um com denied_by (a origem da reprovação) e denial_reason (a descrição):

Response Body
{
"data": [
{
"asset_key": "f4348106-01c4-4c59-a261-7c09db811c47",
"external_id": "e292656f-f7fb-44dc-96f3-667c36c88442",
"total_purchase_value": 1231.21,
"asset_type": "ccb",
"status": "denied",
"duration": 9177,
"denied_by": "eligibility",
"denial_reason": "Prazo do contrato acima do permitido pela política do fundo"
}
],
"limit": 100,
"page": 0,
"is_last_page": true
}
Recomendações de uso
  • Use limit=100 (o máximo permitido) para reduzir o número de páginas e pagine até is_last_page ser true.
  • Consulte após receber o webhook pending_manager_approval — nesse momento a análise de elegibilidade de todos os ativos já foi concluída e a lista de reprovados está estável.
  • Para o inverso — os ativos aprovados na elegibilidade — use status=pre_approved.

Origens de reprovação (denied_by)

ValorSignificado
eligibilityReprovado na análise de elegibilidade.
documentReprovado na validação dos documentos enviados.
inconsistencyReprovado por inconsistência nos dados da operação identificada na validação.
invalid_invoiceReprovado na validação da nota fiscal.
registryReprovado no processo de registro do ativo.
termReprovado na etapa do Termo de Cessão.
managerReprovado/removido por ação do gestor do fundo.
consultantReprovado/removido por ação do consultor.
assignorReprovado/removido por ação do cedente.
accounting_closeReprovado por fechamento contábil do fundo.
denial_fileReprovado por arquivo de reprovação processado em lote.

Consulta de ativo específico

Retorna os dados completos de um ativo específico do lote.

Request

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/asset/{asset_external_id}
MÉTODO
GET

Path params

ParâmetroTipoDescrição
asset_external_idstringO external_id informado na criação do ativo.

Response

STATUS
200
Response Body
{
"asset_key": "074f8786-447f-4524-9f4f-a5cf8a890bb4",
"external_id": "acfbc329-4e67-40ea-bd8d-5debdaebe144",
"total_purchase_value": 1231.21,
"asset_type": "duplicata_mercantil",
"status": "denied",
"duration": 9184,
"denied_by": "document",
"denial_reason": "Invalid documents"
}

Atributos da resposta

A resposta possui a mesma estrutura de cada objeto do array data retornado pela listagem de ativos, acrescida do objeto completo da operação de crédito (credit_operation ou discounted_credit_right, dependendo do tipo de ativo).

Enumeradores de status do ativo

Qualquer um dos valores abaixo pode ser usado no filtro status da listagem.

StatusDescrição
createdAtivo criado, ainda não submetido à análise.
pending_eligibilityAtivo inserido, aguardando análise de elegibilidade.
pending_documentationAtivo aprovado na elegibilidade, aguardando envio de documentos.
pending_invoice_validationAguardando validação da nota fiscal.
pre_approvedAtivo pré-aprovado na elegibilidade individual.
pending_registryAguardando início do registro do ativo.
pending_external_registryAguardando registro em câmara externa.
sending_to_registryEm envio para a câmara de registro.
waiting_registryRegistro submetido, aguardando retorno da câmara.
pending_formalizationAtivo formalizado e apto a seguir no lote.
registry_deniedRegistro do ativo recusado pela câmara.
sending_to_walletEm processo de encarteiramento na carteira do fundo.
deniedAtivo reprovado. Consulte denied_by para a origem da reprovação.
discardedAtivo descartado do lote.
completedAtivo encarteirado na carteira do fundo.