Manual Consignado Privado - Tombamento do Legado
A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações.
1 - Pré requisitos
Para tombar um contrato para o novo modelo do empréstimo consignado, é necessário que este tenha sido informado previamente e esteja no status "active", caso ainda haja algum contrato legado que não foi informado ou que não esteja no status correto, favor informar o time de operações com urgência, no manual de contratos legados está a documentação para consultar os contratos informados.
Além disso, por determinação da DATAPREV, é necessário que o tomador ainda esteja empregado no mesmo vínculo do contrato informado. É possível consultar os vínculos ativos do tomador sem enviar um termo de autorização utilizando a chamada abaixo (será validado se existe um contrato legado ativo para o mesmo CPF):
2 - Consulta de vínculos empregatícios para tombamento:
A consulta de vínculos empregatícios é uma operação assíncrona. Ao enviar a requisição, a QI Tech processará a consulta em background e retornará o resultado através de um webhook quando finalizada. O webhook será enviado para a URL configurada no seu ambiente.
Para consultar os vínculos ativos de um tomador que possui um contrato legado ativo, deverá ser feita uma consulta de vínculos utilizando o mesmo endpoint do fluxo de emissão adicionando um campo extra na raiz do payload da requisição.
Request
Request Body
{
"document_number" : "<CPF FUNCIONÁRIO>",
"inquiry_type" : "legacy"
}
Response
Response Body
{
"employment_relationships_inquiry_key": "<UUID>",
"employment_relationships_inquiry_status": "pending_inquiry"
}
Webhooks
Retorno da consulta dos vínculos empregatícios:
Webhook Body
{
"key": "<Employment Relationships Inquiry Key>",
"status": "completed",
"webhook_type": "laas.private_payroll.employment_relationships_inquiry_status_change",
"event_datetime": "2025-03-24T15:28:31Z",
"data": {
"inquiry_type": "legacy",
"employment_relationships": [
{
"eligible": true,
"document_number": "47812365409",
"registration_number": "99999999999-A",
"employer_document_type": "cnpj",
"employer_document_number": "12345678000173"
},
{
"eligible": true,
"document_number": "47812365409",
"registration_number": "11111111111-B",
"employer_document_type": "cnpj",
"employer_document_number": "43211234000189"
}
]
}
}
Webhook Body
{
"key": "<Employment Relationships Inquiry Key>",
"status": "failure",
"webhook_type": "laas.private_payroll.employment_relationships_inquiry_status_change",
"event_datetime": "2025-03-24T15:28:31Z"
}
3 - Chamada de tombamento do contrato legado:
Caso a operação original tenha sido emitida pela QI Tech, deve ser informada a chave da operação e o vencimentário atualizado da operação, caso contrário, também é necessário preencher os objetos borrower e financial.
Request
- Contrato legado emitido externamente
{
"requester_identifier_key": "d6a931e8-1655-479e-97a8-df8b426f49a0",
"borrower": {
"name": "Nome devedor",
"role_type": "issuer",
"person_type": "natural",
"individual_document_number": "14471835092",
},
"collaterals": [
{
"percentage": 1,
"collateral_type": "private_payroll",
"collateral_data": {
"legacy_contract_number": "109230148",
"operation_category": "legacy_contract_rollover",
"employer_document_number": "07940839000159",
"registration_number": "99999999999-A",
},
}
],
"purchaser_document_number": "32402502000135",
"disbursement_bank_account": {
"name": "NOME DEVEDOR",
"bank_code": "001",
"account_digit": "0",
"branch_number": "2874",
"account_number": "000057555",
"document_number": "14471835092",
"transfer_method": "pix",
"percentage_receivable": 100,
},
"financial": {
"interest_type": "pre_price_days",
"disbursement_date": "2024-11-07",
"fine_configuration": {
"monthly_rate": 0.0186,
"interest_base": "calendar_days_365",
"contract_fine_rate": 0,
},
"monthly_interest_rate": 0.04,
"credit_operation_type": "ccb",
"principal_grace_period": 0,
"interest_grace_period": 0,
"total_iof": 120,
"amount": 12.24,
"disbursed_amount": 12.14,
"monthly_cet": 0.015,
"annual_cet": 31.81,
"installment_face_value": 12.57,
"installments" : [
{
"due_date":"2025-04-07",
"status": "paid"
},
{
"due_date":"2025-05-07",
"status": "paid"
},
{
"due_date":"2025-06-07",
"status": "opened"
},
{
"due_date":"2025-08-07",
"due_balance": 11.20,
"status": "paid_partial"
},
{
"due_date":"2025-09-07",
"status": "opened"
},
{
"due_date":"2025-10-07",
"status": "opened"
},
{
"due_date":"2025-11-07",
"due_balance": 70.09,
"status": "paid_partial"
}
]
},
}
Todas as parcelas devem ser informadas, mesmo que já tenham sido pagas. Os status das parcelas devem ser informados conforme a descrição abaixo.
Descrição dos Status
| Status | Descrição |
|---|---|
opened | Parcela em aberto |
paid_partial | Parcela parcialmente paga |
paid | Parcela totalmente paga |
overdue | Parcela vencida e não paga |
Response
Response Body
{
"credit_operation_key": "<UUID>",
"contract_number": "0123456789/ABC",
"credit_operation_status" : "opened",
"operation_type" : "legacy_rollover",
"disbursement_date" : "2023-04-05",
"issuer_name" : "Nome Devedor",
"issuer_document_number" : "14471835092"
}