Manual Consignado Privado - Crédito Novo
Atenção!
Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
Reenvio de Webhooks
Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.
1 - Consulta dos vínculos empregatícios do trabalhador:
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.
POST
/private_payroll/employment_relationships_inquiryRequest
Caso 1: O trabalhador é o assinante do Termo de Autorização.
Request Body
{
"document_number": "<CPF FUNCIONÁRIO>",
"authorization_term": {
"signature": {
"signer": {
"name": "<NOME DO ASSINANTE>",
"email": "<EMAIL DO ASSINANTE>",
"phone": {
"number": "<NUMERO DO ASSINANTE>",
"area_code": "<DDD DO ASSINANTE>",
"country_code": "55"
},
"document_number": "<CPF DO ASSINANTE>"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "<DATA E HORA DA ASSINATURA>",
"ip_address": "<IP DO ASSINANTE>",
"fingerprint": {},
"session_id": "<ID DA SESSÃO DO ASSINANTE>"
}
}
}
}
Caso 2: O representante legal é o assinante do Termo de Autorização.
Request Body
{
"document_number": "<CPF FUNCIONÁRIO>",
"authorization_term": {
"legal_representative_document_number": "<CPF DO ASSINANTE>",
"signature": {
"signer": {
"name": "<NOME DO ASSINANTE>",
"email": "<EMAIL DO ASSINANTE>",
"phone": {
"number": "<NUMERO DO ASSINANTE>",
"area_code": "<DDD DO ASSINANTE>",
"country_code": "55"
},
"document_number": "<CPF DO ASSINANTE>"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "<DATA E HORA DA ASSINATURA>",
"ip_address": "<IP DO ASSINANTE>",
"fingerprint": {},
"session_id": "<ID DA SESSÃO DO ASSINANTE>"
}
}
}
}
Atenção
Nos casos em que houver representante legal, é necessário preencher o campo "legal_representative_document_number" com o CPF do representante legal, e os dados do objeto "signer" devem ser preenchidos com os dados do mesmo.
Response
STATUS
202 AcceptedResponse Body
{
"employment_relationships_inquiry_key": "<UUID>",
"employment_relationships_inquiry_status": "pending_inquiry"
}
info
Os possíveis valores para o enumerador employment_relationships_inquiry_status estão listados na seção Status das consultas de vínculos empregatícios.
Webhooks
WEBHOOK TYPE
laas.private_payroll.employment_relationships_inquiry_status_changeRetorno da consulta dos vínculos empregatícios:
STATUS
SuccessWebhook 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": {
"authorization_term": {
"status": "authorized",
"authorization_term_key": "<UUID>",
"signed_at": "2025-03-24T12:19:08Z",
"expiration_date": "2025-04-24"
},
"employment_relationships": [
{
"eligible": true,
"document_number": "47812365409",
"registration_number": "99999999999-A",
"employer_document_number": "20497905000126"
},
{
"eligible": false,
"document_number": "47812365409",
"registration_number": "11111111111-B",
"employer_document_number": "33296860000173"
}
]
}
}
STATUS
FailureWebhook 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",
"data": {
"enumerator": "worker_not_found",
"description": "Worker not found",
"translation": "Trabalhador inexistente"
}
}
Simulando cenários de sucesso e falha na consulta de vínculos empregatícios em Sandbox:
A simulação de cenários é baseada no CPF informado na operação.
- Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
- Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo.
| Início do CPF | Enumerador | Descrição |
|---|---|---|
| 2 | employee_not_found | employee not found |
Atenção
Para o resto dos CPFs (que não se enquadram nos cenários anteriores), o sistema retornará um webhook de erro indicando que o cenário de teste não está mapeado, conforme tabela abaixo:
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
2 - Consulta de dados do trabalhador:
A consulta de dados do trabalhador é uma operação assíncrona. Ao enviar a requisição, a QI Tech irá 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.
Existem dois cenários possíveis para realizar a consulta:
- Utilizando um Termo de Autorização previamente enviado na consulta de vínculos empregatícios
- Enviando um novo Termo de Autorização junto com a consulta
Em ambos os casos, é necessário informar o número de matrícula do trabalhador obtido na consulta de vínculos empregatícios.
POST
/private_payroll/balance_inquiryRequest
Caso 1: Consulta de dados do trabalhador com o Termo de Autorização previamente enviado.
Request Body
{
"document_number": "<CPF FUNCIONÁRIO>",
"registration_number": "<NÚMERO DE MATRÍCULA>",
"employer_document_number": "<CNPJ EMPREGADOR>"
}
Caso 2: Consulta de dados do trabalhador com envio do Termo de Autorização.
Request Body
{
"document_number": "<CPF FUNCIONÁRIO>",
"registration_number": "<NÚMERO DE MATRÍCULA>",
"employer_document_number": "<CNPJ EMPREGADOR>",
"authorization_term": {
"legal_representative_document_number": "<CPF DO REPRESENTANTE LEGAL>", // Caso aplicável
"signature": {
"signer": {
"name": "<NOME DO ASSINANTE>",
"email": "<EMAIL DO ASSINANTE>",
"phone": {
"number": "<NUMERO DO ASSINANTE>",
"area_code": "<DDD DO ASSINANTE>",
"country_code": "55"
},
"document_number": "<CPF DO ASSINANTE>"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "<DATA E HORA DA ASSINATURA>",
"ip_address": "<IP DO ASSINANTE>",
"fingerprint": {},
"session_id": "<ID DA SESSÃO DO ASSINANTE>"
}
}
}
}
Atenção
Nos casos em que houver representante legal, é necessário preencher o campo "legal_representative_document_number" com o CPF do representante legal, e os dados do objeto "signer" devem ser preenchidos com os dados do mesmo.
Response
STATUS
202 (Accepted)Response Body
{
"balance_inquiry_key": "<Balance Inquiry Key>",
"balance_inquiry_status": "pending_inquiry"
}
info
Os possíveis valores para o enumerador balance_inquiry_status estão listados na seção Status das consultas de dados do trabalhador.
Webhooks
WEBHOOK TYPE
laas.private_payroll.balance_inquiry_status_changeRetorno da consulta de dados do trabalhador:
STATUS
SuccessWebhook Body
{
"key": "<Balance Inquiry Key>",
"status": "success",
"webhook_type": "laas.private_payroll.balance_inquiry_status_change",
"event_datetime": "2024-02-21T14:30:25Z",
"data": {
"document_number": "99999999999",
"registration_number": "99999999999-A",
"employer_document_number": "99999999999962",
"name": "JOÃO SILVA",
"gender": "male",
"birth_date": "1985-07-20",
"worker_category_code": 101,
"eligible": true,
"total_due_balance": 5000.00,
"margin_base_value": 4500.00,
"available_margin_value": 500.00,
"admission_date": "2020-03-15",
"termination_date": null,
"termination_reason_code": null,
"political_exposition": "not_exposed",
"employer_name": "EMPRESA XYZ LTDA",
"mother_name": "MARIA DA SILVA",
"nationality": "Brasil",
"occupation_code": 2515,
"economic_activity": 6201,
"employer_activity_start_date": "2010-05-12",
"alerts": [
{
"alert_type": "leave",
"reference_date": "2025-02-11",
"event_id": 123456,
"leave_reason_code": 3,
"leave_start_date": "2025-02-11",
"leave_end_date": "2025-03-11"
},
{
"alert_type": "termination",
"reference_date": "2025-02-11",
"event_id": 789012,
"termination_reason_code": 1,
"termination_date": "2025-02-11",
"notice_period_start_date": "2025-01-11",
"notice_period_end_date": "2025-02-11"
}
]
}
}
STATUS
FailureWebhook Body
{
"key": "<Balance Inquiry Key>",
"status": "failure",
"webhook_type": "laas.private_payroll.balance_inquiry_status_change",
"event_datetime": "2024-02-21T14:30:25Z",
"data": {
"enumerator": "worker_not_found",
"description": "Worker not found",
"translation": "Trabalhador inexistente"
}
}
info
Os possíveis valores para o enumerador political_exposition estão listados na seção Exposição política.
Simulando cenários de sucesso e falha na consulta de margem consignável em Sandbox:
A simulação de cenários é baseada no CPF informado na operação.
- Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
- Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo.
| Início do CPF | Enumerador | Descrição |
|---|---|---|
| 2 | employee_not_found | employee not found |
Atenção
Para o resto dos CPFs (que não se enquadram nos cenários anteriores), o sistema retornará um webhook de erro indicando que o cenário de teste não está mapeado, conforme tabela abaixo:
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
3 - Simulação da dívida:
CRÉDITO NOVO
Request
POST
/debt_simulation- Valor de parcela
- Valor desembolsado
Request Body
{
"borrower": {
"person_type": "natural"
},
"financial": {
"first_due_date": "2024-12-07",
"installment_face_value": 100,
"disbursement_date": "2024-11-05",
"limit_days_to_disburse": 3,
"number_of_installments": 4,
"monthly_interest_rate": 0.018,
"interest_type": "pre_price_days",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"principal_grace_period": 0
},
"collaterals": [
{
"collateral_type": "private_payroll"
}
]
}
Request Body
{
"borrower": {
"person_type": "natural"
},
"financial": {
"first_due_date": "2024-12-07",
"disbursed_amount": 1000,
"disbursement_date": "2024-11-05",
"limit_days_to_disburse": 3,
"number_of_installments": 4,
"monthly_interest_rate": 0.018,
"interest_type": "pre_price_days",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"principal_grace_period": 0
},
"collaterals": [
{
"collateral_type": "private_payroll"
}
]
}
info
Na request acima existem 2 simulações sendo realizadas. A primeira está fixando o valor de parcela ao cliente (varia o valor desembolsado) e a segunda está fixando o valor desembolsado (varia o valor de parcela).
Response
STATUS
200 (OK)Response Body
{
"type": "debt",
"key": "<Debt Key>",
"status": "finished",
"event_datetime": "2024-11-05 16:50:00",
"data": {
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"interest_payment_month_period": 1,
"principal_grace_period": 0,
"principal_amortization_month_period": 1,
"operation_type": "structured_operation",
"post_fixed_interest_base": "workdays",
"post_fixed_interest_rate": null,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
},
"issue_date": "2024-11-05",
"number_of_installments": 4,
"requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a",
"final_disbursement_amount": 0.0,
"disbursement_options": [
{
"iof_amount": 3.93,
"total_pre_fixed_amount": 17.8715883143,
"cet": 0.0257,
"annual_cet": 0.355163,
"contract_fees": [
{
"fee_type": "tac",
"amount_type": "percentage",
"amount": 0.6,
"fee_amount": 2.29
},
{
"fee_type": "ted_fee",
"amount_type": "absolute",
"amount": 1.0,
"fee_amount": 1.0
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "insurance_premium",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "tac",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
}
],
"contract_fee_amount": 2.29,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"disbursement_date": "2024-11-05",
"first_due_date": "2024-12-21",
"installments": [
{
"calendar_days": 34,
"workdays": 23.0,
"business_due_date": "2024-12-21",
"due_date": "2024-12-21",
"due_principal": 382.13,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 7.6967422515,
"tax_amount": 0.257341482602818,
"total_amount": 100,
"principal_amortization_amount": 92.3032577485,
"installment_number": 1
},
{
"calendar_days": 29,
"workdays": 19.0,
"business_due_date": "2025-01-21",
"due_date": "2025-01-21",
"due_principal": 289.8267422515,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 4.9718040699,
"tax_amount": 0.4909156601748966,
"total_amount": 100,
"principal_amortization_amount": 95.0281959301,
"installment_number": 2
},
{
"calendar_days": 31,
"workdays": 23.0,
"business_due_date": "2025-02-21",
"due_date": "2025-02-21",
"due_principal": 194.7985463214,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5742034136,
"tax_amount": 0.7432500400879712,
"total_amount": 100,
"principal_amortization_amount": 96.4257965864,
"installment_number": 3
},
{
"calendar_days": 28,
"workdays": 18.0,
"business_due_date": "2025-03-21",
"due_date": "2025-03-21",
"due_principal": 98.372749735,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 1.6288385793,
"tax_amount": 0.9841050988526828,
"total_amount": 100,
"principal_amortization_amount": 98.3711614207,
"installment_number": 4
}
],
"issue_amount": 382.13,
"disbursed_issue_amount": 374.91,
"assignment_amount": 382.13,
"final_disbursement_amount": 374.91,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
}
},
{
"iof_amount": 4.77,
"total_pre_fixed_amount": 24.2597288075,
"cet": 0.0243,
"annual_cet": 0.334037,
"contract_fees": [
{
"fee_type": "tac",
"amount_type": "percentage",
"amount": 0.6,
"fee_amount": 2.25
},
{
"fee_type": "ted_fee",
"amount_type": "absolute",
"amount": 1.0,
"fee_amount": 1.0
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "insurance_premium",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "tac",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
}
],
"contract_fee_amount": 2.25,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"disbursement_date": "2024-11-06",
"first_due_date": "2025-01-21",
"installments": [
{
"calendar_days": 62,
"workdays": 41.0,
"business_due_date": "2025-01-21",
"due_date": "2025-01-21",
"due_principal": 375.74,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 13.9149280115,
"tax_amount": 0.437656505989534,
"total_amount": 100,
"principal_amortization_amount": 86.0850719885,
"installment_number": 1
},
{
"calendar_days": 31,
"workdays": 23.0,
"business_due_date": "2025-02-21",
"due_date": "2025-02-21",
"due_principal": 289.6549280115,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 5.3146959395,
"tax_amount": 0.722070128765373,
"total_amount": 100,
"principal_amortization_amount": 94.6853040605,
"installment_number": 2
},
{
"calendar_days": 28,
"workdays": 18.0,
"business_due_date": "2025-03-21",
"due_date": "2025-03-21",
"due_principal": 194.969623951,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 3.2283291407,
"tax_amount": 0.9601685182659746,
"total_amount": 100,
"principal_amortization_amount": 96.7716708593,
"installment_number": 3
},
{
"calendar_days": 31,
"workdays": 21.0,
"business_due_date": "2025-04-07",
"due_date": "2025-04-07",
"due_principal": 98.1979530917,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 1.8017757158,
"tax_amount": 1.2239426674782687,
"total_amount": 100,
"principal_amortization_amount": 98.1982242842,
"installment_number": 4
}
],
"issue_amount": 375.74,
"disbursed_issue_amount": 367.72,
"assignment_amount": 375.74,
"final_disbursement_amount": 367.72,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
}
},
{
"iof_amount": 4.74,
"total_pre_fixed_amount": 24.0392857898,
"cet": 0.0243,
"annual_cet": 0.334673,
"contract_fees": [
{
"fee_type": "tac",
"amount_type": "percentage",
"amount": 0.6,
"fee_amount": 2.26
},
{
"fee_type": "ted_fee",
"amount_type": "absolute",
"amount": 1.0,
"fee_amount": 1.0
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "insurance_premium",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "tac",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
}
],
"contract_fee_amount": 2.26,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"disbursement_date": "2024-11-07",
"first_due_date": "2025-01-21",
"installments": [
{
"calendar_days": 61,
"workdays": 40.0,
"business_due_date": "2025-01-21",
"due_date": "2025-01-21",
"due_principal": 375.96,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 13.6944849939,
"tax_amount": 0.4317001860605122,
"total_amount": 100,
"principal_amortization_amount": 86.3055150061,
"installment_number": 1
},
{
"calendar_days": 31,
"workdays": 23.0,
"business_due_date": "2025-02-21",
"due_date": "2025-02-21",
"due_principal": 289.6544849939,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 5.3146959395,
"tax_amount": 0.714305933832412,
"total_amount": 100,
"principal_amortization_amount": 94.6853040605,
"installment_number": 2
},
{
"calendar_days": 28,
"workdays": 18.0,
"business_due_date": "2025-03-21",
"due_date": "2025-03-21",
"due_principal": 194.9691809334,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 3.2283291407,
"tax_amount": 0.952233241255512,
"total_amount": 100,
"principal_amortization_amount": 96.7716708593,
"installment_number": 3
},
{
"calendar_days": 31,
"workdays": 21.0,
"business_due_date": "2025-04-07",
"due_date": "2025-04-07",
"due_principal": 98.1975100741,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 1.8017757157,
"tax_amount": 1.2158904130882027,
"total_amount": 100,
"principal_amortization_amount": 98.1982242843,
"installment_number": 4
}
],
"issue_amount": 375.96,
"disbursed_issue_amount": 367.96,
"assignment_amount": 375.96,
"final_disbursement_amount": 367.96,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
}
},
{
"iof_amount": 4.71,
"total_pre_fixed_amount": 23.8187134405,
"cet": 0.0244,
"annual_cet": 0.335196,
"contract_fees": [
{
"fee_type": "tac",
"amount_type": "percentage",
"amount": 0.6,
"fee_amount": 2.26
},
{
"fee_type": "ted_fee",
"amount_type": "absolute",
"amount": 1.0,
"fee_amount": 1.0
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "insurance_premium",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
},
{
"fee_type": "tac",
"amount_type": "absolute",
"amount": 0.0,
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0,
"csll_amount": 0,
"irrf_amount": 0,
"pis_amount": 0,
"cofins_amount": 0,
"amount_released": 0,
"description": null
}
],
"contract_fee_amount": 2.26,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"disbursement_date": "2024-11-08",
"first_due_date": "2025-01-21",
"installments": [
{
"calendar_days": 60,
"workdays": 39.0,
"business_due_date": "2025-01-21",
"due_date": "2025-01-21",
"due_principal": 376.18,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 13.4739126445,
"tax_amount": 0.42570834978906,
"total_amount": 100,
"principal_amortization_amount": 86.5260873555,
"installment_number": 1
},
{
"calendar_days": 31,
"workdays": 23.0,
"business_due_date": "2025-02-21",
"due_date": "2025-02-21",
"due_principal": 289.6539126445,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 5.3146959395,
"tax_amount": 0.706541738899451,
"total_amount": 100,
"principal_amortization_amount": 94.6853040605,
"installment_number": 2
},
{
"calendar_days": 28,
"workdays": 18.0,
"business_due_date": "2025-03-21",
"due_date": "2025-03-21",
"due_principal": 194.968608584,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 3.2283291407,
"tax_amount": 0.9442979642450494,
"total_amount": 100,
"principal_amortization_amount": 96.7716708593,
"installment_number": 3
},
{
"calendar_days": 31,
"workdays": 21.0,
"business_due_date": "2025-04-21",
"due_date": "2025-04-21",
"due_principal": 98.1969377247,
"has_interest": true,
"post_fixed_amount": null,
"pre_fixed_amount": 1.8017757158,
"tax_amount": 1.20783815869566,
"total_amount": 100,
"principal_amortization_amount": 98.1982242842,
"installment_number": 4
}
],
"issue_amount": 376.18,
"disbursed_issue_amount": 368.21,
"assignment_amount": 376.18,
"final_disbursement_amount": 368.21,
"prefixed_interest_rate": {
"interest_base": "calendar_days_365",
"annual_rate": 0.23872053,
"monthly_rate": 0.018,
"daily_rate": 0.00058669
}
}
]
}
}
4 - Emissão da operação:
O campo "registration_number", localizado dentro do objeto "collateral_data", refere-se ao número de matrícula de um vínculo empregatício. O mesmo é retornado na consulta de vínculos empregatícios.
CRÉDITO NOVO
Request
POST
/debt- Sem representante legal
- Com representante legal
Request Body
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"political_exposition": "not_exposed",
"address": {
"city": "Natal",
"state": "RN",
"number": "1984",
"street": "Rua",
"complement": "complemento",
"postal_code": "59065720",
"neighborhood": "bairro"
},
"role_type": "issuer",
"birth_date": "1959-07-08",
"mother_name": "NOME DA MAE",
"nationality": "Brasileiro",
"person_type": "natural",
"marital_status": "single",
"attached_documents_list": [],
"individual_document_number": "14471835092",
"document_identification_date": "2015-10-02",
"document_identification_type": "rg",
"document_identification_number": "003709888"
},
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2023-09-21",
"disbursement_date": "2024-11-07",
"fine_configuration": {
"monthly_rate": 0.0166,
"interest_base": "calendar_days",
"contract_fine_rate": 0
},
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"monthly_interest_rate": 0.0166,
"installment_face_value": 101.84,
"limit_days_to_disburse": 7,
"number_of_installments": 10,
"principal_grace_period": 0,
"rebates": [ // Opcional
{
"amount": 20,
"rebate_bank_account": {
"name": "Teste Ltda",
"document_number": "18533555000164",
"account_digit": "0",
"account_number": "4290001",
"branch_number": "0001",
"bank_code": "329"
},
"amount_type": "percentage",
"fee_type": "spread"
}
]
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_type": "private_payroll",
"collateral_data": {
"employer_document_number": "07940839000159",
"registration_number": "99999999999-A"
}
}
],
"additional_data": {
"contract": {
"contract_number": "TST0000644799"
}
},
"purchaser_document_number": "32402502000135",
"disbursement_bank_accounts": [
{
"name": "NOME DEVEDOR",
"bank_code": "001",
"account_digit": "0",
"branch_number": "2874",
"account_number": "000057555",
"document_number": "14471835092",
"transfer_method": "pix",
"percentage_receivable": 100
}
]
}
Request Body
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"political_exposition": "not_exposed",
"address": {
"city": "Natal",
"state": "RN",
"number": "1984",
"street": "Rua",
"complement": "complemento",
"postal_code": "59065720",
"neighborhood": "bairro"
},
"role_type": "issuer",
"birth_date": "1959-07-08",
"mother_name": "NOME DA MAE",
"nationality": "Brasileiro",
"person_type": "natural",
"marital_status": "single",
"attached_documents_list": [],
"individual_document_number": "14471835092",
"document_identification_date": "2015-10-02",
"document_identification_type": "rg",
"document_identification_number": "003709888"
},
"related_parties": [
{
"role_type": "issuer_legal_representative",
"person_type": "natural",
"name": "REPRESENTANTE EXEMPLO",
"email": "representante.exemplo@exemplo.com",
"individual_document_number": "79795844067",
"birth_date": "1970-04-20",
"mother_name": "MÃE DO REPRESENTANTE",
"phone": {
"country_code": "55",
"area_code": "11",
"number": "999999999"
},
"address": {
"street": "RUA EXEMPLO",
"number": "123",
"complement": "APTO 123",
"neighborhood": "BAIRRO EXEMPLO",
"postal_code": "12345678",
"city": "SÃO PAULO",
"state": "SP"
}
}
],
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-09-21",
"disbursement_date": "2024-11-07",
"fine_configuration": {
"monthly_rate": 0.01,
"interest_base": "calendar_days",
"contract_fine_rate": 0
},
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"monthly_interest_rate": 0.0166,
"installment_face_value": 1000,
"limit_days_to_disburse": 7,
"number_of_installments": 84,
"principal_grace_period": 0,
"rebates": [ // Opcional
{
"amount": 20,
"rebate_bank_account": {
"name": "Teste Ltda",
"document_number": "18533555000164",
"account_digit": "0",
"account_number": "4290001",
"branch_number": "0001",
"bank_code": "329"
},
"amount_type": "percentage",
"fee_type": "spread"
}
]
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_type": "private_payroll",
"collateral_data": {
"employer_document_number": "07940839000159",
"registration_number": "99999999999-A"
}
}
],
"additional_data": {
"contract": {
"contract_number": "TST0000644715"
}
},
"purchaser_document_number": "32402502000135",
"disbursement_bank_accounts": [
{
"name": "NOME DEVEDOR",
"bank_code": "001",
"account_digit": "0",
"branch_number": "2874",
"account_number": "000057555",
"document_number": "14471835092",
"transfer_method": "pix",
"percentage_receivable": 100
}
]
}
Response
STATUS
201 (Created)Response Body
Response Body
{
"webhook_type": "debt",
"key": "<Debt Key>",
"status": "waiting_signature",
"event_datetime": "2024-11-07 23:19:22",
"data": {
"borrower": {
"name": "Nome devedor",
"document_number": "14471835092",
"related_party_key": "28b7fc16-6d1f-467d-9667-62a8c13daea6"
},
"contract": {
"number": "TST0000644710",
"urls": [
"https://storage.googleapis.com/sandbox-doc-api/documents/a2e9c83a-3666-4def-8b27-e96fabb8705c/NOME_DEVEDOR-CCB-TST0000644710-20241107231916.pdf"
],
"signature_information": [
{
"signer_name": "Nome devedor",
"signer_document_number": "14471835092",
"signer_role": "issuer",
"signer_email": null,
"signer_external_key": null,
"signature_url": null
}
]
},
"requester_identifier_key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00",
"iof_charge_method": "financed",
"collaterals": [
{
"absolute_amount": null,
"collateral_constituted": false,
"collateral_data": {
"registration_number": "99999999999-A",
"employer_document_number": "07940839000159"
},
"collateral_key": "26c7f4f4-51f3-41fa-b880-9691211136aa",
"collateral_type": "private_payroll",
"created_at": "2024-11-07T23:19:16.413448",
"external_key": null,
"percentage": 1,
"updated_at": "2024-11-07T23:19:16.413441"
}
],
"disbursement_options": [
{
"disbursement_date": "2024-11-07",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.55
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.05,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 914.3,
"issue_amount": 909.75,
"cet": "2,0100%",
"annual_cet": "27,0481%",
"base_iof": 16.259002146803677,
"additional_iof": 3.45705,
"total_iof": 19.72,
"total_pre_fixed_amount": 108.6508885851,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 74,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 909.75,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 37.1789024864,
"principal_amortization_amount": 64.6610975136,
"tax_amount": 0.3923635397125248,
"total_amount": 101.84,
"workdays": 49.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0889024864,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.753721435360089,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5486660915,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9845001990781314,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2772376046,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.222548377175604,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4632222376,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4797864582180404,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.4416948163,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.72770892770474,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7989345071,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.999011328473856,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5716418016,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.274874127227187,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.570357168,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.570318634292211,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3090744135,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141716,
"principal_amortization_amount": 100.3081858284,
"tax_amount": 2.8541691195612935,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-08",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.55
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.05,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 914.79,
"issue_amount": 910.24,
"cet": "2,0200%",
"annual_cet": "27,0539%",
"base_iof": 16.187351160427028,
"additional_iof": 3.458912,
"total_iof": 19.65,
"total_pre_fixed_amount": 108.1583324947,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 73,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 910.24,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 36.6863463961,
"principal_amortization_amount": 65.1536536039,
"tax_amount": 0.3900097704729454,
"total_amount": 101.84,
"workdays": 48.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0863463961,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.7465431359757072,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5461100012,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9770979419422056,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2746815143,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.21518362791551,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4606661473,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4721586929694939,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.439138726,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.7200302213593857,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7963784168,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.991202690472005,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5690857113,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.266920021887232,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.5678010777,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.562261209106342,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3065183232,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141715,
"principal_amortization_amount": 100.3081858285,
"tax_amount": 2.845943848326202,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-09",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.55
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.05,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 915.28,
"issue_amount": 910.73,
"cet": "2,0200%",
"annual_cet": "27,0599%",
"base_iof": 16.115620969325082,
"additional_iof": 3.460774,
"total_iof": 19.58,
"total_pre_fixed_amount": 107.6655097248,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 72,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 910.73,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 36.1935236262,
"principal_amortization_amount": 65.6464763738,
"tax_amount": 0.3875767965109152,
"total_amount": 101.84,
"workdays": 48.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0835236262,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.7393648365913253,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5432872313,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9696956848062798,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2718587444,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.207818878655416,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4578433774,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4645309277209473,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.4363159561,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.7123515150140312,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7935556469,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.983394052470154,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5662629414,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.2589659165472766,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.5649783078,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.554203783920473,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3036955533,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141715,
"principal_amortization_amount": 100.3081858285,
"tax_amount": 2.837718577088265,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-10",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.56
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.06,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 915.79,
"issue_amount": 911.23,
"cet": "2,0200%",
"annual_cet": "27,0635%",
"base_iof": 16.0438115087348,
"additional_iof": 3.462674,
"total_iof": 19.51,
"total_pre_fixed_amount": 107.1724201311,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 71,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 911.23,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 35.7004340324,
"principal_amortization_amount": 66.1395659676,
"tax_amount": 0.3850645530633672,
"total_amount": 101.84,
"workdays": 48.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0904340324,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.7321865372069436,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5501976375,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.962293427670354,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2787691506,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.200454129395322,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4647537836,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4569031624724007,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.4432263623,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.7046728086686769,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.8004660531,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.975585414468303,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5731733476,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.2510118112073214,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.571888714,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.546146358734604,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3106059595,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141716,
"principal_amortization_amount": 100.3081858284,
"tax_amount": 2.829493305847507,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-11",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.56
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.06,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 916.28,
"issue_amount": 911.72,
"cet": "2,0200%",
"annual_cet": "27,0698%",
"base_iof": 15.971922713858204,
"additional_iof": 3.464536,
"total_iof": 19.44,
"total_pre_fixed_amount": 106.6790635687,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 70,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 911.72,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 35.2070774702,
"principal_amortization_amount": 66.6329225298,
"tax_amount": 0.382472975321052,
"total_amount": 101.84,
"workdays": 47.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0870774702,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.7250082378225619,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5468410753,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9548911705344282,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2754125884,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.193089380135228,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4613972214,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.449275397223854,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.4398698001,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.6969941023233224,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7971094909,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.967776776466452,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5698167854,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.243057705867366,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.5685321518,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.538088933548735,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3072493973,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141714,
"principal_amortization_amount": 100.3081858286,
"tax_amount": 2.8212680346152035,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-12",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.56
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.06,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 916.77,
"issue_amount": 912.21,
"cet": "2,0200%",
"annual_cet": "27,0762%",
"base_iof": 15.899954519820076,
"additional_iof": 3.466398,
"total_iof": 19.37,
"total_pre_fixed_amount": 106.1854398936,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 69,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 912.21,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 34.7134537949,
"principal_amortization_amount": 67.1265462051,
"tax_amount": 0.3798019984284558,
"total_amount": 101.84,
"workdays": 46.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0834537949,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.71782993843818,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5432174,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9474889133985024,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2717889131,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.185724630875134,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4577735461,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4416476319753073,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.4362461248,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.689315395977968,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7934858156,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.959968138464601,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5661931101,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.2351036005274114,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.5649084765,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.530031508362866,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.303625722,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141716,
"principal_amortization_amount": 100.3081858284,
"tax_amount": 2.8130427633716497,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-13",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.56
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.06,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 917.27,
"issue_amount": 912.71,
"cet": "2,0200%",
"annual_cet": "27,0802%",
"base_iof": 15.827906861727051,
"additional_iof": 3.468298,
"total_iof": 19.3,
"total_pre_fixed_amount": 105.691548961,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 68,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 912.71,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 34.2195628621,
"principal_amortization_amount": 67.6204371379,
"tax_amount": 0.3770515574809304,
"total_amount": 101.84,
"workdays": 45.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0895628621,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.7106516390537982,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5493264672,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9400866562625766,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2778979803,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.17835988161504,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4638826133,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4340198667267607,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.442355192,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.6816366896326136,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7995948828,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.95215950046275,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5723021773,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.227149495187456,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.5710175437,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.521974083176997,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3097347892,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141718,
"principal_amortization_amount": 100.3081858282,
"tax_amount": 2.8048174921281284,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
},
{
"disbursement_date": "2024-11-14",
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 4.57
},
{
"fee_type": "ted_fee",
"fee_amount": 1.5
}
],
"external_contract_fees": [
{
"fee_type": "spread",
"fee_amount": 0.0,
"tax_amount": 0.0,
"net_fee_amount": 0.0
}
],
"contract_fee_amount": 6.07,
"external_contract_fee_amount": 0.0,
"net_external_contract_fee_amount": 0.0,
"assignment_amount": 917.77,
"issue_amount": 913.2,
"cet": "2,0200%",
"annual_cet": "27,0870%",
"base_iof": 15.755779674642707,
"additional_iof": 3.47016,
"total_iof": 19.23,
"total_pre_fixed_amount": 105.1973906257,
"installments": [
{
"additional_costs": [],
"business_due_date": "2025-01-21",
"calendar_days": 67,
"due_date": "2025-01-21",
"due_interest": 0.0,
"due_principal": 913.2,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 33.7254045271,
"principal_amortization_amount": 68.1145954729,
"tax_amount": 0.3742215875281126,
"total_amount": 101.84,
"workdays": 44.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-02-21",
"calendar_days": 31,
"due_date": "2025-02-21",
"due_interest": 0.0,
"due_principal": 845.0854045271,
"fine_amount": null,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 14.2997636051,
"principal_amortization_amount": 87.5402363949,
"tax_amount": 0.7034733396694164,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-03-21",
"calendar_days": 28,
"due_date": "2025-03-21",
"due_interest": 0.0,
"due_principal": 757.5451681322,
"fine_amount": null,
"has_interest": true,
"installment_number": 3,
"post_fixed_amount": null,
"pre_fixed_amount": 11.5685715131,
"principal_amortization_amount": 90.2714284869,
"tax_amount": 0.9326843991266508,
"total_amount": 101.84,
"workdays": 18.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-04-21",
"calendar_days": 33,
"due_date": "2025-04-21",
"due_interest": 0.0,
"due_principal": 667.2737396453,
"fine_amount": null,
"has_interest": true,
"installment_number": 4,
"post_fixed_amount": null,
"pre_fixed_amount": 12.025984633,
"principal_amortization_amount": 89.814015367,
"tax_amount": 1.170995132354946,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-05-21",
"calendar_days": 28,
"due_date": "2025-05-21",
"due_interest": 0.0,
"due_principal": 577.4597242783,
"fine_amount": null,
"has_interest": true,
"installment_number": 5,
"post_fixed_amount": null,
"pre_fixed_amount": 8.8184725787,
"principal_amortization_amount": 93.0215274213,
"tax_amount": 1.4263921014782142,
"total_amount": 101.84,
"workdays": 19.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-06-21",
"calendar_days": 31,
"due_date": "2025-06-21",
"due_interest": 0.0,
"due_principal": 484.438196857,
"fine_amount": null,
"has_interest": true,
"installment_number": 6,
"post_fixed_amount": null,
"pre_fixed_amount": 8.1972396908,
"principal_amortization_amount": 93.6427603092,
"tax_amount": 1.6739579832872593,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-07-21",
"calendar_days": 31,
"due_date": "2025-07-21",
"due_interest": 0.0,
"due_principal": 390.7954365478,
"fine_amount": null,
"has_interest": true,
"installment_number": 7,
"post_fixed_amount": null,
"pre_fixed_amount": 6.6127072945,
"principal_amortization_amount": 95.2272927055,
"tax_amount": 1.944350862460899,
"total_amount": 101.84,
"workdays": 21.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-08-21",
"calendar_days": 30,
"due_date": "2025-08-21",
"due_interest": 0.0,
"due_principal": 295.5681438423,
"fine_amount": null,
"has_interest": true,
"installment_number": 8,
"post_fixed_amount": null,
"pre_fixed_amount": 4.8387153664,
"principal_amortization_amount": 97.0012846336,
"tax_amount": 2.219195389847501,
"total_amount": 101.84,
"workdays": 22.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-09-21",
"calendar_days": 33,
"due_date": "2025-09-21",
"due_interest": 0.0,
"due_principal": 198.5668592087,
"fine_amount": null,
"has_interest": true,
"installment_number": 9,
"post_fixed_amount": null,
"pre_fixed_amount": 3.5787172455,
"principal_amortization_amount": 98.2612827545,
"tax_amount": 2.513916657991128,
"total_amount": 101.84,
"workdays": 23.0,
"installment_status": null,
"installment_type": null
},
{
"additional_costs": [],
"business_due_date": "2025-10-21",
"calendar_days": 28,
"due_date": "2025-10-21",
"due_interest": 0.0,
"due_principal": 100.3055764542,
"fine_amount": null,
"has_interest": true,
"installment_number": 10,
"post_fixed_amount": null,
"pre_fixed_amount": 1.5318141715,
"principal_amortization_amount": 100.3081858285,
"tax_amount": 2.79659222089858,
"total_amount": 101.84,
"workdays": 20.0,
"installment_status": null,
"installment_type": null
}
],
"first_due_date": "2025-01-21",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
}
]
}
}
Objeto Installments
| Campo | Descrição |
|---|---|
| additional_costs | Custos adicionais |
| business_due_date | Data de vencimento em dia útil |
| calendar_days | Dias corridos |
| due_date | Data de vencimento |
| due_interest | Juros do vencimento |
| due_principal | Principal do vencimento |
| fine_amount | Multa do vencimento |
| has_interest | Indica se o vencimento possui juros |
| installment_number | Número da parcela |
| installment_status | Status da parcela |
| installment_type | Tipo de parcela |
| post_fixed_amount | Valor da parcela após juros |
| pre_fixed_amount | Valor da parcela antes de juros |
| principal_amortization_amount | Valor da amortização do principal da parcela |
| tax_amount | Valor dos juros da parcela |
| total_amount | Valor total da parcela |
| workdays | Dias úteis |
Objeto Prefixed Interest Rate
| Campo | Descrição |
|---|---|
| monthly_rate | Taxa mensal |
| daily_rate | Taxa diária |
| annual_rate | Taxa anual |
| interest_base | Base de cálculo da taxa de juros |
Webhooks
Caso a operação não seja assinada ou averbada até a última opção de data de desembolso o parceiro receberá um webhook informando a respeito do cancelamento da operação:
WEBHOOK TYPE
debtSTATUS
CanceledWebhook Body
Webhook Body
{
"key": "<Debt Key>",
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2025-03-18 13:46:31",
"data": {
"cancel_reason": "<CANCEL_REASON>",
"cancel_reason_enumerator": "<CANCEL_REASON_ENUMERATOR>"
}
}
Objeto Data
| Campo | Descrição |
|---|---|
| cancel_reason | Motivo do cancelamento |
| cancel_reason_enumerator | Enumerador do motivo do cancelamento |
Simulando cenários de sucesso e falha na averbação em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
- Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
- Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo.
- Erros com Ação "cancel" receberá um webhook com o resultado final da operação.
| Início do cpf | Enumerador | Descrição | Ação |
|---|---|---|---|
| 2 | invalid_disbursement_account | Invalid disbursemente bank account | cancel |
Atenção
Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado.
| Enumerador | Descrição |
|---|---|
| mock_error | Informed document number is not a valid mock on test environment |
5 - Coleta de documentos e formalização da operação
É obrigatório o envio dos dados complementares do contrato para a formalização da operação.
Recomendamos fortemente que a coleta e assinatura dos documentos da operação sejam realizadas por meio do QI Sign, nossa plataforma proprietária de assinatura eletrônica com tecnologia de antifraude embarcada.
Por ter sido desenvolvida internamente e estar totalmente integrada aos nossos sistemas, o uso do QI Sign garante:
- Automação completa do fluxo de formalização: a operação segue automaticamente para a próxima etapa após a assinatura.
- Upload automático de documentos: todos os arquivos assinados são enviados diretamente para o sistema de crédito, sem necessidade de intervenção manual.
- Segurança e rastreabilidade: o processo é seguro, auditável e em conformidade com os requisitos regulatórios.
Essa abordagem reduz erros operacionais, acelera a liberação do crédito e melhora significativamente a experiência do cliente.
Por que usar o QI Sign?
- Assinatura remota por celular, com reconhecimento facial em conformidade com a regulação.
- Integração via API RESTful, facilitando automação de fluxos de assinatura.
- Segurança jurídica, com diferentes níveis de comprovação de identidade.
- Soluções escaláveis e sob demanda para corporações que precisam digitalizar seus processos.
QI Sign
O QI Sign é a plataforma de assinatura eletrônica da QI Tech, desenvolvida internamente para atender às exigências regulatórias do mercado de crédito.
Com suporte a biometria facial e envio automático de documentos, garante segurança, agilidade e rastreabilidade durante a formalização.
Para mais informações ou para solicitar uma proposta, entre em contato com nosso time comercial:
📧 comercial@qitech.com.br
📞 (11) 2339-4763
Formalização Externa
Caso a formalização das operações não seja realizada através do QI Sign, o procedimento de formalização deve ser consultado no manual de formalização externa.
Webhooks
Após a assinatura do contrato, o parceiro receberá um webhook informando a respeito da assinatura do contrato. Com o seguinte body:
{
"key": "<Debt Key>",
"status": "signed",
"signers": [
{
"id": "3271efd3-89ba-43aa-b032-af9a459e6096",
"images": {
"face_image_url": "https://qisign-face-images-bucket-sandbox.s3.amazonaws.com/fad7f924-d210-4ec4-9565-a57662a0a65a.jpeg",
"document_back_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/8c7b68ba-07ad-4188-82ae-679833b2843b.jpeg",
"document_front_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/f63cd291-5668-4926-be5d-9290aeda3f6e.jpeg",
"document_back_template": "cnh_back",
"document_front_template": "cnh_front"
},
"biometry": {
"face_validation": {
"score": 80,
"provider": "qitech",
"available": true
},
"fraud_base_flag": false
},
"document": {
"template": "cnh_front",
"face_match_score": 100
},
"liveness": {
"result": "live"
},
"signed_at": "2025-04-09T19:59:39Z",
"ip_address": "182.224.219.198",
"signer_data": {
"name": "Nome Trabalhador",
"email": "exemplo@qitech.com.br",
"phone": {
"number": "829549234",
"area_code": "11",
"international_dial_code": "55"
},
"address": {
"uf": "SP",
"city": "Sao Paulo",
"number": "123",
"street": "Rua tal do sal",
"complement": "Ap 23",
"postal_code": "00000-000",
"neighborhood": "Pinheiros"
},
"pix_key": "pix03@pix03.com",
"birthdate": "1996-03-13",
"document_number": "504.856.400-66",
"document_submission_method": "email",
"authentication_submission_method": "sms"
}
}
],
"webhook_type": "laas.credit_operation.status_change",
"event_datetime": "2025-04-09 20:00:19",
"signed_contract_url": "https://storage.googleapis.com/sandbox-doc-api/documents/9b55450e-fca5-44f2-9118-5851ed4bd92e/RESTAURANTEBEBBER-TRABALHADOR_SICQ-CCB-0000195364-2230409195718_signed.pdf"
}
Objeto Signers
| Campo | Descrição |
|---|---|
| id | ID do signatário |
| images | Imagens do signatário |
Objeto Images
| Campo | Descrição |
|---|---|
| face_image_url | URL da imagem da face do signatário |
| document_back_url | URL da imagem do verso do documento do signatário |
| document_front_url | URL da imagem do documento do signatário |
| document_back_template | Template do verso do documento do signatário |
| document_front_template | Template do documento do signatário |
Objeto Biometry
| Campo | Descrição |
|---|---|
| face_validation | Validação da rosto do signatário (true ou false) |
| face_validation.score | Pontuação da rosto do signatário (0 a 100) |
| face_validation.available | Disponibilidade da validação da rosto do signatário (true ou false) |
| face_validation.provider | Provedor da validação da rosto do signatário (qitech ou external) |
| fraud_base_flag | Flag de fraude base (true ou false) |
Objeto Document
| Campo | Descrição |
|---|---|
| template | Template do documento (cnh_front, cnh_back, rg_front, rg_back) |
| face_match_score | Pontuação da rosto do signatário (0 a 100) |
Objeto Liveness
| Campo | Descrição |
|---|---|
| result | Resultado da liveness (live ou spoof) |
Objeto Signer Data
| Campo | Descrição |
|---|---|
| name | Nome do signatário |
| Email do signatário | |
| phone | Telefone do signatário |
Objeto Address
| Campo | Descrição |
|---|---|
| uf | Unidade Federativa |
| city | Cidade |
| number | Número |
| street | Rua |
| complement | Complemento |
| postal_code | CEP |
| neighborhood | Bairro |
6 - Autorização de averbação
Para que a averbação seja realizada com sucesso, é preciso autorizar a reserva. Isso melhora a experiência do cliente que não terá sua margem averbada sem que a operação seja autorizada a desembolsar.
Webhooks
WEBHOOK TYPE
laas.private_payroll.reservation_status_changeWebhook Body
{
"webhook_type": "laas.private_payroll.reservation_status_change",
"data": {
"reservation_status": "pending_requester_authorization"
},
"key": "<Debt Key>",
"event_datetime": "2025-04-09T20:00:20Z",
"status": "pending_requester_authorization"
}
Em caso de sucesso na autorização da reserva, ela passará automaticamente para a etapa de averbação.
PATCH
/private_payroll/reservation/external_key/EXTERNAL-KEY/authorizeResponse
STATUS
200 (OK)Response Body
{
"reservation_key": "<Debt Key>",
"document_number": "12345678901",
"registration_number": "99999999999-A",
"employer_document_number": "12345678901234",
"external_key": "abc123def456",
"contract_number": "2024001234",
"inclusion_date": "2024-03-18",
"disbursement_date": "2024-03-20",
"contract_data": {
"amount": 5000.00,
"installments": 12,
"interest_rate": 0.018
},
"reservation_data": {
"installment_value": 500.00,
"margin_value": 450.00
},
"reservation_status": "authorized"
}
Cancelamento da operação
Para não prosseguir com a averbação, é necessário cancelar a operação.
Se a operação foi originada diretamente pelo parceiro, isto pode ser feito através do endpoint de cancelamento permanente, da mesma forma que é feito no item 8 - Desaverbação.
Se a operação foi originada via leilão, o cancelamento deverá ser feito através do endpoint de cancelamento da proposta, conforme documentação do Leilão.
Importante
O campo external_key é o UUID da reserva que foi criada no item 4 - Criação da reserva.
O mesmo que debt_key e credit_operation_key.
7 - Consulta ao SCR
Em até 120 dias após o lançamento do Consignado do Trabalhador, é obrigatório realizar uma consulta ao SCR. Nela, recebemos informações sobre o histórico de créditos do trabalhador, nos atentando especialmente para a quantidade de contratos ativos de Crédito Pessoal e/ou Crédito Consignado.
A consulta ao SCR é feita automaticamente pelo sistema após a autorização da averbação.
Webhooks
WEBHOOK TYPE
laas.private_payroll.credit_analysisSTATUS
ApprovedWebhook Body
{
"key": "<Debt Key>",
"status": "approved",
"webhook_type": "laas.private_payroll.credit_analysis",
"event_datetime": "2025-04-04 17:47:32",
"data": {
"scr_data": [
{
"reference_date": "2025-02",
"operation_items": [
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "12",
"submodality_description": "Microcrédito",
"domain": "310",
"domain_group": "Créditos baixados como prejuízo",
"domain_description": "Créditos baixados como prejuízo até 12 meses",
"value": 96277,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "18",
"submodality_description": "Cartão de crédito - não migrado",
"domain": "310",
"domain_group": "Créditos baixados como prejuízo",
"domain_description": "Créditos baixados como prejuízo até 12 meses",
"value": 310812,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "310",
"domain_group": "Créditos baixados como prejuízo",
"domain_description": "Créditos baixados como prejuízo até 12 meses",
"value": 102523,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "140",
"domain_group": "Créditos a vencer",
"domain_description": "Créditos a vencer de 91 a 180 dias",
"value": 34623,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "165",
"domain_group": "Créditos a vencer",
"domain_description": "Créditos a vencer de 721 a 1080 dias",
"value": 8913,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "170",
"domain_group": "Créditos a vencer",
"domain_description": "Créditos a vencer de 1081 a 1440 dias",
"value": 4110,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "180",
"domain_group": "Créditos a vencer",
"domain_description": "Créditos a vencer de 1801 a 5400 dias",
"value": 1095,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "160",
"domain_group": "Créditos a vencer",
"domain_description": "Créditos a vencer de 361 a 720 dias",
"value": 18059,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "03",
"submodality_description": "Crédito pessoal - sem consignação em folha de pagamento",
"domain": "175",
"domain_group": "Créditos a vencer",
"domain_description": "Créditos a vencer de 1441 a 1800 dias",
"value": 1753,
"linked_to_foreign_currency": false
},
{
"modality": "02",
"modality_description": "Empréstimos",
"submodality": "18",
"submodality_description": "Cartão de crédito - não migrado",
"domain": "270",
"domain_group": "Créditos vencidos",
"domain_description": "Créditos vencidos de 301 a 360 dias",
"value": 42950,
"linked_to_foreign_currency": false
}
],
"indirect_risk": 0,
"assumed_coobligation": 0.0,
"receive_coobligation": 0.0,
"financial_institution_count": 4,
"percentage_of_processed_documents": 61.13,
"percentage_of_processed_volume": 95.45,
"start_relationship_date": "2023-04-12",
"operation_count": 10,
"subjudice_operations_count": 0,
"subjudice_operations_value": 0,
"disagreement_operations_count": 0,
"disagreement_operations_value": 0,
"source": "CACHE"
}
]
}
}
WEBHOOK TYPE
laas.private_payroll.credit_analysisSTATUS
ReprovedWebhook Body
{
"key": "<Debt Key>",
"data": {
"cancel_reason": "Análise de crédito reprovada",
"cancel_reason_enumerator": "private_payroll.credit_analysis_reproved"
},
"status": "canceled",
"webhook_type": "laas.credit_operation.status_change",
"event_datetime": "2025-04-09 21:22:56"
}
Simulando cenários de sucesso e falha na consulta ao SCR em Sandbox:
A simulação de cenários é baseada no primeiro dígito do CPF informado na operação.
- Para os demais CPFs, será retornado uma resposta assíncrona de sucesso.
| Início do cpf | Enumerador | Descrição | Ação |
|---|---|---|---|
| 5 | private_payroll.credit_analysis_reproved | Credit analysis reproved | cancel |
8 - Averbação
Atenção
Para que o pedido de averbação seja criado com sucesso, é preciso que seja feita uma consulta de dados válida para a margem consignável previamente. Para isso basta seguir os passos do item 2 - Consulta de dados da margem consignável.
Webhooks
Em caso de sucesso na averbação o parceiro receberá o seguinte webhook:
WEBHOOK TYPE
laas.credit_operation.status_changeSTATUS
OpenedWebhook Body
{
"key": "<Debt Key>",
"status": "opened",
"webhook_type": "laas.credit_operation.status_change",
"event_datetime": "2025-03-18 16:41:28"
}
Falha na averbação por margem exedida
Se uma reserva com categoria de nova matrícula receber margem excedida na tentativa de averbação, o status do pedido de averbação ficará como "aguardando ação do parceiro", e será enviado um webhook no seguinte formato para informar o ocorrido:
WEBHOOK TYPE
private_payroll_margin_exceeded_for_new_registrationSTATUS
Pending requester actionWebhook Body
Webhook Body
{
"key": "<Debt Key>",
"status": "pending_requester_action",
"webhook_type": "private_payroll_margin_exceeded_for_new_registration",
"event_datetime": "2025-03-18 16:41:28",
"data": {
"enumerator": "margin_exceeded_for_new_registration",
"description": "The margin for this reservation has been exceeded. Reservation Amount: 551.18",
}
}
Falha na averbação por falta de uma consulta válida dos dados do trabalhador
Se uma consulta dos dados do trabalhador não for realizada com sucesso antes do pedido de averbação, o status do pedido de averbação ficará como "aguardando ação do parceiro" e será enviado um webhook no seguinte formato para informar o ocorrido:
WEBHOOK TYPE
private_payroll_success_balance_request_not_foundSTATUS
Pending requester actionWebhook Body
Webhook Body
{
"key": "<Debt Key>",
"status": "pending_requester_action",
"webhook_type": "private_payroll_success_balance_inquiry_not_found",
"event_datetime": "2025-03-18 16:41:28",
"data": {
"enumerator": "success_balance_inquiry_not_found",
"description": "Success balance inquiry not found for the specified registration number"
}
}
Para prosseguir, as seguintes ações deverão ser tomadas:
- Realizar a consulta dos dados do trabalhador em questão seguindo os passos do item 2 - Consulta de dados do trabalhador;
- Enviar uma requisição no formato abaixo para informar que a consulta foi realizada.
POST
/private_payroll/reservation/external_key/DEBT-KEY/validate_reservationImportante
Essa requisição não apenas confirma a existência de uma consulta válida dos dados do trabalhador, mas também verifica se as informaç ões enviadas para a criação da averbação estão corretas, permitindo assim a continuidade do processo.
Correção de dados no caso de falha na averbação
É possível corrigir os dados bancários, número da matrícula e o nome do empregado do contrato em tentativa de averbação. Para isso basta utilizar a seguinte chamada:
PATCH
/debt/DEBT-KEY/collateralRequest Body
- Dados Bancários
- Número da Matrícula
- Nome do Empregado
{
"disbursement_bank_account": {
"bank_code": "123",
"account_digit": "1",
"account_branch": "1234",
"account_number": "5678",
"document_number": "12345678901"
}
}
{
"registration_number": "99999999999-A"
}
{
"name": "Nome do Empregado"
}
9 - Desaverbação
A desaverbação de um contrato é realizada através da rota de cancelamento permanente. Essa rota coloca um status final no contrato, o qual não é passível de retentativa e dispara a desaverbação da margem averbada.
Para realizar o cancelamento definitivo, deve ser utilizado o seguinte endpoint:
POST
/debt/DEBT-KEY/cancel_permanentlyWebhooks
WEBHOOK TYPE
debtSTATUS
canceled_permanentlyWebhook Body
{
"key": "<Debt Key>",
"status": "canceled_permanently",
"webhook_type": "debt",
"event_datetime": "2025-03-18 16:41:28",
"data": {}
}
10 - Falha no desembolso
TED
Em caso de falha no desembolso via TED
WEBHOOK TYPE
debtSTATUS
canceledWebhook Body
{
"key": "<Debt Key>",
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2025-03-18 16:41:28",
"data": {
"ted_refusal": {
"transaction_key": "16faabfc-3876-437d-a4f6-aae17a1d68c9",
"description": "341 0000 000000-7 12345678900 - NOME DO EMPREGADO",
"origin": {
"account_key": "a1d2dea5-fa90-4676-a125-da355fdc3ed0",
"account_number": "00086",
"bank_code": "329",
"name": "ACCOUNT TRANSITORY",
"type": "payment_account",
"document": "32402502000135",
"branch_digit": null,
"account_digit": "8",
"branch": "0001"
},
"fee": 0,
"reason_enumerator": "agencia_conta_invalida",
"timestamp": "2022-11-07T14:36:05",
"amount": 483.6,
"reason": "Agência ou Conta Destinatária do Crédito Inválida",
"destination": {
"branch": "0000",
"account_number": "000000",
"name": "NOME DO EMPREGADO",
"purpose": "Crédito em Conta",
"type": "checking_account",
"branch_digit": null,
"document": "12345678900",
"bank_code": "341",
"account_digit": "7"
}
},
"cancel_reason": "ted_refusal"
}
}
PIX
Em caso de falha no desembolso via PIX
WEBHOOK TYPE
debtSTATUS
canceledWebhook Body
{
"key": "<Debt Key>",
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2025-03-18 16:41:28",
"data": {
"cancel_reason": "pix_refusal",
"pix_refusal": {
"reason_enumerator": "invalid_document_number",
"reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino."
}
}
}
11 - Reapresentação de Pagamento
Altera a data de desembolso sem afetar os valores financeiros da operação.
POST
/debt/DEBT-KEY/change_disbursement_dateRequest
Request Body
{
"disbursement_date": "2025-03-19",
"disbursement_bank_accounts": [
{
"branch_number": "1232",
"account_digit": "4",
"account_number": "412412412",
"account_type": "checking_account",
"document_number": "<CPF DO TRABALHADOR>",
"bank_code": 184,
"ispb_number": "17298092",
"name": "<NOME DO TRABALHADOR>",
"percentage_receivable": 100
}
]
}
Response
STATUS
200 OKResponse Body
{
"disbursement_date": "2025-03-19",
"disbursement_accounts": [
{
"account_branch": "1232",
"account_digit": "4",
"account_number": "412412412",
"account_type": "checking_account",
"amount_receivable": null,
"created_at": "2022-05-24T14:51:46",
"digitable_line": null,
"disbursement_type": "ted",
"document_number": "37197645832",
"financial_institutions": {
"code_number": 184,
"ispb": 17298092,
"name": "BCO ITAÚ BBA S.A."
},
"financial_institutions_code_number": 184,
"is_pix_disbursement": false,
"ispb": "17298092",
"name": "Márcio e Catarina Gráfica Ltda",
"percentage_receivable": 50.0,
"pix_key": null,
"pix_transfer_key": null,
"pix_type": null,
"qr_code_key": null,
"retry_counter": 0,
"retry_vector": null,
"transaction_key": null,
"webhook_key": null
}
]
}
Enumeradores
Exposição política
ENUMERADOR
political_exposition| Status | Descrição |
|---|---|
| not_exposed | Pessoa não exposta politicamente |
| level_1 | Pessoa exposta politicamente nível 1 |
| level_2 | Pessoa exposta politicamente nível 2 |
| not_informed | Não há informação sobre a exposição política |
Status das consultas de vínculos empregatícios e de dados do trabalhador
ENUMERADOR
employment_relationships_inquiry_statusENUMERADOR
balance_inquiry_status| Status | Descrição |
|---|---|
| pending_authorization | Os dados de autorização foram enviados e estão pendentes de processamento. |
| pending_inquiry | A consulta está autorizada e pendente de ser processada. |
| completed | A consulta foi concluída com sucesso. |
| failure | A consulta falhou. |
Status da reserva
ENUMERADOR
reservation_status| Status | Descrição |
|---|---|
| pending_auction | A reserva foi criada e está esperando o início do leilão (receber uma solicitação de proposta). |
| pending_reservation | A reserva foi criada e está pendente de averbação. |
| pending_documents_submission | A reserva já foi averbada e está pendente de envio de documentos. |
| reserved | A reserva foi averbada com sucesso. Fluxo de averbação concluído. |
| canceled | Em caso de envio de documentos inválidos, a reserva é cancelada. |
| pending_suspension | A reserva está averbada e foi solicitada a suspensão. |
| suspended | A reserva foi suspensa com sucesso. |
| settled | A reserva foi liquidada com sucesso. |
| pending_deletion | A reserva está averbada e foi solicitada a exclusão. |
| deleted | A reserva foi excluída com sucesso. |