私人薪资抵押贷款手册 - 遗留合同归档
开发中的 API
该 API 仍处于开发阶段，因此本手册可能会有所更改。
1 - 前提条件
要将合同归档到新的薪资抵押贷款模式，该合同必须已事先报告且状态为 "active"。如果仍有尚未报告或状态不正确的遗留合同，请立即通知运营团队。遗留合同手册中有查询已报告合同的文档。
此外，根据 DATAPREV 的规定，借款人必须仍在合同所记录的同一雇佣关系中工作。可以不发送授权条款，通过以下调用查询借款人的有效雇佣关系（将验证同一 CPF 是否存在有效遗留合同）：
2 - 归档雇佣关系查询：
雇佣关系查询是异步操作。发送请求后，QI Tech 将在后台处理查询，并在完成后通过 webhook 返回结果。 Webhook 将发送到您环境中配置的 URL。
要查询拥有有效遗留合同的借款人的有效雇佣关系，应使用与发行流程相同的端点，并在请求 payload 根节点中添加额外字段。
POST
/private_payroll/employment_relationships_inquiryRequest
Request Body
{
"document_number" : "<CPF FUNCIONÁRIO>",
"inquiry_type" : "legacy"
}
Response
STATUS
202 AcceptedResponse Body
{
"employment_relationships_inquiry_key": "<UUID>",
"employment_relationships_inquiry_status": "pending_inquiry"
}
Webhooks
WEBHOOK TYPE
laas.private_payroll.employment_relationships_inquiry_status_change雇佣关系查询返回结果：
STATUS
completedWebhook 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"
}
]
}
}
STATUS
failedWebhook 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 - 遗留合同归档调用：
注意！
借款人姓名、雇主文件号和雇佣关系工号字段必须填写雇佣关系查询中返回的数据，否则 DATAPREV 将在核批时返回错误。
注意！
如果原始操作中收取了注册费（TAC），该费用的金额将根据发行金额与放款金额和 IOF 金额之和的差值计算得出。
TOMBAMENTO
Request
POST
/credit_operation/external- 外部发行的遗留合同
Request Body
{
"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",
},
}
],
"control_number": "CTRL-2025-0001",
"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": 50,
"amount": 700,
"disbursed_amount": 500,
"monthly_cet": 0.015,
"annual_cet": 31.81,
"installment_face_value": 82.57,
"installments" : [
{
"due_date":"2025-04-07",
"control_number": "CTRL-2025-1001",
"status": "paid"
},
{
"due_date":"2025-05-07",
"control_number": "CTRL-2025-1002",
"status": "paid"
},
{
"due_date":"2025-06-07",
"control_number": "CTRL-2025-1003",
"status": "opened"
},
{
"due_date":"2025-08-07",
"due_balance": 11.20,
"control_number": "CTRL-2025-1004",
"status": "paid_partial"
},
{
"due_date":"2025-09-07",
"control_number": "CTRL-2025-1005",
"status": "opened"
},
{
"due_date":"2025-10-07",
"control_number": "CTRL-2025-1006",
"status": "opened"
},
{
"due_date":"2025-11-07",
"due_balance": 70.09,
"control_number": "CTRL-2025-1007",
"status": "paid_partial"
}
]
},
}
注意！
所有分期都必须报告，即使已经支付。分期状态必须按照以下描述填写。
状态描述
| 状态 | 描述 |
|---|---|
opened | 待还分期 |
paid_partial | 部分支付的分期 |
paid | 已全额支付的分期 |
overdue | 到期未付的分期 |
Response
STATUS
201 CreatedResponse Body
{
"issue_date": "2024-11-07",
"issuer_name": "Nome Devedor",
"disbursement_start_date": "2024-11-07",
"credit_operation_status_enumerator": "opened",
"original_total_iof": null,
"origin_key": "<UUID>",
"contract_number": "LEG0123456789",
"first_due_date": "2025-04-07",
"disbursement_end_date": "2024-11-07",
"requester_identifier_key": "<KEY>",
"credit_operation_key": "<UUID>",
"operation_type_enumerator": "external_operation",
"issue_amount": 700,
"requester_key": "<UUID>",
"disbursement_date": "2024-11-07",
"total_iof": 50,
"external_contract_fees": [
{
"tax_amount": 50,
"cofins_amount": 0,
"fee_type": {
"enumerator": "tac"
},
"fee_amount": 150,
"csll_amount": 0,
"amount_released": 135,
"irrf_amount": 0,
"billing_type": {
"enumerator": "rebate"
},
"amount": 150,
"amount_type": {
"enumerator": "absolute"
},
"pis_amount": 0,
"rebate_account": null,
"description": null,
"created_at": "2024-11-07T01:51:41",
"net_fee_amount": 135
}
],
"installments": [
{
"principal_amortization_amount": 23.2268766,
"qr_code_url": null,
"installment_type": "principal",
"due_interest": 0,
"paid_amount": 82.57,
"original_total_amount": 82.57,
"tax_amount": 0.12951306,
"due_principal": 10,
"bank_slip_key": null,
"total_accrual_amount": null,
"total_amount": 82.57,
"calendar_days": 145,
"installment_key": "f9d8ecae-a314-460a-987c-3a48afc283ef",
"has_interest": true,
"due_date": "2025-04-07",
"original_principal_amortization_amount": 23.2268766,
"pre_fixed_amount": 82.57,
"digitable_line": null,
"accrual_reference_date": null,
"qr_code_key": null,
"advanced_paid_amount": 0,
"post_fixed_amount": 0,
"original_pre_fixed_amount": 82.57,
"original_due_principal": 635,
"business_due_date": "2025-04-22",
"workdays": 145,
"installment_status": "paid",
"total_paid_amount": 82.57,
"renegotiation_proposal_key": null,
"fine_amount": null
},
{
"principal_amortization_amount": 23.2268766,
"qr_code_url": null,
"installment_type": "principal",
"due_interest": 0,
"paid_amount": 82.57,
"original_total_amount": 82.57,
"tax_amount": 0.12951306,
"due_principal": 10,
"bank_slip_key": null,
"total_accrual_amount": null,
"total_amount": 82.57,
"calendar_days": 145,
"installment_key": "f9d8ecae-a314-460a-987c-3a48afc283ef",
"has_interest": true,
"due_date": "2025-05-07",
"original_principal_amortization_amount": 23.2268766,
"pre_fixed_amount": 82.57,
"digitable_line": null,
"accrual_reference_date": null,
"qr_code_key": null,
"advanced_paid_amount": 0,
"post_fixed_amount": 0,
"original_pre_fixed_amount": 82.57,
"original_due_principal": 635,
"business_due_date": "2025-04-22",
"workdays": 145,
"installment_status": "paid",
"total_paid_amount": 82.57,
"renegotiation_proposal_key": null,
"fine_amount": null
},
...
]
}