Manual INSS - Crédito Novo ou Refinanciamento
Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
1 - Consulta da lista de benefícios com formalização do Termo de Autorização realizada através do parceiro:
Request
Caso 1: Titular do benefício é o assinante do Termo de Autorização.
Request Body
{
"document_number": "\<CPF BENEFICIÁRIO\>",
"authorization_term": {
"document_number": "\<CPF BENEFICIÁRIO\>",
"signature": {
"signer": {
"name": "\<NOME BENEFICIÁRIO OU RESPONSÁVEL LEGAL\>",
"email": "\<EMAIL ASSINANTE\>",
"phone": {
"number": "\<NUMERO ASSINANTE\>",
"area_code": "\<DDD ASSINANTE\>",
"country_code": "55"
},
"document_number": "\<CPF ASSINANTE\>"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "\<DATA E HORA DA ASSINATURA\>",
"ip_address": "\<IP DO ASSINANTE\>",
"fingerprint": {},
"third_party_additional_data": {},
"session_id": "\<ID DA SESSÃO DO ASSINANTE\>"
},
"signed_object": {
"document_key": "\<CHAVE DO DOCUMENTO NA QI\>"
}
}
}
}
Caso 2: Titular do benefício não é o assinante do Termo de Autorização (com representante legal).
Request Body
{
"document_number": "\<CPF BENEFICIÁRIO\>",
"authorization_term": {
"document_number": "\<CPF BENEFICIÁRIO\>",
"legal_representative_document_number": "\<CPF DO ASSINANTE\>",
"signature": {
"signer": {
"name": "\<NOME BENEFICIÁRIO OU RESPONSÁVEL LEGAL\>",
"email": "\<EMAIL ASSINANTE\>",
"phone": {
"number": "\<NUMERO ASSINANTE\>",
"area_code": "\<DDD ASSINANTE\>",
"country_code": "55"
},
"document_number": "\<CPF ASSINANTE\>"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "\<DATA E HORA DA ASSINATURA\>",
"ip_address": "\<IP DO ASSINANTE\>",
"fingerprint": {},
"third_party_additional_data": {},
"session_id": "\<ID DA SESSÃO DO ASSINANTE\>"
},
"signed_object": {
"document_key": "\<CHAVE DO DOCUMENTO NA QI\>"
}
}
}
}
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.
"document_key": utilizar a GUID retornada no endpoint /upload
Ao invés da chave do documento pdf assinado no objeto "authorization_term.signed_object.document_key", também é possível enviar o texto corrido do Termo de Autorização, através do objeto "authorization_term.signed_object.raw_text".
Response
Response Body
{
"benefits_request_key": "\<GUID DA CONSULTA DE BENEFÍCIO\>",
"status": "pending_search"
}
Em caso de sucesso na consulta da lista de benefícios:
Webhooks
Webhook Body
{
"webhook_type": "social_security_benefits_request",
"key": "\<GUID benefits_request_key\>",
"event_datetime": "\<DATA E HORA DO ENVIO DO WEBHOOK\>",
"status": "success",
"data": [{
"benefit_number": "\<No. DO BENEFÍCIO\>",
"benefit_status": "inelegible",
"grant_date": "2023-06-13"
}]
}
Campo | Descrição | Valores |
---|---|---|
benefit_status | Status do beneficio | Enumeradores |
Em caso de falha na consulta da lista de benefícios
Webhook Body
{
"webhook_type": "social_security_benefits_request",
"key": "\<GUID benefits_request_key\>",
"event_datetime": "\<DATA E HORA DO ENVIO DO WEBHOOK\>",
"status": "failure",
"data": {
"enumerator": "not_found_legal_representative",
"description": "no legal representative for the beneficiary"
}
}
Detalhamento de campos no webhook de falha
Campo | Descrição | Valores |
---|---|---|
enumerator | Retorno mapeado do código Dataprev | Enumeradores |
Simulando cenários de sucesso e insucesso na consulta de benefício em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
11.1. Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
11.2. 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 | inexistent_beneficiary | no beneficiary found |
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 |
2 - Consulta de dados do benefício:
Caso 1: Consulta de dados do benefício com o Termo de Autorização previamente enviado.
Caso 1
Request
Request Body
{
"document_number": "\<CPF BENEFICIÁRIO\>",
"benefit_number": "\<No. DO BENEFÍCIO\>"
}
Response
Response Body
{
"balance_request_key": "\<GUID DA CONSULTA DE DADOS DO BENEFÍCIO\>",
"status": "pending_search"
}
Caso 2: Consulta de dados do benefício com envio do Termo de Autorização.
Caso 2
Request
Request Body
{
"document_number": "\<CPF BENEFICIÁRIO\>",
"benefit_number": "\<No. DO BENEFÍCIO\>",
"authorization_term": {
"document_number": "\<CPF BENEFICIÁRIO\>",
"legal_representative_document_number": "\<CPF DO ASSINANTE\>", // CPF do representante legal (caso aplicável)
"signature": {
"signer": {
"name": "\<NOME BENEFICIÁRIO OU RESPONSÁVEL LEGAL\>",
"email": "\<EMAIL ASSINANTE\>",
"phone": {
"number": "\<NUMERO ASSINANTE\>",
"area_code": "\<DDD ASSINANTE\>",
"country_code": "55"
},
"document_number": "\<CPF ASSINANTE\>"
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "\<DATA E HORA DA ASSINATURA\>",
"ip_address": "\<IP DO ASSINANTE\>",
"fingerprint": {},
"third_party_additional_data": {},
"session_id": "\<ID DA SESSÃO DO ASSINANTE\>"
},
"signed_object": {
"document_key": "\<CHAVE DO DOCUMENTO NA QI\>"
}
}
}
}
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
Response Body
{
"balance_request_key": "\<GUID DA CONSULTA DE DADOS DO BENEFÍCIO\>",
"status": "pending_authorization"
}
Em caso de sucesso na consulta de dados do benefício
Webhooks
Webhook Body
{
"webhook_type": "social_security_balance_request",
"key": "\<GUID balance_request_key\>",
"event_datetime": "\<DATA E HORA DO ENVIO DO WEBHOOK\>",
"status": "success",
"data": {
"name": "IVOLANDO MIRANDA",
"state": "SP",
"alimony": "not_payer",
"birth_date": "07021961",
"grant_date": "2022-09-02",
"credit_type": "checking_account",
"block_type": "not_blocked",
"benefit_card": {
"limit": 2083.2,
"balance": 0
},
"benefit_number": "22255220",
"benefit_status": "elegible",
"consigned_card": {
"limit": 2083.2,
"balance": 0
},
"assistance_type": "retirement_by_age",
"document_number": "14950479032",
"benefit_end_date": "2020-12-01",
"consigned_credit": {
"balance": 1000
},
"benefit_situation": "active",
"max_total_balance": 2000,
"used_total_balance": 1000,
"politically_exposed": {
"type": "politically_exposed_level_1",
"is_politically_exposed": true
},
"has_power_of_attorney": false,
"available_total_balance": 1000,
"has_judicial_concession": false,
"number_of_portabilities": 0,
"disbursement_bank_account": {
"bank_code": "341",
"account_digit": "6",
"account_branch": "0155",
"account_number": "000059923"
},
"has_entity_representation": false,
"social_benefit_max_balance": 2000,
"social_benefit_used_balance": 1000,
"benefit_quota_expiration_date": null,
"number_of_active_reservations": 0,
"number_of_suspended_reservations": 0,
"number_of_refinanced_reservations": 0,
"number_of_active_suspended_reservations": 3
}
}
Detalhamento de campos no webhook de sucesso
Campo | Descrição | Valores |
---|---|---|
assistance_type | Tipo do benefício | Enumeradores |
benefit_status | Status do beneficio | Enumeradores |
has_entity_representation | Possui entidade de representação (não permite averbação) | True ou False |
alimony_code | Classificador da Pensão alimentícia | not_payer, payer, benefit |
has_judicial_concession | Benefício concedido por liminar | True ou False |
has_power_of_attorney | Possui procurador? | True ou False |
credit_type | Tipo de crédito - recebimento do benefício | Magnetic_card, checking_account |
benefit_situation | Situação do benefício | Enumeradores |
used_total_balance | Valor total comprometido em averbações de empréstimos, reservado para portabilidade, refinanciamento, alterações, RMC e RCC | Numérico |
max_total_balance | Valor comprometido possível para a respectiva espécie do benefício | Numérico |
available_total_balance | Valor total disponível para empréstimo, somando todas as modalidades (diferença entre max_total_balance e used_total_balance) | Numérico |
benefit_quota_expiration_date | Data de extinção do benefício. A informação está disponível apenas para alguns benefícios de pensão por morte. | String ou nulo |
block_type | Tipo de bloqueio do benefício | Enumeradores |
politically_exposed.type | Pessoa politicamente exposta | Enumeradores |
is_politically_exposed | Pessoa politicamente exposta | True ou False |
Em caso de falha na consulta da lista de benefícios
Webhook Body
{
"webhook_type": "social_security_balance_request",
"key": "\<GUID balance_request_key\>",
"event_datetime": "\<DATA E HORA DO ENVIO DO WEBHOOK\>",
"status": "failure",
"data": {
"enumerator": "not_found_legal_representative",
"description": "no legal representative for the beneficiary"
}
}
Detalhamento de campos no webhook de falha
Campo | Descrição | Valores |
---|---|---|
enumerator | Retorno mapeado do código Dataprev | Enumeradores |
Simulando cenários de sucesso e insucesso na consulta de benefício em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
11.1. Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
11.2. 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 | inexistent_beneficiary | no beneficiary found |
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 |
3 - Simulação da dívida:
Request crédito novo
- Valor de parcela
- Valor desembolsado
{
"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": "social_security"
}
]
}
{
"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": "social_security"
}
]
}
Request refinanciamento
- Valor de Parcela
- Valor desembolsado
{
"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": "social_security"
}
],
"refinanced_credit_operations": [
{
"operation_key": "324caa35-ba10-4590-ae2b-5efef71709c3"
}
]
}
{
"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": "social_security"
}
],
"refinanced_credit_operations": [
{
"operation_key": "324caa35-ba10-4590-ae2b-5efef71709c3"
}
]
}
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, esta fixando o valor desembolsado (varia o valor desembolsado).
Response
Response Body
{
"type": "debt",
"key": "8f01672d-9910-43a6-9e7d-07c031bc6fed",
"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-09",
"installments": [
{
"calendar_days": 34,
"workdays": 23.0,
"business_due_date": "2024-12-09",
"due_date": "2024-12-09",
"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-07",
"due_date": "2025-01-07",
"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-07",
"due_date": "2025-02-07",
"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-07",
"due_date": "2025-03-07",
"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-07",
"installments": [
{
"calendar_days": 62,
"workdays": 41.0,
"business_due_date": "2025-01-07",
"due_date": "2025-01-07",
"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-07",
"due_date": "2025-02-07",
"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-07",
"due_date": "2025-03-07",
"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-07",
"installments": [
{
"calendar_days": 61,
"workdays": 40.0,
"business_due_date": "2025-01-07",
"due_date": "2025-01-07",
"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-07",
"due_date": "2025-02-07",
"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-07",
"due_date": "2025-03-07",
"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-07",
"installments": [
{
"calendar_days": 60,
"workdays": 39.0,
"business_due_date": "2025-01-07",
"due_date": "2025-01-07",
"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-07",
"due_date": "2025-02-07",
"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-07",
"due_date": "2025-03-07",
"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-07",
"due_date": "2025-04-07",
"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 de Operação:
Para operações em que ainda não se passaram 90 dias desde a data de Despacho Benefício e a averbação não é permitida, é necessário garantir que a soma de disbursement_date e limit_days_to_disburse resulte em uma data posterior aos 90 dias. Caso essa regra não seja cumprida, a operação será cancelada permanentemente, com o CancelReason: social_security_margin_release_after_disbursement_end_date.
O campo "assistance_type", localizado dentro do objeto "collateral_data", refere-se ao tipo de benefício que está sendo utilizado para o empréstimo. O mesmo é retornado na consulta de dados do benefício. Para visualizar os valores possíveis (enumeradores), consultar a tabela Tabela de enumerador
Request
Caso 1: Emissão sem representante legal
- Crédito Novo
- Refinanciamento
- Crédito Novo - Aumento Salarial
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"is_pep": false,
"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-20",
"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
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_data": {
"state": "SP",
"benefit_number": 2052711150
},
"collateral_type": "social_security"
}
],
"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
}
]
}
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"is_pep": false,
"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": "2024-09-20",
"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
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_data": {
"state": "SP",
"benefit_number": 2052711150
},
"collateral_type": "social_security"
}
],
"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
}
],
"refinanced_credit_operations": [
{
"operation_key": "4f32e501-212c-4129-8ac3-d9943b78583b"
}
]
}
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"is_pep": false,
"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": "2024-09-20",
"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
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_data": {
"state": "SP",
"benefit_number": 2052711150,
"operation_category": "minimum_wage_increase"
},
"collateral_type": "social_security"
}
],
"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
}
]
}
Caso 2: Emissão com representante legal
- Crédito Novo
- Refinanciamento
- Crédito Novo - Aumento Salarial
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"is_pep": false,
"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": [
{
"name": "Representante legal",
"email": "teste@qitech.com.br",
"phone": {
"number": "991294043",
"area_code": "55",
"country_code": "055"
},
"address": {
"street": "AV LEONOR",
"state": "SP",
"city": "GUARULHOS",
"neighborhood": "",
"number": "1",
"postal_code": "07025200",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"is_pep": false,
"individual_document_number": "19125869086",
"birth_date": "1970-04-20",
"mother_name": " Ana Lúcia"
}
],
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-09-20",
"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
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_data": {
"state": "SP",
"benefit_number": 2052711150
},
"collateral_type": "social_security"
}
],
"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
}
]
}
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"is_pep": false,
"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": [
{
"name": "Representante legal",
"email": "teste@qitech.com.br",
"phone": {
"number": "991294043",
"area_code": "55",
"country_code": "055"
},
"address": {
"street": "AV LEONOR",
"state": "SP",
"city": "GUARULHOS",
"neighborhood": "",
"number": "1",
"postal_code": "07025200",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"is_pep": false,
"individual_document_number": "19125869086",
"birth_date": "1970-04-20",
"mother_name": " Ana Lúcia"
}
],
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-09-20",
"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
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_data": {
"state": "SP",
"benefit_number": 2052711150
},
"collateral_type": "social_security"
}
],
"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
}
],
"refinanced_credit_operations": [
{
"operation_key": "4f32e501-212c-4129-8ac3-d9943b78583b"
}
]
}
{
"borrower": {
"name": "Nome devedor",
"phone": {
"number": "999538380",
"area_code": "84",
"country_code": "055"
},
"gender": "female",
"is_pep": false,
"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": [
{
"name": "Representante legal",
"email": "teste@qitech.com.br",
"phone": {
"number": "991294043",
"area_code": "55",
"country_code": "055"
},
"address": {
"street": "AV LEONOR",
"state": "SP",
"city": "GUARULHOS",
"neighborhood": "",
"number": "1",
"postal_code": "07025200",
"complement": ""
},
"role_type": "issuer_legal_representative",
"person_type": "natural",
"is_pep": false,
"individual_document_number": "19125869086",
"birth_date": "1970-04-20",
"mother_name": " Ana Lúcia"
}
],
"financial": {
"interest_type": "pre_price_days",
"first_due_date": "2024-09-20",
"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
},
"simplified": true,
"collaterals": [
{
"percentage": 1,
"collateral_data": {
"state": "SP",
"benefit_number": 2052711150,
"operation_category": "minimum_wage_increase"
},
"collateral_type": "social_security"
}
],
"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
}
],
"refinanced_credit_operations": [
{
"operation_key": "4f32e501-212c-4129-8ac3-d9943b78583b"
}
]
}
Exemplo de objeto financial com rebates
{
"financial": {
"first_due_date": "2022-12-07",
"installment_face_value": 100,
"disbursement_date": "2022-11-03",
"limit_days_to_disburse": 3,
"number_of_installments": 24,
"disbursed_amount": 1876,
"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,
"rebates": [
{
"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"
}
]
}
}
Response
Response Body
{
"webhook_type": "debt",
"key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00",
"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": {
"state": "SP",
"benefit_number": 2052711150,
"reservation_method": "issuing"
},
"collateral_key": "26c7f4f4-51f3-41fa-b880-9691211136aa",
"collateral_type": "social_security",
"created_at": "2024-11-07T23:19:16.413448",
"external_key": null,
"percentage": 1,
"reservation_method": {
"enumerator": "issuing"
},
"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-20",
"calendar_days": 74,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 73,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 72,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 71,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 70,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 69,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 68,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"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-20",
"calendar_days": 67,
"due_date": "2025-01-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-02-20",
"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-20",
"calendar_days": 28,
"due_date": "2025-03-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-04-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-05-20",
"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-20",
"calendar_days": 31,
"due_date": "2025-06-20",
"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-20",
"calendar_days": 30,
"due_date": "2025-08-20",
"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-22",
"calendar_days": 33,
"due_date": "2025-09-22",
"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-20",
"calendar_days": 28,
"due_date": "2025-10-20",
"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-20",
"prefixed_interest_rate": {
"monthly_rate": 0.0166,
"daily_rate": 0.00054142,
"annual_rate": 0.21843191,
"interest_base": "calendar_days_365"
}
}
]
}
}
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 Body
{
"key": "\<DEBT-KEY\>",
"data": {
"cancel_reason": "Operacao cancelada manualmente",
"cancel_reason_enumerator": "manual"
},
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2022-11-01 03:46:31"
}
Simulando cenários de sucesso e insucesso na averbação em Sandbox:
A simulação de cenários é baseado no primeiro dígito do CPF informado na operação.
11.1. Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook.
11.2. 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.
11.3. 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 |
3 | operation_not_allowed_IR | Operation not allowed due to operation deadline greatter than benefit termination | cancel |
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 - Envio de documentos
É obrigatório o envio (segundo IN 138 do INSS) dos dados complementares do contrato.
Os documentos devem ser enviados através do endpoint de upload de documentos. e devem seguir a seguinte formatação:
Validações | Valores |
---|---|
Formato | JPEG |
Tamanho mínimo | 250 x 250 px |
Após o upload dos documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da operação ou após, através do seguinte endpoint:
Request Body
{
"document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
"document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
"selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
A related_party_key é retornada na response da criação de dívida dentro do objeto borrower
6 - Formalização da operação
Após o input dos documentos a operação pode seguir para formalização.
No caso de assinatura por parte do representante legal, no campo "data.contract.signers[i]" serão retornados os dados do representante legal, e o valor do objeto "data.contract.signers[i].signer_role" será "issuer_legal_representative".
No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 5. Os campos obrigatórios são os seguintes: ip_address e signature_datetime.
Request
Request Body
{
...,
"ip_address": "192.168.0.0",
"signature_datetime": "2020-03-20T14:28:23.382748Z",
"similarity_score": 0.98000,
"biometry_analysis_reference": "serpro",
"type": "data-signature"
}
O payload de envio da assinatura varia de acordo com o processo de formalização do parceiro e deve ser alinhado com o time de integração da QI Tech.
Enumeradores Biometry Analysis Reference
Enumerador | Descrição |
---|---|
serpro | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro) |
tse | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE |
not_found | Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro. |
A QI Tech oferece o serviço de assinatura que atende ao determinado pela IN 138. Com biometria facial e envio de documentos.
Para receber uma cotação consulte nosso time comercial:
comercial@qitech.com.br ou (11) 2339-4763
Response
Response Body
{
"data": {},
"event_datetime": "2022-11-07 15:24:47",
"key": "\<DEBT-KEY\>",
"status": "signature_received",
"webhook_type": "debt"
}
Após o recebimento da assinatura, uma validação dos documentos enviados e do campo assistance type será feita.
Caso seja enviado um tipo de benefício (assistance_type) que não esteja mapeado, a operação será cancelada permanentemente.
O mesmo vale para as validações de documentos, caso haja duplicidade, falta ou documentos fora dos padrões mínimos exigidos, a operação será cancelada permanente.
Em ambos os casos, um webhook será enviado com o seguinte payload:
Webhook Body
{
"key": "<DEBT-KEY>",
"data": {},
"status": "canceled_permanently",
"webhook_type": "debt",
"event_datetime": "2022-11-01 03:46:31"
}
7 - Averbação e Desaverbação
Para que o pedido de averbação seja criado com sucesso, é preciso que seja feita uma consulta de dados válida para o benefício previamente. Para isso basta seguir os passos do item 2 - Consulta de dados do benefício.
Falha na averbação por margem exedida
Se uma reserva com categoria de novo beneficiário ou de aumento salarial 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 Body
- Novo Beneficiario
- Aumento Salarial
{
"webhook": {
"key": "\<DEBT-KEY\>",
"data": {
"enumerator": "margin_exceeded_for_new_beneficiary",
"description": "The margin for this reservation has been exceeded. Reservation Amount: 551.18",
},
"status": "pending_requester_action",
"webhook_type": "social_security_margin_exceeded_for_new_beneficiary",
"event_datetime": "2024-10-15T15:33:59"
}
}
{
"webhook": {
"key": "\<DEBT-KEY\>",
"data": {
"enumerator": "margin_exceeded_for_minimum_wage_increase",
"description": "The margin for this reservation has been exceeded. Reservation Amount: 551.18",
},
"status": "pending_requester_action",
"webhook_type": "social_security_margin_exceeded_for_minimum_wage_increase",
"event_datetime": "2024-10-15T15:33:59"
}
}
Falha na averbação por falta de uma consulta de dados válida do benefício
Se uma consulta dos dados do benefício 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 Body
{
"webhook": {
"key": "\<DEBT-KEY\>",
"data": {
"enumerator": "success_balance_request_not_found",
"description": "Success balance request not found for the specified benefit number"
},
"status": "pending_requester_action",
"webhook_type": "social_security_success_balance_request_not_found",
"event_datetime": "2024-10-15T15:33:59"
}
}
Para prosseguir, as seguintes ações deverão ser tomadas:
- Realizar a consulta dos dados do benefício em questão seguindo os passos do item 2 - Consulta de dados do benefício;
- Enviar uma requisição no formato abaixo para informar que a consulta foi realizada.
Essa requisição não apenas confirma a existência de uma consulta válida dos dados do benefício, 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.
Sucesso na averbação
Em caso de sucesso na averbação o parceiro receberá o seguinte webhook:
Webhook Body
{
"key": "\<DEBT-KEY\>",
"data": {
"collateral_type": "social_security",
"collateral_constituted": true
},
"event_time": "2022-10-31 15:23:46",
"webhook_type": "credit_operation.collateral"
}
Correção de dados no caso de falha na averbação
É possível corrigir os dados bancários, número do benefício e o nome do contrato em tentativa de averbação. Para isso basta utilizar a seguinte chamada:
Request Body
- Dados Bancários
- Número do Benefício
- Nome
{
"disbursement_bank_account": {
"bank_code": "123",
"account_digit": "1",
"account_branch": "1234",
"account_number": "5678",
"document_number": "12345678901"
}
}
{
"benefit_number": 1234567890
}
{
"name": "Nome do Beneficiário"
}
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:
Webhooks
Webhook Body
{
"key": "\<DEBT-KEY\>",
"data": {},
"status": "canceled_permanently",
"webhook_type": "debt",
"event_datetime": "2022-11-01 03:46:31"
}
8 - Falha no desembolso
TED
Em caso de falha no desembolso via TED
Webhook Body
{
"status": "canceled",
"key": "\<DEBT-KEY\>",
"data": {
"ted_refusal": {
"transaction_key": "16faabfc-3876-437d-a4f6-aae17a1d68c9",
"description": "341 0000 000000-7 12345678900 - NOME BENEFICIÁRIO",
"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 BENEFICIÁRIO",
"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 Body
{
"webhook_type": "debt",
"data": {
"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."
},
"cancel_reason": "pix_refusal"
},
"status": "canceled",
"key": "\<DEBT-KEY\>",
"event_datetime": "2022-11-07 15:29:37"
}
9 - Reapresentação de Pagamento
Altera a data de desembolso sem afetar os valores financeiros da operação.
Request
Request Body
{
"disbursement_date": "2022-11-04",
"disbursement_bank_accounts": [
{
"branch_number": "1232",
"account_digit": "4",
"account_number": "412412412",
"account_type": "checking_account",
"document_number": "\<CPF BENEFICIÁRIO\>",
"bank_code": 184,
"ispb_number": "17298092",
"name": "\<NOME BENEFICIÁRIO\>",
"percentage_receivable": 100
}
]
}
Response
Response Body
{
"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
}
],
"disbursement_date": "2022-11-04"
}
10 - Recuperar resposta da última request
O last response é uma forma de mapear, de forma simples e objetiva, a resposta da comunicação entre a QI e a Dataprev, possibilitando saber quando essa requisição foi feita e qual o retorno obtido (através de um enumerador). Os enumeradores estão diretamente relacionados aos códigos de retorno da Dataprev e são divididos em duas formas: "errors" e "success".
Cada enumerador tem uma descrição detalhada e o código de referência da Dataprev. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response.
Casos de sucesso
Request
Response
Response Body
{
"collateral_constituted": true,
"collateral_type": "type",
"updated_at": "2023-05-24 19:13:02",
"collateral_data": {
"state": "SP",
"benefit_number": 1976703155,
"status": "reserved",
"last_response": {
"success": [
{
"enumerator": "succesfully_included",
"reservation_method" : "new_credit"
}
]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z"
}
}
Detalhamento de campos no retorno da request
Campo | Descrição | Valores |
---|---|---|
enumerator | Retorno mapeado do código Dataprev | Enumeradores |
reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
Casos de erro
Request
Response
Response Body
{
"collateral_constituted": false,
"collateral_type": "type",
"updated_at": "2023-05-24 19:13:02",
"collateral_data": {
"state": "SP",
"benefit_number": 1976703155,
"status": "pending_reservation",
"last_response": {
"errors": [
{
"enumerator": "benefit_blocked_by_tbm",
"reservation_method" : "new_credit"
}
]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z"
}
}
Detalhamento de campos no retorno da request
Campo | Descrição | Valores |
---|---|---|
enumerator | Retorno mapeado do código Dataprev | Enumeradores |
reservation_method | Método de averbação da reserva | portability, new_credit, refinancing |
11 - Webhook de resposta da última tentativa de averbação
Caso a operação não tenha sucesso na averbação, a mesma ficará em retentativa e será enviado o seguinte webhook, detalhando o motivo da não averbação, o horário desta tentativa e o método de averbação utilizado:
Body:
body.json
{
"webhook_type": "credit_operation.collateral",
"key": "\<CREDIT-OPERATION-KEY\>",
"event_time": "2022-11-24T15:42:12",
"data": {
"collateral_type": "social_security",
"collateral_constituted": false,
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [{
"enumerator": "consignable_margin_excceded"
}]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z",
"reservation_method": "new_credit",
}
}
}
12. Mapeamento de enumeradores
Tabela de retorno de erros Dataprev - averbação
Código Dataprev | Enumerador | Descrição | Ação Qi |
---|---|---|---|
HW | consignable_margin_excceded | Exceeded consignable margin | Teimosinha |
IT | benefit_blocked_by_tbm | Benefit blocked due to benefit transfer | Teimosinha |
IE | benefit_blocked_by_beneficiary | Benefit blocked by beneficiary | Teimosinha |
AN | invalid_disbursement_account | Invalid disbursement bank account | Cancelar |
HX | reservation_already_included | Reservation already included | Confirmar averbação |
IF | benefit_blocked_by_granting_process | Benefit blocked during granting process | Teimosinha |
AV | processing_payroll | Operation couldn`t be done during processing payroll period | Teimosinha |
OF | invalid_cbc | Invalid cbc | Teimosinha |
IA | first_name_mismatch | First name mismatch benefit owner or legal representative | Teimosinha |
OS | legal_representative_document_number_mismatch | Document number mismatch legal representative | Teimosinha |
AY | invalid_state | Invalid state | Teimosinha |
HZ | operation_not_allowed_on_this_reservation_status | Operation couldn`t be done with current reservation status | Teimosinha |
AP | invalid_contract_date | Accrual, end or start contract date is invalid | Teimosinha |
GA | required_fields_missing | Required fields are missing | Teimosinha |
BC | cbc_missing | CBC is missing | Teimosinha |
NC | contract_number_missing | Contract number is missing | Teimosinha |
NB | benefit_number_missing | Benefit number is missing | Teimosinha |
CA | invalid_bank_code | Invalid bank code | Teimosinha |
HR | exceeded_number_of_allowed_contracts | Amount of contracts is above the limit | Teimosinha |
PV | invalid_image_format | Image with wrong format | Teimosinha |
IR | operation_not_allowed_IR | Operation date is greater than benefit expiration | Cancelar |
PK | wrong_bank_code_destination | Portability number was found with wrong bank code destination | Teimosinha |
PH | wrong_benefit_number_on_portability | Portability number was found with wrong benefit number | Teimosinha |
PI | invalid_contract_total_amount | Reservation contract total amount should be greater than Dataprev reference amount | Teimosinha |
Tabela de retorno de sucesso - averbação
Código Dataprev | Enumerador | Descrição |
---|---|---|
BD | successfully_included | Inclusion has been successfully done |
BF | successfully_removed | Removal has been successfully done |
BR | successfully_reactivated | Reactivation has been successfully done |
BS | successfully_suspended | Suspension has been successfully done |
Tabela de retorno de erros na consulta de saldo
Código | Enumerador | Descrição |
---|---|---|
CR | not_found_legal_representative | no legal representative for the beneficiary |
CD | inexistent_beneficiary | no beneficiary found |
AS | benefity_without_legal_representative | beneficiary does not have a legal representative |
BI | inexistent_benefit | no benefit found |
D1 | inconsistent_balance_benefit_data | The balance benefit data registered is either inconsistent, null or incomplete. |
Tabela de retorno de erros na consulta de benefícios
Código | Enumerador | Descrição |
---|---|---|
CR | not_found_legal_representative | no legal representative for the beneficiary |
CD | inexistent_beneficiary | no beneficiary found |
AS | benefity_without_legal_representative | beneficiary does not have a legal representative |
Tabela de situação de benefícios
Items |
---|
active |
excluded |
terminated |
suspended |
suspended_by_CONPAG |
terminated_by_SISOBI |
receiving_monthly_recover_6_months |
receiving_monthly_recover_18_months |
suspended_by_name_error |
suspended_by_credentialed_payer |
suspended_by_inspection |
suspended_by_audit |
terminated_by_inspection |
terminated_by_audit |
receiving_monthly_recover_6_months_inspection |
receiving_monthly_recover_18_months_inspection |
suspended_by_SISOBI |
canceled_by_audit |
Tabela de status de benefícios
Enumerador | Descrição |
---|---|
Elegible | Elegível para empréstimo |
Inelegible | Benefício inelegível para empréstimo |
Blocked | Benefício elegível, porém bloqueado para empréstimo |
Tabela de tipos de bloqueio
Enumerador | Descrição |
---|---|
0 | Sem bloqueio |
1 | Bloqueado pelo Segurado |
2 | Bloqueado por TBM |
3 | Bloqueado na Concessão |
Tabela de tipos de politicamente exposto
Enumerador | Descrição |
---|---|
0 | Pessoa Não Exposta Politicamente |
1 | Pessoa Exposta Politicamente - Nível 1 |
Tabela de benefícios
código | benefício |
---|---|
1 | pension_by_death_rural_worker |
2 | pension_by_death_accident_rural_worker |
3 | pension_by_death_rural_employer |
4 | retirement_invalidity_rural_emploee |
5 | retirement_invalidity_accident_rural_worker |
6 | retirement_invalidity_rural_employer |
7 | retirement_by_eldness_rural_worker |
8 | retirement_by_age_rural_employer |
9 | complement_by_work_accident_rural_worker |
11 | support_invalidity_rural_worker |
12 | support_by_age_rural_worker |
13 | aid_sickness_rural_worker |
15 | aid_time_off_rural_worker |
16 | aid_federal |
17 | international_agreement |
18 | inclusion_benefit |
19 | pension_student_law7004 |
20 | pension_by_death_diplomat |
21 | pension_by_death |
22 | pension_by_death_statute |
23 | pension_by_death_veteran |
24 | pension_special_institutional_act |
25 | aid_time_off |
26 | pension_by_death_special_law593 |
27 | pension_by_death_federal_emploee |
28 | pension_by_death_general_regime_law20465 |
29 | pension_by_death_marine_veteran |
30 | monthly_income_lifetime_invalidity |
31 | aid_sickness |
32 | retirement_invalidity_social_security |
33 | retirement_invalidity_aeronautic |
34 | retirement_invalidity_marine_law1756 |
35 | aid_sickness_veteran |
36 | aid_social_security_accident |
37 | retirement_capin_extra_emploee |
38 | retirement_federal_extra_emploee |
39 | aid_invalidity_student_law7004 |
40 | monthly_income_lifetime_by_age_upper70_law6179 |
41 | retirement_by_age |
42 | retirement_by_contribution_time |
43 | retirement_by_time_of_service_veteran |
44 | retirement_special_aeronautic |
45 | retirement_by_time_of_service_journalist |
46 | retirement_special |
47 | allowance_25 |
48 | allowance_20 |
49 | retirement_ordinary |
50 | aid_sickness_extinct_basic_plan |
51 | retirement_invalidity_extinct_basic_plan |
52 | retirement_by_age_extinct_basic_plan |
53 | aid_time_off_extinct_basic_plan |
54 | pension_indemnity_federal |
55 | pension_by_death_extinct_basic_plan |
56 | pension_lifetime_syndrome_thalidomide |
57 | retirement_by_teacher_labor_time |
58 | retirement_anisty |
59 | pension_by_death_amnesty |
60 | indemnity |
61 | aid_birth |
62 | aid_funeral |
63 | aid_funeral_rural_worker |
64 | aid_funeral_rural_employer |
65 | savings_special_autarchy |
67 | savings_mandatory_ipase_law5128 |
68 | savings_special_retirement_ps_affiliated_upper60 |
69 | savings_student_law7004 |
70 | restitution |
71 | monthly_income |
72 | retirement_by_time_of_service_law1756 |
73 | monthly_income_family_statute |
74 | complement_pension_federal |
75 | complement_retirement_federal |
76 | monthly_income_statute |
77 | monthly_income_sinpas_family_statute |
78 | retirement_by_age_law1756 |
79 | advantage |
80 | monthly_income_maternity |
81 | compulsory_retirement |
82 | retirement_by_time_of_service_sasse |
83 | retirement_invalidity_ex_sasse |
84 | pension_by_death_sasse |
85 | pension_lifetime_rubber_tapper_law7986 |
86 | pension_lifetime_rubber_tapper_dependent_law7986 |
87 | continuous_aid_physical_disabilities |
88 | continuous_aid_eldness |
89 | pension_special_hemodialysis_victim_caruaru |
90 | medic_assistency_work_accident |
91 | aid_sickness_by_work_accident |
92 | retirement_invalidity_work_accident |
93 | pension_by_death_work_accident |
94 | aid_work_accident |
95 | aid_additional_work_accident |
96 | pension_special_leprosy_law11520 |
97 | savings_by_death_work_accident |
98 | aid_longshoreman |
99 | time_off_15 |