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.

Listagem de ativos

Retorna a lista paginada de todos os ativos de um lote.

Request

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

Query params

ParâmetroTipoObrigatoriedadeDescrição
pageintegeropcionalNúmero da página (começa em 0). Padrão: 0.
limitintegeropcionalQuantidade de registros por página. Padrão: 10.
Exemplo de chamada
GET /trade_receivables/fund_class/{fund_class_key}/assignment/{assignment_external_id}/assets?page=0&limit=10

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_bystringIndica o motivo da reprovação (ex: document, eligibility). Presente apenas quando o ativo foi reprovado.
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.

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

StatusDescrição
pending_eligibilityAtivo inserido, aguardando análise de elegibilidade.
pre_approvedAtivo pré-aprovado na elegibilidade individual.
pending_documentationAtivo aprovado na elegibilidade, aguardando envio de documentos.
approvedAtivo aprovado e com documentação validada.
deniedAtivo reprovado na elegibilidade ou na validação de documentos.
discardedAtivo descartado do lote.