Pular para o conteúdo principal

Recuperação do Lote de Cessão

Recupera os detalhes completos de um lote de cessão específico, incluindo a configuração de cessão, o status atual, o histórico de eventos, os dados de desembolso e os valores financeiros.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer Cessões
Cedenteassignor-apiLeitura

URL base de cada host: Ambientes (Hosts).

Quando utilizar

Use este endpoint para consultar o estado atual de um lote a qualquer momento do fluxo — por exemplo, para verificar se o lote já passou pela elegibilidade, se já foi aprovado ou se o pagamento foi realizado. Também é a consulta a fazer quando a criação devolve duplicidade (TRC000041).

Request​

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

Path params​

ParâmetroTipoDescrição
fund_class_keystringChave única do fundo (UUID).
assignment_configuration_keystringChave da configuração de cessão (UUID).
assignment_external_idstringO external_id informado na criação do lote.

Response​

STATUS
200
Response Body
Response Body
{
"assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
"name": "CESSÃO #12345",
"assignment_configuration": {
"assignment_configuration_key": "3571e292-3a83-4011-904d-20ee963022ef",
"validation_configuration_key": "5f0e3a4c-2b7d-4c1e-9a8f-0d6b1c2e3f40",
"assignment_configuration_name": "Config CCB Fundo Alpha",
"assignment_contract_key": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"registry_type": "internal_registry",
"asset_type": "ccb",
"fund_class": {
"fund_class_key": "f1a2b3c4-d5e6-4890-abcd-ef1234567890",
"name": "Fundo Alpha FIDC",
"document_number": "11.222.333/0001-81",
"accounting_date": "2024-04-01",
"manager": {
"manager_key": "e1f2a3b4-c5d6-4890-abcd-ef1234567890",
"document_number": "22.222.222/0001-91",
"manager_name": "Gestora Exemplo S.A."
}
},
"assignor": {
"assignor_key": "c1d2e3f4-a5b6-4890-abcd-ef1234567890",
"document_number": "33.333.333/0001-91",
"name": "Cedente Exemplo Ltda"
},
"assignment_reports": {
"send_reports": false
},
"assignment_configuration_type": "default_configuration",
"status": "active",
"consultant_decision_type": "manual_approval",
"manager_decision_type": "manual_approval",
"asset_fees": null,
"payment_type": "pix",
"custody_type": "internal",
"required_documents": ["ccb"],
"after_assignment_required_documents": [],
"certifier": "certifiqi",
"disbursement_account_policy": "all_assignor_accounts",
"consultant": {
"consultant_key": "a7b8c9d0-e1f2-4a3b-8c4d-5e6f7a8b9c0d",
"document_number": "44.444.444/0001-91",
"name": "Consultoria Exemplo Ltda"
},
"operation_type": "unsecured_credit",
"originator_bonds": [
{
"originator": {
"originator_key": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
"document_number": "33.333.333/0001-91",
"name": "Cedente Exemplo Ltda"
}
}
]
},
"assignment_number": "12345",
"assignment_date": "2024-04-01",
"status": "completed",
"assignment_term_key": "b1c2d3e4-f5a6-4890-abcd-ef1234567890",
"disbursement": {
"target_account": {
"account_key": "d1e2f3a4-b5c6-4890-abcd-ef1234567890",
"account_type": "checking_account",
"account_branch": "0001",
"account_number": "12345",
"account_digit": "4",
"financial_institution_code": "341",
"financial_institution_ispb": "60701190",
"owner": {
"document_number": "33.333.333/0001-91"
},
"payment_type": "pix"
}
},
"origin_type": "client",
"payment_type": "pix",
"assignment_total_value": 150000.00,
"assignment_irr": 0.0215,
"status_events": [
{
"status": "pending_assets_insertion",
"event_datetime": "2024-04-01 10:00:00.123456",
"selected_agent": {
"AGENT-TYPE": "assignor",
"AGENT-KEY": "c1d2e3f4-a5b6-4890-abcd-ef1234567890",
"AGENT-USER": "usuario@exemplo.com"
}
},
{
"status": "completed_assets_insertion",
"event_datetime": "2024-04-01 11:30:00.654321"
},
{
"status": "completed",
"event_datetime": "2024-04-01 16:00:00.000000"
}
]
}

Atributos da resposta​

CampoTipoDescrição
assignment_keystringIdentificador único do lote gerado pela QI Tech (UUID).
external_idstringChave externa fornecida pelo parceiro na criação.
namestringNome identificador da cessão.
assignment_numberstringNúmero do lote de cessão.
assignment_datestringData da cessão no formato YYYY-MM-DD.
statusstringStatus atual do lote. Veja os status do lote.
origin_typestringOrigem do lote. Lotes criados pela API de integração têm client.
payment_typestring | nullForma de pagamento ao cedente: pix ou wire_transfer. Vem do lote ou, se não informada nele, da configuração de cessão.
assignment_term_keystring | nullChave do Termo de Cessão (UUID). Preenchida depois que o termo é gerado; a partir daí, baixe-o em Termo de Cessão do Lote.
assignment_total_valuenumberValor total da cessão em reais. Ausente até o primeiro cálculo, feito no encerramento da inserção.
assignment_irrnumberTaxa interna de retorno do lote. Ausente enquanto não calculada.
assignment_configurationobjectConfiguração de cessão do lote. Os campos estão em Listagem de Configurações de Cessão.
disbursementobject | nullConta de desembolso do lote, em target_account, com os campos da conta e a payment_type usada. null enquanto não definida.
assignor_discountsarrayDescontos ao cedente. Presente apenas quando o lote tem descontos. Veja tabela abaixo.
status_eventsarrayHistórico de transições de status do lote. Veja tabela abaixo.

Atributos de assignor_discounts​

CampoTipoDescrição
assignor_discount_keystringChave única do desconto (UUID).
assignor_discount_typestringexpense_reimbursement ou others.
statusstringcreated, pending_execution, executed ou rejected.
total_valuenumberValor do desconto em reais.
descriptionstringDescrição do desconto.

Atributos de status_events​

CampoTipoDescrição
statusstringStatus para o qual o lote foi.
event_datetimestringData e hora da transição, em UTC, no formato YYYY-MM-DD HH:MM:SS.ffffff.
selected_agentobjectAgente que fez a transição (AGENT-TYPE, AGENT-KEY e AGENT-USER). Ausente em transições automáticas.
denial_reasonstringPresente em denied e discarded: origem da reprovação ou do descarte (eligibility, registry, accounting_close, payment, manager, asset_documents, manual, consultant ou inconsistency).
denial_metadataobjectDetalhe da reprovação, quando houver — por exemplo, as regras de elegibilidade reprovadas ou o denial_reason enviado na aprovação.

Erros​

StatusCódigoQuando acontece
404TRC000016A combinação de fund_class_key e assignment_configuration_key não corresponde a nenhuma configuração de cessão.
404TRC000018Nenhum lote com esse external_id nesta configuração de cessão.

Erros de autenticação, permissão e host: veja Erros da API.