Manual Saque Aniversário - FGTS v2
Atenção!
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.
Este manual descreve o passo a passo envolvido na consulta, simulação, emissão, desembolso e demais ações de uma operação de Adiantamento do Saque Aniversário FGTS (Crédito pessoal com cessão do Saque Aniversário FGTS).
Pré-requisitos
1 - Tomador deve ser optante pelo saque aniversario FGTS;
2 - Tomador deve autorizar a QI a consultar seu saldo de FGTS no aplicativo da CEF (Caixa Econômica Federal);
1 - Consultar saldo disponível
1.1. Realização da consulta de saldo:
Request
ENDPOINT
/baas/v2/fgts/available_balanceMETHOD
POSTRequest Body
{
"document_number": "06568225037"
}
Em caso de sucesso na consulta do saldo disponível, é retornado principalmente o número de contratos ativos e se o beneficiário tem saldo disponível em seu FGTS.
Response
ENDPOINT
/baas/v2/fgts/available_balanceMETHOD
POSTResponse Body
{
"available_balance_key": "7521981f-0b06-43d2-9a75-d3a1f215fbbf",
"document_number": "06568225037",
"status": "pending",
"status_events": [{
"event_datetime": "2022-12-26T13:36:16",
"status": "pending"
}]
}
1.1.1. No caso de sucesso na consulta de saldo na CEF, o parceiro receberá o seguinte webhook:
Webhooks
WEBHOOK_TYPE
available_balanceSTATUS
SuccessBody
{
"webhook_type": "available_balance",
"event_datetime": "2022-12-26T13:36:16",
"key": "7521981f-0b06-43d2-9a75-d3a1f215fbbf",
"status": "success",
"data": {
"reference_date": "2022-07-28",
"periods": [{
"due_date": "2022-08-01",
"amount": 500.1
},
{
"due_date": "2023-08-01",
"amount": 400.2
}
]
}
}
1.1.2. No caso de falha na consulta de saldo na CEF, o parceiro receberá o seguinte webhook:
WEBHOOK_TYPE
available_balanceSTATUS
FailedBody
{
"webhook_type": "available_balance",
"event_datetime": "2022-12-26T13:36:16",
"key": "7521981f-0b06-43d2-9a75-d3a1f215fbbf",
"status": "failed",
"data": {
"error_description": "Client does not have membership for anniversary withdraw on current date",
"error_enumerator": "inexistent_anniversary_membership"
}
}
1.1.3. No caso de falha na consulta de saldo na CEF por data da operação não permitida, o parceiro receberá um webhook com uma informação adicional no campo "data":
WEBHOOK_TYPE
available_balanceSTATUS
FailedBody
{
"webhook_type": "available_balance",
"event_datetime": "2022-12-26T13:36:16",
"key": "7521981f-0b06-43d2-9a75-d3a1f215fbbf",
"status": "failed",
"data": {
"error_description": "Not permitted action on current date",
"error_enumerator": "on_locked_date_range",
"error_data": {
"operation_not_allowed_until_date": "2023-01-03"
}
}
}
Os possíveis enumeradores de falha na consulta de saldo são listados na seção 2.
2 - Simulando cenários de sucesso e insucesso na consulta de saldo em Sandbox:
2.1. Para CPFs iniciados com os números 0, 1, 2, 3, 4, 5, 6 e 7, retornarão uma resposta assíncrona de sucesso através do Webhook (1.1.1.).
2.2. Para CPF’s iniciandos com o número 8, a consulta de saldo retornará uma resposta assíncrona de sucesso (1.1.1.) com períodos zerados que podem ser usados para teste.
2.3. Simulando casos de falha na consulta de saldo disponível:
Todas as consultas realizadas para CPFs incitados com 9, retornarão uma resposta assíncrona de erro através do webhook (1.1.2. ou 1.1.3.) com um dos erros listados abaixo.
Temos um mock de casos de insucesso para serem testados, eles usam uma lógica aplicada aos primeiros números do documento do tomador em sandbox.
| Início do CPF | error_enumerator | error_description |
|---|---|---|
| 90 | ongoing_operation | There's an ongoing operation |
| 91 | unauthorized_institution | Institution isn't authorized by the client |
| 92, 920 | inexistent_anniversary_membership | Client does not have membership for anniversary withdraw on current date |
| 93 | on_locked_date_range | Not permitted action on current date |
| 94 | anniversary_membership_egress | Client moving away from anniversary membership. It need to be canceled before requesting a reserve |
| 95, 950 | processing_pending_changes | Changes on profile info happened on client's FGTS account |
| 96, 97, 98, 99 | caixa_error | Request wasn't able to process due to an error on CEF |
3 - Acompanhamento e ações em relação a consulta de saldo
A resposta da consulta deve desencadear uma ação por parte do correspondente, de forma a orientar o cliente assertivamente e evitar o acúmulo de requsições perdidas em nossas filas.
| Enumerador | error_description | Descrição | Ação da QI | Ação do Cliente |
|---|---|---|---|---|
| ongoing_operation | There's an ongoing operation | Existe uma operação em andamento na Caixa em relação à esse CPF que implica na alteração do saldo do cliente. Isso impede que valores exatos de parcelas sejam disponibilizados | Envio webhook com o correspondente enumerador e descrição | Recomenda-se aguardar e fazer uma nova tentativa |
| unauthorized_institution | Institution isn't authorized by the client | Instituição não autorizada pelo cliente | Envio webhook com o correspondente enumerador e descrição | Orientar o cliente a realizar a autorização da "QI SOCIEDADE DE CREDITO S.A" para operar o Adiantamento do Saque Aniversário FGTS |
| inexistent_anniversary_membership | Client does not have membership for anniversary withdraw on current date | Trabalhador não possui adesão ao saque aniversário na data vigente | Envio webhook com o correspondente enumerador e descrição | Necessário orientar o cliente a aderir a modalidade de Saque Aniversário no aplicativo do FGTS |
| on_locked_date_range | Not permitted action on current date | A Operação não é permitida na data atual | Envio webhook com o correspondente enumerador e descrição | A operação é permitida no segundo dia útil do próximo mês. Fazer a devida comunicação com o cliente, visto que ele não conseguirá fazer a operação no momento em nenhuma outra instituição financeira |
| anniversary_membership_egress | Client moving away from anniversary membership. It need to be canceled before requesting a reserve | Trabalhador com solicitação de retorno para saque rescisão, que deve ser cancelada pelo mesmo para possibilitar a solicitação de garantia. | Envio webhook com o correspondente enumerador e descrição | Orientar cliente que ele solicitou o egresso da modalidade de Saque Aniversário, isso impede que ele faça o adiantamento de seus saques |
| processing_pending_changes | Changes on profile info happened on client's FGTS account | Operação não permitida por pendência no processo de pagamento de Saque Aniversário | Envio webhook com o correspondente enumerador e descrição | Orientar cliente a aguardar a regularização |
| caixa_error | Request wasn't able to process due to an error on CEF | A requisição não foi completada devido a um erro retornado pela Caixa | Envio webhook com o correspondente enumerador e descrição | Recomenda-se aguardar e fazer uma nova tentativa |
info
No ambiente produtivo, a consulta de saldo possui uma rotina de retentativas que depende do erro retornado pela CEF no momento da consulta. Alguns erros são passíveis de retentativa, já os erros listados acima, são erros definitivos, que não retornam a consulta assíncrona para a fila de retentativa.
4 - Simulação do valor máximo
Em posse dos valores disponíveis para saque em cada período (ano), retornados na consulta de saldo (1.), é possível realizar a simulação de uma operação de adiantamento do Saque Aniversário FGTS.
A forma de simulação demonstrada nessa seção, mostra qual é o valor máximo que pode ser contratado pelo tomador adiantando 100% dos valores das parcelas disponíveis.
Request
ENDPOINT
/baas/fgts_simulationMETHOD
POSTRequest Body
{
"borrower": {
"person_type": "natural",
"individual_document_number": "46338864879"
},
"financial": {
"desired_installments": [{
"total_amount": 5448.42,
"due_date": "2023-10-01"
},
{
"total_amount": 2811.86,
"due_date": "2024-10-01"
}
],
"interest_type": "pre_price_days",
"disbursement_date": "2023-06-30",
"fine_configuration": {
"monthly_rate": 0,
"interest_base": "calendar_days",
"contract_fine_rate": 0
},
"annual_interest_rate": 0.274223,
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"number_of_installments": 2,
"principal_grace_period": 0
}
}
Response
METHOD
POSTENDPOINT
/baas/fgts_simulationResponse Body
{
"data": {
"annual_cet": 0.3339086001603759,
"assignment_amount": 7195.39,
"cet": 0.0243,
"contract_fee_amount": 43.17,
"contract_fees": [
{
"amount": 0.6,
"amount_type": "percentage",
"fee_amount": 43.17,
"fee_type": "tac"
}
],
"credit_operation_type": "ccb",
"disbursed_issue_amount": 7020.82,
"disbursement_date": "2023-06-30",
"disbursement_options": [
{
"annual_cet": 0.3339086001603759,
"assignment_amount": 7195.39,
"cet": 0.0243,
"contract_fee_amount": 43.17,
"contract_fees": [
{
"amount": 0.6,
"amount_type": "percentage",
"fee_amount": 43.17,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 7020.82,
"disbursement_date": "2023-06-30",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"first_due_date": "2023-10-01",
"installments": [
{
"business_due_date": "2023-10-02",
"calendar_days": 93,
"due_date": "2023-10-01",
"due_principal": 7195.39,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 458.290020805,
"principal_amortization_amount": 4990.129979195,
"tax_amount": 38.05473122134107,
"total_amount": 5448.42,
"workdays": 64.0
},
{
"business_due_date": "2024-10-01",
"calendar_days": 366,
"due_date": "2024-10-01",
"due_principal": 2205.260020805,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 606.5994412243,
"principal_amortization_amount": 2205.2605587757,
"tax_amount": 66.0034485241567,
"total_amount": 2811.86,
"workdays": 252.0
}
],
"iof_amount": 131.4,
"issue_amount": 7195.39,
"net_external_contract_fee_amount": 0.0,
"prefixed_interest_rate": {
"annual_rate": 0.274223,
"daily_rate": 0.00066416,
"interest_base": "calendar_days_365",
"monthly_rate": 0.02040001
},
"total_pre_fixed_amount": 1064.8894620293
}
],
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"final_disbursement_amount": 7020.82,
"installments": [
{
"business_due_date": "2023-10-02",
"calendar_days": 93,
"due_date": "2023-10-01",
"due_principal": 7195.39,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 458.290020805,
"principal_amortization_amount": 4990.129979195,
"tax_amount": 38.05473122134107,
"total_amount": 5448.42,
"workdays": 64.0
},
{
"business_due_date": "2024-10-01",
"calendar_days": 366,
"due_date": "2024-10-01",
"due_principal": 2205.260020805,
"has_interest": true,
"installment_number": 2,
"post_fixed_amount": null,
"pre_fixed_amount": 606.5994412243,
"principal_amortization_amount": 2205.2605587757,
"tax_amount": 66.0034485241567,
"total_amount": 2811.86,
"workdays": 252.0
}
],
"interest_grace_period": 0,
"interest_payment_month_period": 1,
"interest_type": "pre_price_days",
"iof_amount": 131.4,
"issue_amount": 7195.39,
"issue_date": "2023-06-30",
"net_external_contract_fee_amount": 0.0,
"number_of_installments": 2,
"operation_type": "structured_operation",
"post_fixed_interest_base": "workdays",
"post_fixed_interest_rate": null,
"prefixed_interest_rate": {
"annual_rate": 0.274223,
"daily_rate": 0.00066416,
"interest_base": "calendar_days_365",
"monthly_rate": 0.02040001
},
"principal_amortization_month_period": 1,
"principal_grace_period": 0,
"requester_key": "a5c043d3-dec3-4f8d-aa14-01dc9ba85783",
"total_pre_fixed_amount": 1064.8894620293
},
"event_datetime": "2023-06-28 14:07:47",
"key": "9e532b37-e301-4646-80b7-afd8a3d60f51",
"status": "finished",
"type": "debt"
}
5 - Simulação do valor desejado
A forma de simulação demonstrada nessa seção, mostra qual é o valor das parcelas do Saque Aniversário o tomador precisa adiantar para desembolsar um determinado valor.
Request
ENDPOINT
/baas/fgts_simulation_guessMETHOD
POSTRequest Body
{
"borrower": {
"person_type": "natural",
"individual_document_number": "46338864879"
},
"target_disbursed_amount": 4000,
"financial": {
"desired_installments": [{
"total_amount": 5448.42,
"due_date": "2023-10-01"
}],
"interest_type": "pre_price_days",
"disbursement_date": "2023-06-30",
"fine_configuration": {
"monthly_rate": 0,
"interest_base": "calendar_days",
"contract_fine_rate": 0
},
"annual_interest_rate": 0.27422288066567435,
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"number_of_installments": 1,
"principal_grace_period": 0
}
}
info
Os valores de parcela informados na lista de parcelas no objeto “financial.desired_installments” devem ser os valores retornados na consulta. Esses valores serão utilizados como valores máximos das parcelas na simulação.
Response
METHOD
POSTENDPOINT
/baas/fgts_simulation_guessResponse Body
{
"data": {
"annual_cet": 0.3655007620895273,
"assignment_amount": 4070.94,
"cet": 0.0263,
"contract_fee_amount": 24.43,
"contract_fees": [
{
"amount": 0.6,
"amount_type": "percentage",
"fee_amount": 24.43,
"fee_type": "tac"
}
],
"credit_operation_type": "ccb",
"disbursed_issue_amount": 4000.0,
"disbursement_date": "2023-06-30",
"disbursement_options": [
{
"annual_cet": 0.3655007620895273,
"assignment_amount": 4070.94,
"cet": 0.0263,
"contract_fee_amount": 24.43,
"contract_fees": [
{
"amount": 0.6,
"amount_type": "percentage",
"fee_amount": 24.43,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 4000.0,
"disbursement_date": "2023-06-30",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"first_due_date": "2023-10-01",
"installments": [
{
"business_due_date": "2023-10-02",
"calendar_days": 93,
"due_date": "2023-10-01",
"due_principal": 4070.94,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 259.2870755335,
"principal_amortization_amount": 4070.9429244665,
"tax_amount": 31.045010741981528,
"total_amount": 4330.23,
"workdays": 64.0
}
],
"iof_amount": 46.51,
"issue_amount": 4070.94,
"net_external_contract_fee_amount": 0.0,
"prefixed_interest_rate": {
"annual_rate": 0.27422288,
"daily_rate": 0.00066416,
"interest_base": "calendar_days_365",
"monthly_rate": 0.0204
},
"total_pre_fixed_amount": 259.2870755335
}
],
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
},
{
"amount": 0.0,
"amount_released": 0,
"amount_type": "absolute",
"cofins_amount": 0,
"csll_amount": 0,
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"irrf_amount": 0,
"net_fee_amount": 0.0,
"pis_amount": 0,
"tax_amount": 0.0
}
],
"final_disbursement_amount": 4000.0,
"installments": [
{
"business_due_date": "2023-10-02",
"calendar_days": 93,
"due_date": "2023-10-01",
"due_principal": 4070.94,
"has_interest": true,
"installment_number": 1,
"post_fixed_amount": null,
"pre_fixed_amount": 259.2870755335,
"principal_amortization_amount": 4070.9429244665,
"tax_amount": 31.045010741981528,
"total_amount": 4330.23,
"workdays": 64.0
}
],
"interest_grace_period": 0,
"interest_payment_month_period": 1,
"interest_type": "pre_price_days",
"iof_amount": 46.51,
"issue_amount": 4070.94,
"issue_date": "2023-06-30",
"net_external_contract_fee_amount": 0.0,
"number_of_installments": 1,
"operation_type": "structured_operation",
"post_fixed_interest_base": "workdays",
"post_fixed_interest_rate": null,
"prefixed_interest_rate": {
"annual_rate": 0.27422288,
"daily_rate": 0.00066416,
"interest_base": "calendar_days_365",
"monthly_rate": 0.0204
},
"principal_amortization_month_period": 1,
"principal_grace_period": 0,
"requester_key": "a5c043d3-dec3-4f8d-aa14-01dc9ba85783",
"total_pre_fixed_amount": 259.2870755335
},
"event_datetime": "2023-06-28 14:11:15",
"key": "aa0d581b-4332-40e1-adad-0c7724dc880a",
"status": "finished",
"type": "debt"
}
6 - Criação da Operação
Para realizar a criação de uma operação do Saque Aniversário FGTS, é necessário informar 4 objetos na requisição:
-
borrower: tomador da dívida (Object Borrower)
-
collaterals: informações das parcelas de pagamento (objeto Collateral FGTS)
-
financial: dados do fluxo financeiro da operação (Objeto Financeiro FGTS). É o mesmo objeto informado na simulação.
-
disbursement_bank_account: informações bancárias para o desembolso (Objeto Conta Bancária)
O PDF do contrato da operação do Saque Aniversário FGTS será gerado pela QI neste momento e será retornado na resposta da requisição.
Atenção
Para os valores de parcelas informados na lista de parcelas do objeto “financial.desired_installments” utilizamos o campo "total_amount", para os valores de parcelas no objeto “collaterals.collateral_data.periods” utilizamos o campo "amount".
Request
ENDPOINT
baas/debt_fgtsMETHOD
POSTRequest Body
{
"borrower": {
"person_type": "natural",
"name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
"mother_name": "HELENA DO NASCIMENTO PEREIRA DA SILVA",
"birth_date": "1997-10-28",
"profession": "Outros",
"nationality": "brasileira",
"marital_status": "married",
"is_pep": false,
"individual_document_number": "46338864879",
"document_identification_number": "46338864879",
"document_identification_type": "rg",
"document_identification_date": "2023-12-29",
"document_identification": "494598fd-c226-4332-a500-591ae3884673",
"document_identification_back": "494598fd-c226-4332-a500-591ae3884673",
"email": "naotem@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "989073010"
},
"address": {
"street": "Rua José Castrioto",
"state": "SP",
"city": "São José dos Campos",
"neighborhood": "Parque Nova Esperança",
"number": "147",
"postal_code": "12226160",
"complement": "CASA"
}
},
"additional_data": null,
"collaterals": [
{
"collateral_type": "fgts_balance",
"collateral_data": {
"periods": [
{
"due_date": "2024-05-02",
"amount": 1758.2
}
]
},
"percentage": 1
}
],
"financial": {
"desired_installments": [
{
"due_date": "2024-05-02",
"total_amount": 1758.2
}
],
"interest_type": "pre_price_days",
"disbursement_start_date": "2024-01-17",
"disbursement_end_date": "2024-01-22",
"fine_configuration": {
"monthly_rate": 0.01,
"contract_fine_rate": 0.01,
"interest_base": "calendar_days"
},
"monthly_interest_rate": 0.018,
"credit_operation_type": "ccb",
"interest_grace_period": 0,
"number_of_installments": 11,
"principal_grace_period": 0,
"issue_date": "2024-01-17"
},
"disbursement_bank_account": {
"ispb_number": "18236120",
"branch_number": "1",
"account_number": "87823171",
"account_digit": "0",
"document_number": "46338864879",
"name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
"percentage_receivable": 1
}
}
Response
METHOD
POSTENDPOINT
/baas/debt_fgtsResponse Body
{
"data": {
"borrower": {
"document_number": "46338864879",
"name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
"related_party_key": "824e4338-5b22-4e78-84db-94a23c56bf49"
},
"collaterals": [
{
"absolute_amount": null,
"collateral_constituted": false,
"collateral_data": {
"document_number": "46338864879",
"error_message": "None",
"periods": [
{
"amount": 1758.2,
"due_date": "2024-05-02"
}
],
"protocol_number": null,
"reservation_request_closure_status": null,
"reservation_request_closure_status_translation": null,
"reservation_request_key": "1b6ce462-3a28-4601-bd27-ce8ce6b50781",
"reservation_request_status": "pending",
"reservation_request_status_translation": "Em Teimosinha"
},
"collateral_key": "01f511ee-3409-44f8-adb9-31fbeab87b27",
"collateral_type": "fgts_balance",
"created_at": "2024-01-17T14:59:35.434402",
"external_key": "1b6ce462-3a28-4601-bd27-ce8ce6b50781",
"percentage": 1,
"updated_at": "2024-01-17T14:59:35.434387"
}
],
"contract": {
"number": "0000083262/PAD",
"signers": [
{
"signature_url": null,
"signer_document_number": "46338864879",
"signer_email": "naotem@gmail.com",
"signer_external_key": null,
"signer_name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
"signer_role": "issuer"
}
],
"urls": [
"https://storage.googleapis.com/sandbox-doc-api/documents/cb10aaac-a6da-4742-b86f-60726d9f6ce7/TESTEINSSS.A.-PATRICIA_APARECIDA_DO_NASCIMENTO_PEREIRA_DA_SILVA-CCB-0000083262-20240117145936.pdf"
]
},
"disbursement_options": [
{
"additional_iof": 6.278436,
"annual_cet": "31,6323%",
"assignment_amount": 1652.22,
"base_iof": 14.361093768373301,
"cet": "2,3200%",
"contract_fee_amount": 8.26,
"contract_fees": [
{
"fee_amount": 8.26,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1623.32,
"disbursement_date": "2024-01-17",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}
],
"first_due_date": "2024-05-02",
"installments": [
{
"additional_costs": [],
"business_due_date": "2024-05-02",
"calendar_days": 106,
"due_date": "2024-05-02",
"due_interest": 0.0,
"due_principal": 1652.22,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 105.9802843565,
"principal_amortization_amount": 1652.2197156435,
"tax_amount": 14.361093768373301,
"total_amount": 1758.2,
"workdays": 72.0
}
],
"issue_amount": 1652.22,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.23872053,
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"total_iof": 20.64,
"total_pre_fixed_amount": 105.9802843565
},
{
"additional_iof": 6.282122,
"annual_cet": "31,6725%",
"assignment_amount": 1653.19,
"base_iof": 14.233957774255675,
"cet": "2,3200%",
"contract_fee_amount": 8.27,
"contract_fees": [
{
"fee_amount": 8.27,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1624.4,
"disbursement_date": "2024-01-18",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}
],
"first_due_date": "2024-05-02",
"installments": [
{
"additional_costs": [],
"business_due_date": "2024-05-02",
"calendar_days": 105,
"due_date": "2024-05-02",
"due_interest": 0.0,
"due_principal": 1653.19,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 105.0109437566,
"principal_amortization_amount": 1653.1890562434,
"tax_amount": 14.233957774255675,
"total_amount": 1758.2,
"workdays": 71.0
}
],
"issue_amount": 1653.19,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.23872053,
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"total_iof": 20.52,
"total_pre_fixed_amount": 105.0109437566
},
{
"additional_iof": 6.285808,
"annual_cet": "31,7080%",
"assignment_amount": 1654.16,
"base_iof": 14.10666765817373,
"cet": "2,3200%",
"contract_fee_amount": 8.27,
"contract_fees": [
{
"fee_amount": 8.27,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1625.5,
"disbursement_date": "2024-01-19",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}
],
"first_due_date": "2024-05-02",
"installments": [
{
"additional_costs": [],
"business_due_date": "2024-05-02",
"calendar_days": 104,
"due_date": "2024-05-02",
"due_interest": 0.0,
"due_principal": 1654.16,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 104.0410344543,
"principal_amortization_amount": 1654.1589655457,
"tax_amount": 14.10666765817373,
"total_amount": 1758.2,
"workdays": 70.0
}
],
"issue_amount": 1654.16,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.23872053,
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"total_iof": 20.39,
"total_pre_fixed_amount": 104.0410344543
},
{
"additional_iof": 6.289494,
"annual_cet": "31,7502%",
"assignment_amount": 1655.13,
"base_iof": 13.979223283044265,
"cet": "2,3200%",
"contract_fee_amount": 8.28,
"contract_fees": [
{
"fee_amount": 8.28,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1626.58,
"disbursement_date": "2024-01-20",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}
],
"first_due_date": "2024-05-02",
"installments": [
{
"additional_costs": [],
"business_due_date": "2024-05-02",
"calendar_days": 103,
"due_date": "2024-05-02",
"due_interest": 0.0,
"due_principal": 1655.13,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 103.070556116,
"principal_amortization_amount": 1655.129443884,
"tax_amount": 13.979223283044265,
"total_amount": 1758.2,
"workdays": 70.0
}
],
"issue_amount": 1655.13,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.23872053,
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"total_iof": 20.27,
"total_pre_fixed_amount": 103.070556116
},
{
"additional_iof": 6.29318,
"annual_cet": "31,7877%",
"assignment_amount": 1656.1,
"base_iof": 13.851624511675489,
"cet": "2,3300%",
"contract_fee_amount": 8.28,
"contract_fees": [
{
"fee_amount": 8.28,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1627.68,
"disbursement_date": "2024-01-21",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}
],
"first_due_date": "2024-05-02",
"installments": [
{
"additional_costs": [],
"business_due_date": "2024-05-02",
"calendar_days": 102,
"due_date": "2024-05-02",
"due_interest": 0.0,
"due_principal": 1656.1,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 102.099508408,
"principal_amortization_amount": 1656.100491592,
"tax_amount": 13.851624511675489,
"total_amount": 1758.2,
"workdays": 70.0
}
],
"issue_amount": 1656.1,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.23872053,
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"total_iof": 20.14,
"total_pre_fixed_amount": 102.099508408
},
{
"additional_iof": 6.296866,
"annual_cet": "31,8319%",
"assignment_amount": 1657.07,
"base_iof": 13.723871206771127,
"cet": "2,3300%",
"contract_fee_amount": 8.29,
"contract_fees": [
{
"fee_amount": 8.29,
"fee_type": "tac"
}
],
"disbursed_issue_amount": 1628.76,
"disbursement_date": "2024-01-22",
"external_contract_fee_amount": 0.0,
"external_contract_fees": [
{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "tac",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
},
{
"description": null,
"fee_amount": 0.0,
"fee_type": "insurance_premium",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}
],
"first_due_date": "2024-05-02",
"installments": [
{
"additional_costs": [],
"business_due_date": "2024-05-02",
"calendar_days": 101,
"due_date": "2024-05-02",
"due_interest": 0.0,
"due_principal": 1657.07,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 101.127890996,
"principal_amortization_amount": 1657.072109004,
"tax_amount": 13.723871206771127,
"total_amount": 1758.2,
"workdays": 69.0
}
],
"issue_amount": 1657.07,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.23872053,
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"total_iof": 20.02,
"total_pre_fixed_amount": 101.127890996
}
],
"entry": null,
"iof_charge_method": "financed",
"prefixed_interest_rate": {
"annual_rate": 0.23872053,
"created_at": "2024-01-17T14:59:35",
"daily_rate": 0.00058669,
"interest_base": "calendar_days_365",
"monthly_rate": 0.018
},
"requester_identifier_key": "2fedb18e-207b-4bb5-954a-0e6e19bb6e50"
},
"event_datetime": "2024-01-17 14:59:40",
"key": "2fedb18e-207b-4bb5-954a-0e6e19bb6e50",
"status": "waiting_signature",
"webhook_type": "debt"
}
7 - Formalização da operação
Por padrão a QI Tech realiza a coleta de assinaturas através da QI Sign e o contrato é enviado para os assinantes no momento da emissão, porém ainda existe a possibilidade de o parceiro realizar a coleta de assinaturas de forma independente e enviar o documento assinado ou as evidencias de assinatura para a QI Tech para seguir com a operação.
Tipos de assinatura aceitos
QI Sign
A assinatura através da QI Sign ocorre de forma automática na plataforma QI Tech, uma vez que a operação é criada o documento é disparado pela QI Sign para coleta de assinaturas, após assinado a operação automaticamente muda de status aguardando o desembolso.
pdf-signature
Esse tipo indica que o PDF emitido através da "/debt" será assinado e link com o PDF assinado será enviado através da API 4.1 como forma de autenticação.
Request
ENDPOINT
debt/[DEBT_KEY]/signedMETHOD
POSTRequest Body
{
"type": "pdf-signature",
"path-pdf-signed": "https://www.google.com/"
}
Response
METHOD
POSTENDPOINT
debt/[DEBT_KEY]/signedResponse Body
{
"data": {},
"event_datetime": "2023-01-17 17:17:28",
"key": "4630cd58-ab00-49b3-b8cb-cb0f4a5af7a4",
"status": "signature_received",
"webhook_type": "debt"
}
data-signature
Esse tipo indica que o PDF emitido através da "/debt" será assinado através de um hash anexado em sua ultima pagina.
A autenticação através de dados pode ter 3 tipos:
- Opt-in
A assinatura através de opt-in significa que o cliente vai dar o aceite do contrato através do front.
Para que essa assinatura seja valida, alguns dados devem ser enviados obrigatoriamente.
Request
ENDPOINT
debt/[DEBT_KEY]/signedMETHOD
POSTRequest Body
{
"type": "data-signature",
"signatures": [{
"signed_object": {
"document_key": "095bd363-a5be-4561-955d-f199bf664972",
"document_md5": "06d19d6664f20a73158d277d41c8c7d3",
"raw_text": "Lorem ipsum dolor sit amet, consectetur a...."
},
"authenticity": {
"timestamp": "1970-01-01 00:00:01",
"ip_address": "179.104.42.245",
"session_id": "ddb1d063-4fdf-4430-af9c-3316e9142ff3",
"fingerprint": {
"lat": -7.205088,
"long": -48.2414106,
"name": "SM-A015M",
"model": "SM-A015M",
"calendar": "AM",
"regionCode": "BR",
"systemName": "Android",
"orientation": "Portrait",
"currencyCode": "BRL",
"languageCode": "pt",
"systemVersion": "11",
"userinterface": "Android",
"localizedModel": "SM-A015M",
"decimalSeparator": ",",
"usesMetricSystem": "true",
"preferredLanguages": "pt-BR,en-BR",
"supportsMultiTasking": "true"
}
},
"signer": {
"name": "VITOR",
"email": "vitor.castello@qitech.com.br",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "645236363652"
},
"authentication_type": "opt_in"
}]
}
- Zip
A assinatura através de zip contempla o envio de um arquivo de comprovação, como uma ligação gravada.
Request
ENDPOINT
debt/[DEBT_KEY]/signedMETHOD
POSTRequest Body
{
"type": "data-signature",
"signatures": [
{
"signed_object": {
"raw_text": "Lorem ipsum dolor sit amet, consectetur a....",
"document_key": "79003de0-2590-455d-9b73-426b8ca284eb",
"document_md5": "7521bd5621d97af26b2c1721fc4023a8"
},
"authenticity": {
"timestamp": "1970-01-01 00:00:01",
"document_key": "79003de0-2590-455d-9b73-426b8ca284eb",
"document_md5": "7521bd5621d97af26b2c1721fc4023a8"
},
"signer": {
"name": "IVANILDO DE SENA LIMA",
"email": "ivanlima2604@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "61766976204"
},
"authentication_type": "zip"
}
]
}
- Selfie
A autenticação através de selfie é disponibilizada para os parceiros que utilizam os serviços de CaaS QI Tech, onde a autenticação através de selfie é validada e um id de comprovação é gerado.
Request
ENDPOINT
debt/[DEBT_KEY]/signedMETHOD
POSTRequest Body
{
"type": "data-signature",
"signatures": [
{
"signed_object": {
"raw_text": "Lorem ipsum dolor sit amet, consectetur a...."
},
"authenticity": {
"timestamp": "1970-01-01 00:00:01",
"facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb"
},
"signer": {
"name": "IVANILDO DE SENA LIMA",
"email": "ivanlima2604@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "61766976204"
},
"authentication_type": "selfie"
}
]
}
Response
METHOD
POSTENDPOINT
debt/[DEBT_KEY]/signedResponse Body
{
"data": {},
"event_datetime": "2023-01-17 17:17:28",
"key": "4630cd58-ab00-49b3-b8cb-cb0f4a5af7a4",
"status": "signature_received",
"webhook_type": "debt"
}
info
O Response é o mesmo para todas as operações realizadas através do endpoint debt/{DEBT_KEY}/signed.
8 - Máquina de estados e webhooks
Após a criação de uma dívida dentro do nosso sistema, são possíveis os seguintes status:
| Status | Tradução |
|---|---|
| waiting_signature | Aguardando assinatura |
| signature_finished | Assinatura finalizada |
| disbursed | Operação desembolsada (paga) |
| canceled | Operação cancelada |
| cancel_permanently | Operação cancelada permanentemente |
8.1. signature_finished: Informa que a operação está assinada e fornece o url com o documento assinado.
Webhook
WEBHOOK_TYPE
debtSTATUS
signature_finishedSTATUS
Waiting_signatureBody
{
"data": {
"borrower": {
"document_number": "46338864879",
"name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
"related_party_key": "9878573b-4ccf-4f72-be82-5ba70d25d5a7"
},
"collaterals": [{
"absolute_amount": null,
"collateral_constituted": false,
"collateral_data": {
"document_number": "46338864879",
"error_message": "None",
"periods": [{
"amount": 222.21,
"due_date": "2024-01-01"
},
{
"amount": 382.14,
"due_date": "2025-01-01"
},
{
"amount": 311.43,
"due_date": "2026-01-01"
},
{
"amount": 342.38,
"due_date": "2027-01-01"
},
{
"amount": 194.29,
"due_date": "2028-01-01"
},
{
"amount": 97.15,
"due_date": "2029-01-01"
},
{
"amount": 48.57,
"due_date": "2030-01-01"
},
{
"amount": 24.29,
"due_date": "2031-01-01"
},
{
"amount": 12.14,
"due_date": "2032-01-01"
},
{
"amount": 6.07,
"due_date": "2033-01-01"
}
],
"protocol_number": null,
"reservation_request_closure_status": null,
"reservation_request_closure_status_translation": null,
"reservation_request_key": "e2edaa95-69b8-47d3-8ca7-5e48fd3440c5",
"reservation_request_status": "pending",
"reservation_request_status_translation": "Em Teimosinha"
},
"collateral_key": "e9cf1551-5b95-4edf-827f-29bd4d4f0b2f",
"collateral_type": "fgts_balance",
"created_at": "2023-05-26T14:55:25.335308",
"external_key": "977075c1-d529-4cc2-931c-188cab4aa761",
"percentage": 1,
"updated_at": "2023-05-26T14:55:25.335291"
}],
"contract": {
"number": "0000064547/PAD",
"signers": [{
"signature_url": null,
"signer_document_number": "46338864879",
"signer_email": "naotem@gmail.com",
"signer_external_key": null,
"signer_name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA",
"signer_role": "issuer"
}],
"urls": [
"https://storage.googleapis.com/sandbox-doc-api/documents/8a370979-727b-4865-a03a-27f8d6208f57/SYNGENTASANDBOX-PATRICIA_APARECIDA_DO_NASCIMENTO_PEREIRA_DA_SILVA-CCB-0000070572-20230526145531.pdf"
]
},
"disbursement_options": [{
"additional_iof": 3.282668,
"annual_cet": "29,8407%",
"assignment_amount": 872.5,
"base_iof": 24.828504537437023,
"cet": "2,2000%",
"contract_fee_amount": 8.64,
"contract_fees": [{
"fee_amount": 8.64,
"fee_type": "tac"
}],
"disbursed_issue_amount": 827.11,
"disbursement_date": "2023-05-26",
"external_contract_fee_amount": 8.64,
"external_contract_fees": [{
"description": null,
"fee_amount": 8.64,
"fee_type": "spread",
"net_fee_amount": 7.84,
"rebate_bank_account": null,
"tax_amount": 0.8
},
{
"description": null,
"fee_amount": 0,
"fee_type": "tac",
"net_fee_amount": 0,
"rebate_bank_account": null,
"tax_amount": 0
}
],
"first_due_date": "2024-01-01",
"installments": [{
"additional_costs": [],
"business_due_date": "2024-01-02",
"calendar_days": 220,
"due_date": "2024-01-01",
"due_interest": 0,
"due_principal": 863.86,
"fine_amount": null,
"has_interest": true,
"installment_number": 1,
"installment_status": null,
"installment_type": null,
"post_fixed_amount": null,
"pre_fixed_amount": 135.8606707299,
"principal_amortization_amount": 86.3493292701,
"tax_amount": 1.557741900032604,
"total_amount": 222.21,
"workdays": 149
},
...
],
"issue_amount": 863.86,
"net_external_contract_fee_amount": 7.84,
"number_of_installments": null,
"pre_fixed_interest_rate": {
"annual_rate": 0.274223,
"daily_rate": 0.00066416,
"interest_base": "calendar_days_365",
"monthly_rate": 0.02040001
},
"total_iof": 28.11,
"total_pre_fixed_amount": 776.8144015216
},
...
],
"entry": null,
"iof_charge_method": "financed",
"prefixed_interest_rate": {
"annual_rate": 0.274223,
"created_at": "2023-05-26T14:55:31",
"daily_rate": 0.00066416,
"interest_base": "calendar_days_365",
"monthly_rate": 0.02040001
},
"requester_identifier_key": "e99ed7c8-ecb3-441d-9130-45feb0ad9c36"
},
"event_datetime": "2023-05-26 14:55:38",
"key": "e99ed7c8-ecb3-441d-9130-45feb0ad9c36",
"status": "waiting_signature",
"webhook_type": "debt"
}
8.2. signature_finished: Informa que a operação está assinada e fornece o url com o documento assinado.
Webhook
WEBHOOK_TYPE
debtSTATUS
Signature_finishedBody
{
"webhook_type": "debt",
"key":"57f8e1ce-1080-4d0d-a195-89709b961561",
"event_datetime": "2022-09-29 20:00:54",
"status":"signature_finished",
}
8.2. disbursed: Indica que o recurso foi enviado para a conta do cliente. Além de dispor dos dados de transferência do pagamento e um comprovante em pdf do desembolso realizado.
Webhook
WEBHOOK_TYPE
debtSTATUS
disbursedBody
{
"webhook": {
"key": "4475d350-a63f-4d93-8e76-40386ce942b0",
"data": {
"installments": [
{
"due_date": "2024-08-01",
"total_amount": 1264.12,
"installment_key": "526ca3da-d669-4db5-a16c-67a687c4a755",
"pre_fixed_amount": 141.15866647,
"principal_amortization_amount": 1122.96133353
}
],
"ted_receipt_list": [
{
"fee": 0,
"url": "https://storage.googleapis.com/sandbox-doc-api/documents/099e04d7-3fe5-41ba-bef3-4165d0a09a99/099e04d7-3fe5-41ba-bef3-4165d0a09a99.pdf",
"amount": 1100,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000135",
"bank_code": "329",
"account_key": "5d068423-6094-49e4-b15b-7740038295a8",
"branch_digit": null,
"account_digit": "5",
"account_branch": "0001",
"account_number": "00002",
"financial_institution_name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A."
},
"timestamp": "2024-01-11T13:28:45",
"description": "00360305 0465 100071066-1 24182533410 - Mock Person Name",
"destination": {
"name": "Mock Person Name",
"type": "checking_account",
"branch": "0465",
"purpose": "Crédito PIX em Conta",
"document": "24182533410",
"bank_ispb": "00360305",
"branch_digit": null,
"account_digit": "1",
"account_number": "100071066",
"financial_institution_name": "CAIXA ECONOMICA FEDERAL"
},
"end_to_end_id": "E32402502202401111328RqgXuWz64uU",
"transaction_key": "cffe9c42-fec0-49fc-b9f6-7a5b431f8374",
"origin_transaction_key": "e8ef9c9f-b813-418a-b19c-8fab0dfcb67e"
}
],
"requester_identifier_key": null
},
"status": "disbursed",
"webhook_type": "debt",
"event_datetime": "2024-01-11 13:28:46"
}
}
8.3. canceled: Indica o cancelamento da operação. Isso pode ser causado por dados bancários incorretos na tentativa de pagamento, falta de assinatura, limite da data de desembolso excedido ou alguma questão em relação à averbação do saldo.
Atenção
O cancelamento da operação não indica que a operação será desaverbada na Caixa. Para que seja disparado a solicitação de desaverbação do saldo do cliente deve-se obrigatoriamente cancelar permanentemente a operação.
Nessa lista de enumeradores, você encontra todos os possíveis motivos de cancelamento de uma operação, por erro na averbação.
Webhook
WEBHOOK_TYPE
debtSTATUS
canceledBody
{
"key": "6613ebf5-b41d-4257-b2f9-89ce261c5041",
"data": {
"cancel_reason": "Available Balance is not sufficient for given periods amount",
"cancel_reason_enumerator": "fgts_insufficient_balance"
},
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2022-12-22 21:27:41"
}
8.5. Colateral constituído:
Webhook
WEBHOOK_TYPE
credit_operation.collateralSTATUS
NABody
{
"key": "767b4ca4-0afc-4e28-a7d7-645bef1873c2",
"data": {
"collateral_type": "fgts",
"collateral_constituted": true
},
"event_time": "2022-12-09 19:02:32",
"webhook_type": "credit_operation.collateral"
}
9 - Simulando cenários de sucesso e insucesso na averbação em Sandbox:
9.1. O cenário ideal é simulado para os CPFs iniciados com 0, 1, 2 ou 3.
| Início do CPF | Ação |
|---|---|
| 0, 1, 2 ou 3 | Operação segue com sucesso até o desembolso |
9.2. Simulando casos de falha na averbação:
Todas as averbações com CPFs que começam com 9 terão erros. Alguns tratáveis, outros que disparam retentativa e outros inesperados.
Todas as averbações com CPFs que começam com 8 terão erros por falta de saldo.
caution
Alguns erros na averbação, mesmo disparando um webhook de cancelamento, são passíveis de rententativa de averbação. Então, é necessário
Enumeradores webhook de cancelamento por erro na averbação
| cancel_reason_enumerator | cancel_reason | Descrição | Ação QI |
|---|---|---|---|
| fgts_invalid_given_period | Given periods date does not match with CEF system | Uma ou mais datas de previsão do saque informadas não conferem com as datas previstas no sistema da Caixa ou os valores enviados para as parcelas são maiores do que o disponível | Operação é cancelada e não retentamos averbação |
| fgts_unauthorized_institution | Institution isn't authorized by the client | Instituição não autorizada pelo cliente | Operação é cancelada e retentamos a averbação |
| fgts_processing_pending_changes | Changes on profile info happened on client's FGTS account | Operação não permitida por mudanças nas informações do perfil na conta do FGTS do cliente | Operação é cancelada e não retentamos averbação |
| fgts_on_locked_date_range | Not permitted action on current date | A Operação não é permitida na data atual | Operação é cancelada e retentamos a averbação na data pemitida |
| fgts_insufficient_balance | Available Balance is not sufficient for given periods amount | Trabalhador não possui saldo disponível para a Operação Fiduciária | Operação é cancelada e não retentamos averbação |
| fgts_inexistent_anniversary_membership | Client does not have membership for anniversary withdraw on current date | Trabalhador não possui adesão ao saque aniversário na data vigente | Operação é cancelada e não retentamos averbação |
| fgts_period_rejected | Reservation period not accepted | Protocolo recusado pela CEF | Operação é cancelada e não retentamos averbação |
| fgts_deletion_request | Deletion request was before the reservation was completed | A solicitação de desaverbação foi realizada antes da conclusão da reserva | Operação é cancelada e não retentamos averbação |
| fgts_protocol_removed | Protocol was removed | Protocolo removido na CEF | Operação é cancelada e não retentamos averbação |
| fgts_insufficient_balance_available | The indicated value is not available for contracting | O valor indicado não está disponível para a contratação | Operação é cancelada e não retentamos averbação |
| fgts_insufficient_balance_for_guarantee | Available balance is not sufficient for the required guarantee | O saldo disponível não é suficiente para a garantia requerida | Operação é cancelada e não retentamos averbação |
| fgts_fgts_accounts_not_found | The informed worker does not have FGTS accounts | O Trabalhador informado não possui contas de FGTS | Operação é cancelada e não retentamos averbação |
10 - Reapresentação de Operações
Existem casos onde a data de desembolso selecionada para a operaç ão pode passar com pendências no contrato, o que faz com que o mesmo seja cancelado.
Para que seja possível reiniciar o processo de um contrato já cancelado, é necessário recalcular a operação. Temos duas formas para o envio: alterar a data de desembolso ou alterar os dados da conta bancária de desembolso.
10.1 - Mudança da data de desembolso:
Request
ENDPOINT
/debt/DEBT-KEY/disbursement_optionMETHOD
PATCHRequest Body
{
"disbursement_date": "2023-06-30",
"status": "active"
}
STATUS
200Response Body
{
"data": {
"additional_iof": 17.770586,
"annual_cet": 31.682,
"assignment_amount": 4676.97,
"base_iof": 127.71954759,
"borrower": {
"document_number": "88229032939",
"name": "Teste",
"related_party_key": "13d210c8-d39a-40f9-bd16-b6ab81d35fa8"
},
"cet": 2.32,
"collaterals": [],
"contract": {
"number": "0000051370/TG",
"urls": [
"https://storage.googleapis.com/dev-doc-api/documents/a715175f-8d29-4929-9576-4b692d1e9610/BEATRIZCOUTODECARVALHO-TESTE-CCB-0000051370-20230707151409.pdf"
]
},
"contract_fee_amount": 0.5,
"contract_fees": [{
"fee_amount": 0.5,
"fee_type": "spread"
}],
"disbursed_issue_amount": 4530.98,
"entry": null,
"external_contract_fee_amount": 0.0,
"external_contract_fees": [{
"description": null,
"fee_amount": 0.0,
"fee_type": "spread",
"net_fee_amount": 0.0,
"rebate_bank_account": null,
"tax_amount": 0.0
}],
"installments": [{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2023-08-29",
"calendar_days": 50,
"digitable_line": null,
"due_date": "2023-08-28",
"due_interest": 0.0,
"due_principal": 4676.47,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "29c6e226-b710-4e3b-a5d6-62119b9d9547",
"installment_number": 1,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4676.47,
"original_pre_fixed_amount": 164.86042852,
"original_principal_amortization_amount": 25.13957148,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 164.86042852,
"principal_amortization_amount": 25.13957148,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.10307224,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 36
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2023-09-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2023-09-28",
"due_interest": 0.0,
"due_principal": 4651.33042852,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "322d7973-4d2a-41a6-ad1b-2fef59c551b7",
"installment_number": 2,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4651.33042852,
"original_pre_fixed_amount": 100.99385125,
"original_principal_amortization_amount": 89.00614875,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 100.99385125,
"principal_amortization_amount": 89.00614875,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.59117884,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2023-10-31",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2023-10-28",
"due_interest": 0.0,
"due_principal": 4562.32427977,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "a2d43778-0342-48f7-a0d2-c385773fa545",
"installment_number": 3,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4562.32427977,
"original_pre_fixed_amount": 95.83242026,
"original_principal_amortization_amount": 94.16757974,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 95.83242026,
"principal_amortization_amount": 94.16757974,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.85711331,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2023-11-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2023-11-28",
"due_interest": 0.0,
"due_principal": 4468.15670003,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "9126aa9a-6bb0-44c6-8ea4-61fd68fcd936",
"installment_number": 4,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4468.15670003,
"original_pre_fixed_amount": 97.01661904,
"original_principal_amortization_amount": 92.98338096,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 97.01661904,
"principal_amortization_amount": 92.98338096,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 1.08269849,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2023-12-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2023-12-28",
"due_interest": 0.0,
"due_principal": 4375.17331907,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "f0b363f9-0aca-4154-b14a-2c7933374abc",
"installment_number": 5,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4375.17331907,
"original_pre_fixed_amount": 91.90128137,
"original_principal_amortization_amount": 98.09871863,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 91.90128137,
"principal_amortization_amount": 98.09871863,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 1.38358433,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-01-30",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-01-28",
"due_interest": 0.0,
"due_principal": 4277.07460043,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "c7c41dee-28a3-4b37-b2de-256fa0c9a0a9",
"installment_number": 6,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4277.07460043,
"original_pre_fixed_amount": 92.86767319,
"original_principal_amortization_amount": 97.13232681,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 92.86767319,
"principal_amortization_amount": 97.13232681,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 1.61686471,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-02-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-02-28",
"due_interest": 0.0,
"due_principal": 4179.94227362,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "ee5d7b27-5160-49d3-9eb0-ec5a2f20e50d",
"installment_number": 7,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4179.94227362,
"original_pre_fixed_amount": 90.75864903,
"original_principal_amortization_amount": 99.24135097,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 90.75864903,
"principal_amortization_amount": 99.24135097,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 1.90424304,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-04-01",
"calendar_days": 29,
"digitable_line": null,
"due_date": "2024-03-28",
"due_interest": 0.0,
"due_principal": 4080.70092265,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "a9ec8c98-0061-4956-8af8-93d5742f6c1f",
"installment_number": 8,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 4080.70092265,
"original_pre_fixed_amount": 82.82984224,
"original_principal_amortization_amount": 107.17015776,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 82.82984224,
"principal_amortization_amount": 107.17015776,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 2.31123162,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-04-30",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-04-28",
"due_interest": 0.0,
"due_principal": 3973.53076489,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "bfd2ceab-74d4-4ff4-b099-c6ab986b7acb",
"installment_number": 9,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3973.53076489,
"original_pre_fixed_amount": 86.2768573,
"original_principal_amortization_amount": 103.7231427,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 86.2768573,
"principal_amortization_amount": 103.7231427,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 2.50055752,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-05-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2024-05-28",
"due_interest": 0.0,
"due_principal": 3869.80762219,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "eb41f47f-ffcd-4d4d-8834-600cfe95b2a4",
"installment_number": 10,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3869.80762219,
"original_pre_fixed_amount": 81.2859859,
"original_principal_amortization_amount": 108.7140141,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 81.2859859,
"principal_amortization_amount": 108.7140141,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 2.88831393,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-07-01",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-06-28",
"due_interest": 0.0,
"due_principal": 3761.09360809,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "13183e83-70cf-4990-a3cc-c979e43015b9",
"installment_number": 11,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3761.09360809,
"original_pre_fixed_amount": 81.6642313,
"original_principal_amortization_amount": 108.3357687,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 81.6642313,
"principal_amortization_amount": 108.3357687,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.15365423,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-07-30",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2024-07-28",
"due_interest": 0.0,
"due_principal": 3652.75783939,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "a2ed3748-8567-4cab-a1ff-0cf6b2698d15",
"installment_number": 12,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3652.75783939,
"original_pre_fixed_amount": 76.72681698,
"original_principal_amortization_amount": 113.27318302,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 76.72681698,
"principal_amortization_amount": 113.27318302,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.39026637,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-08-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-08-28",
"due_interest": 0.0,
"due_principal": 3539.48465638,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "1e009f23-2044-40ba-8249-a9077a2391b9",
"installment_number": 13,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3539.48465638,
"original_pre_fixed_amount": 76.85245907,
"original_principal_amortization_amount": 113.14754093,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 76.85245907,
"principal_amortization_amount": 113.14754093,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.3865059,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 23
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-10-01",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-09-28",
"due_interest": 0.0,
"due_principal": 3426.33711545,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "e475d886-a596-4541-bcae-4986bf7c3609",
"installment_number": 14,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3426.33711545,
"original_pre_fixed_amount": 74.39569823,
"original_principal_amortization_amount": 115.60430177,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 74.39569823,
"principal_amortization_amount": 115.60430177,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.46003675,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-10-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2024-10-28",
"due_interest": 0.0,
"due_principal": 3310.73281367,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "5584643d-4e65-4e99-9483-b3c1b051fd63",
"installment_number": 15,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3310.73281367,
"original_pre_fixed_amount": 69.54252108,
"original_principal_amortization_amount": 120.45747892,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 69.54252108,
"principal_amortization_amount": 120.45747892,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.60529234,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-11-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2024-11-28",
"due_interest": 0.0,
"due_principal": 3190.27533475,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "23a0002c-49bf-4c22-a506-d89ae4372249",
"installment_number": 16,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3190.27533475,
"original_pre_fixed_amount": 69.27011321,
"original_principal_amortization_amount": 120.72988679,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 69.27011321,
"principal_amortization_amount": 120.72988679,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.61344551,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2024-12-31",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2024-12-28",
"due_interest": 0.0,
"due_principal": 3069.54544796,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "5efbf6d0-84bc-4041-8a33-e9ab1bf82969",
"installment_number": 17,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 3069.54544796,
"original_pre_fixed_amount": 64.47633798,
"original_principal_amortization_amount": 125.52366202,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 64.47633798,
"principal_amortization_amount": 125.52366202,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.7569232,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-01-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-01-28",
"due_interest": 0.0,
"due_principal": 2944.02178595,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "e9bb5d68-8c93-43a4-b240-d68b0d1d6d08",
"installment_number": 18,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2944.02178595,
"original_pre_fixed_amount": 63.9232354,
"original_principal_amortization_amount": 126.0767646,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 63.9232354,
"principal_amortization_amount": 126.0767646,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.77347756,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-03-05",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-02-28",
"due_interest": 0.0,
"due_principal": 2817.94502134,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "d6c34059-ba9b-4345-b937-35293f34a3dd",
"installment_number": 19,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2817.94502134,
"original_pre_fixed_amount": 61.18574366,
"original_principal_amortization_amount": 128.81425634,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 61.18574366,
"principal_amortization_amount": 128.81425634,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 3.85541069,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 23
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-03-31",
"calendar_days": 28,
"digitable_line": null,
"due_date": "2025-03-28",
"due_interest": 0.0,
"due_principal": 2689.130765,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "63fa4169-f1a9-43f0-a059-70e2df35ac7e",
"installment_number": 20,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2689.130765,
"original_pre_fixed_amount": 52.68330953,
"original_principal_amortization_amount": 137.31669047,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 52.68330953,
"principal_amortization_amount": 137.31669047,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.10988855,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 18
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-04-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-04-28",
"due_interest": 0.0,
"due_principal": 2551.81407453,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "859ee4fa-f781-419b-8888-731b0f8fc01b",
"installment_number": 21,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2551.81407453,
"original_pre_fixed_amount": 55.40726995,
"original_principal_amortization_amount": 134.59273005,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 55.40726995,
"principal_amortization_amount": 134.59273005,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.02836041,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 19
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-05-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2025-05-28",
"due_interest": 0.0,
"due_principal": 2417.22134448,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "d6e25388-d54d-42ca-8b46-ac70fa7aeb23",
"installment_number": 22,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2417.22134448,
"original_pre_fixed_amount": 50.7741553,
"original_principal_amortization_amount": 139.2258447,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 50.7741553,
"principal_amortization_amount": 139.2258447,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.16702953,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-07-01",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-06-28",
"due_interest": 0.0,
"due_principal": 2277.99549978,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "d92f0e38-fa48-48c2-a79e-e8316fe5c870",
"installment_number": 23,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2277.99549978,
"original_pre_fixed_amount": 49.46187558,
"original_principal_amortization_amount": 140.53812442,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 49.46187558,
"principal_amortization_amount": 140.53812442,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.20630606,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-07-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2025-07-28",
"due_interest": 0.0,
"due_principal": 2137.45737535,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "04aa2658-8fbe-4147-8a14-03c7bba13577",
"installment_number": 24,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 2137.45737535,
"original_pre_fixed_amount": 44.89766385,
"original_principal_amortization_amount": 145.10233615,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 44.89766385,
"principal_amortization_amount": 145.10233615,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.34291292,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-08-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-08-28",
"due_interest": 0.0,
"due_principal": 1992.35503921,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "af5b3343-7d91-46cf-a908-bf24e4e79907",
"installment_number": 25,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1992.35503921,
"original_pre_fixed_amount": 43.25979382,
"original_principal_amortization_amount": 146.74020618,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 43.25979382,
"principal_amortization_amount": 146.74020618,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.39193437,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 23
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-09-30",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-09-28",
"due_interest": 0.0,
"due_principal": 1845.61483303,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "1e7981d6-4274-49f1-ab6e-a98d97485e78",
"installment_number": 26,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1845.61483303,
"original_pre_fixed_amount": 40.07363891,
"original_principal_amortization_amount": 149.92636109,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 40.07363891,
"principal_amortization_amount": 149.92636109,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.48729599,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-10-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2025-10-28",
"due_interest": 0.0,
"due_principal": 1695.68847194,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "a07e171b-e2a6-49b4-9d6d-8124fff9d736",
"installment_number": 27,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1695.68847194,
"original_pre_fixed_amount": 35.61823023,
"original_principal_amortization_amount": 154.38176977,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 35.61823023,
"principal_amortization_amount": 154.38176977,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.62064637,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-12-01",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2025-11-28",
"due_interest": 0.0,
"due_principal": 1541.30670217,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "0cd84cc5-0dd0-4318-99f9-178843d3d5b5",
"installment_number": 28,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1541.30670217,
"original_pre_fixed_amount": 33.46622796,
"original_principal_amortization_amount": 156.53377204,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 33.46622796,
"principal_amortization_amount": 156.53377204,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.6850558,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 23
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2025-12-30",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2025-12-28",
"due_interest": 0.0,
"due_principal": 1384.77293013,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "24dc3c8b-ac3a-496e-8646-a1e66051090b",
"installment_number": 29,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1384.77293013,
"original_pre_fixed_amount": 29.08739451,
"original_principal_amortization_amount": 160.91260549,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 29.08739451,
"principal_amortization_amount": 160.91260549,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.81611428,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 19
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-01-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2026-01-28",
"due_interest": 0.0,
"due_principal": 1223.86032464,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "bba128ee-b195-4a65-9caf-3ebe452d9d10",
"installment_number": 30,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1223.86032464,
"original_pre_fixed_amount": 26.57354762,
"original_principal_amortization_amount": 163.42645238,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 26.57354762,
"principal_amortization_amount": 163.42645238,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.89135372,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-03-03",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2026-02-28",
"due_interest": 0.0,
"due_principal": 1060.43387227,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "35a03898-607a-4194-804c-bfd375c3ea45",
"installment_number": 31,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1060.43387227,
"original_pre_fixed_amount": 23.02508598,
"original_principal_amortization_amount": 166.97491402,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 23.02508598,
"principal_amortization_amount": 166.97491402,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 4.99755918,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-03-31",
"calendar_days": 28,
"digitable_line": null,
"due_date": "2026-03-28",
"due_interest": 0.0,
"due_principal": 893.45895824,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "0a8a83db-835d-46bc-8e24-c542c44d6e68",
"installment_number": 32,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 893.45895824,
"original_pre_fixed_amount": 17.50393379,
"original_principal_amortization_amount": 172.49606621,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 17.50393379,
"principal_amortization_amount": 172.49606621,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 5.16280726,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-04-29",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2026-04-28",
"due_interest": 0.0,
"due_principal": 720.96289203,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "07e3155c-30b5-4d13-8a31-0af4c7d5c9c5",
"installment_number": 33,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 720.96289203,
"original_pre_fixed_amount": 15.65418772,
"original_principal_amortization_amount": 174.34581228,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 15.65418772,
"principal_amortization_amount": 174.34581228,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 5.21817016,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-05-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2026-05-28",
"due_interest": 0.0,
"due_principal": 546.61707975,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "d1badc80-d7a2-4428-abf6-4877ac9f4497",
"installment_number": 34,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 546.61707975,
"original_pre_fixed_amount": 11.48178326,
"original_principal_amortization_amount": 178.51821674,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 11.48178326,
"principal_amortization_amount": 178.51821674,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 5.34305023,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-06-30",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2026-06-28",
"due_interest": 0.0,
"due_principal": 368.098863,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "4b466830-c432-4478-a1b9-bff6562834ee",
"installment_number": 35,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 368.098863,
"original_pre_fixed_amount": 7.99248758,
"original_principal_amortization_amount": 182.00751242,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 7.99248758,
"principal_amortization_amount": 182.00751242,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 5.44748485,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0.0,
"bank_slip_key": null,
"business_due_date": "2026-07-29",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2026-07-28",
"due_interest": 0.0,
"due_principal": 186.09135058,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "0e8843ff-1339-40ab-a0b5-c450eca68e44",
"installment_number": 36,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 186.09135058,
"original_pre_fixed_amount": 3.90887682,
"original_principal_amortization_amount": 186.09112318,
"original_total_amount": 190.0,
"paid_amount": 0.0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 3.90887682,
"principal_amortization_amount": 186.09112318,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 5.56970732,
"total_accrual_amount": null,
"total_amount": 190.0,
"total_paid_amount": 0.0,
"workdays": 22
}
],
"iof_charge_method": "financed",
"issue_amount": 4676.47,
"net_external_contract_fee_amount": 0.0,
"number_of_installments": 36,
"prefixed_interest_rate": {
"annual_rate": 0.28777498,
"created_at": "2023-07-07T18:13:42",
"daily_rate": 0.00069316,
"interest_base": "calendar_days_365",
"monthly_rate": 0.0213
},
"requester_identifier_key": "7d174b91-e411-4375-b788-9ced9b941cd0",
"total_iof": 145.49,
"total_pre_fixed_amount": 2163.53022742
},
"event_datetime": "2023-07-07 19:04:20",
"key": "7d174b91-e411-4375-b788-9ced9b941cd0",
"status": "waiting_signature",
"webhook_type": "debt"
}
10.2 - Mudança dos dados bancários:
Request
ENDPOINT
/debt/DEBT-KEY/disbursement_bank_accountsMETHOD
PUTRequest Body
{
"disbursement_bank_accounts": [{
"bank_code": "329",
"branch_number": "001",
"account_number": "6947216",
"account_digit": "4",
"account_type": "checking_account",
"document_number": "946321801",
"name": "Pedro Felipe Henrique Alves",
"percentage_receivable": 100
}]
}
Response
STATUS
200Response Body
{}
info
Quando uma operação é cancelada e pode ser reapresentada:
-
Caso a data de desembolso enviada seja ultrapassada ainda com pendências nas assinaturas do contrato;
-
Caso a averbação não seja concluída até a data de desembolso;
-
Caso exista algum problema com os dados bancários para o pagamento da operação;
11 - Cancelamento da operação
Permite a Instituição Fiduciária realizar, junto ao Agente Operador do FGTS, o cancelamento de uma reserva de valores de saque aniversário do Trabalhador utilizados como garantia para uma operação fiduciária
ATENÇÃO: A operação só poderá ser desaverbada se ela já tiver sido cancelada.
Request
ENDPOINT
/debt/[debt_key]/cancel_permanentlyMETHOD
/POSTPARAMETERS
debt_keyPayload
| Key | Value | Description |
|---|---|---|
| debt_key | 95ba572e-b8d2-43db-94b9-8c4a0405e3bc | Debt key da operação que esta sendo cancelada. |
Response
STATUS
200ENDPOINT
/debt/[debt_key]/cancel_permanentlyMETHOD
POSTRequest Body
{
"data": {
"additional_iof": 0.956498,
"annual_cet": 41.5826,
"assignment_amount": 251.71,
"base_iof": 5.38721386,
"borrower": {
"document_number": "0000000000",
"name": "Andre Luis Souto de Souza"
},
"cet": 2.94,
"collaterals": [{
"collateral_constituted": false,
"collateral_data": {
"document_number": "00000000000",
"error_message": "None",
"periods": [{
"amount": 116.48,
"due_date": "2023-04-01"
},
{
"amount": 81.53,
"due_date": "2024-04-01"
},
{
"amount": 57.07,
"due_date": "2025-04-01"
},
{
"amount": 39.95,
"due_date": "2026-04-01"
},
{
"amount": 37.29,
"due_date": "2027-04-01"
},
{
"amount": 27.96,
"due_date": "2028-04-01"
},
{
"amount": 13.99,
"due_date": "2029-04-01"
},
{
"amount": 6.99,
"due_date": "2030-04-01"
},
{
"amount": 3.49,
"due_date": "2031-04-01"
},
{
"amount": 3.6,
"due_date": "2032-04-01"
}
],
"protocol_number": null,
"reservation_request_closure_status": null,
"reservation_request_closure_status_translation": null,
"reservation_request_key": "11e904ad-1e7c-46c7-9e15-16d3650670bd",
"reservation_request_status": "pending",
"reservation_request_status_translation": "Em Teimosinha"
},
"collateral_key": "7686f240-329b-4ef5-8956-914c05cbd445",
"collateral_type": "fgts_balance",
"created_at": "2022-12-19T15:52:32",
"external_key": "11e904ad-1e7c-46c7-9e15-16d3650670bd",
"percentage": 1,
"updated_at": "2022-12-20T21:09:27.573223"
}],
"contract": {
"number": "0003296996/ALS-R",
"urls": [
"https://storage.googleapis.com/live-doc-api/documents/0e2d7181-799c-4134-af18-2a9ffb14da57/HUBCREDFINTECHLTDA-ANDRE_LUIS_SOUTO_DE_SOUZA-CCB-0003296996-20221219155233.pdf"
]
},
"contract_fee_amount": 2.46,
"contract_fees": [{
"fee_amount": 1.26,
"fee_type": "tac"
},
{
"fee_amount": 1.2,
"fee_type": "ted_fee"
}
],
"disbursed_issue_amount": 211.45,
"entry": null,
"external_contract_fee_amount": 31.46,
"external_contract_fees": [{
"description": null,
"fee_amount": 15.1,
"fee_type": "tac",
"net_fee_amount": 12.95,
"rebate_bank_account": {
"account_branch": "1",
"account_digit": "5",
"account_number": "1000398",
"created_at": "2022-12-19T15:52:32",
"document_number": "000000000000",
"financial_institutions": {
"code_number": 329,
"is_active": true,
"is_pix_participant": true,
"ispb": 32402502,
"name": "QI SCD S.A."
},
"financial_institutions_code_number": 329,
"name": "QI SOCIEDADE DE CREDITO DIRETO SA"
},
"tax_amount": 2.15
},
{
"description": null,
"fee_amount": 16.36,
"fee_type": "tac",
"net_fee_amount": 14.03,
"rebate_bank_account": {
"account_branch": "1",
"account_digit": "1",
"account_number": "1000418",
"created_at": "2022-12-19T15:52:32",
"document_number": "000000000000",
"financial_institutions": {
"code_number": 329,
"is_active": true,
"is_pix_participant": true,
"ispb": 32402502,
"name": "QI SCD S.A."
},
"financial_institutions_code_number": 329,
"name": "QI SOCIEDADE DE CREDITO DIRETO SA"
},
"tax_amount": 2.33
},
{
"description": null,
"fee_amount": 0,
"fee_type": "spread",
"net_fee_amount": 0,
"rebate_bank_account": null,
"tax_amount": 0
}
],
"installments": [{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2023-04-03",
"calendar_days": 103,
"digitable_line": null,
"due_date": "2023-04-01",
"due_interest": 0,
"due_principal": 251.71,
"fine_amount": null,
"has_interest": true,
"installment_key": "9badede6-9db0-45d9-9797-9b1459eb4a38",
"installment_number": 1,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 251.71,
"original_pre_fixed_amount": 16.57,
"original_principal_amortization_amount": 99.91,
"original_total_amount": 116.48,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 16.57,
"principal_amortization_amount": 99.91,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.84383986,
"total_accrual_amount": null,
"total_amount": 116.48,
"total_paid_amount": 0,
"workdays": 72
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2024-04-01",
"calendar_days": 366,
"digitable_line": null,
"due_date": "2024-04-01",
"due_interest": 0,
"due_principal": 151.8,
"fine_amount": null,
"has_interest": true,
"installment_key": "c3c86b8b-5af8-47de-a77a-ef8622955219",
"installment_number": 2,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 151.8,
"original_pre_fixed_amount": 38.58,
"original_principal_amortization_amount": 42.95,
"original_total_amount": 81.53,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 38.58,
"principal_amortization_amount": 42.95,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 1.2854935,
"total_accrual_amount": null,
"total_amount": 81.53,
"total_paid_amount": 0,
"workdays": 248
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2025-04-01",
"calendar_days": 365,
"digitable_line": null,
"due_date": "2025-04-01",
"due_interest": 0,
"due_principal": 108.85,
"fine_amount": null,
"has_interest": true,
"installment_key": "5c3aa86f-bb17-4e60-85d0-64cfc8082332",
"installment_number": 3,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 108.85,
"original_pre_fixed_amount": 27.58,
"original_principal_amortization_amount": 29.49,
"original_total_amount": 57.07,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 27.58,
"principal_amortization_amount": 29.49,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.8826357,
"total_accrual_amount": null,
"total_amount": 57.07,
"total_paid_amount": 0,
"workdays": 254
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2026-04-01",
"calendar_days": 365,
"digitable_line": null,
"due_date": "2026-04-01",
"due_interest": 0,
"due_principal": 79.36,
"fine_amount": null,
"has_interest": true,
"installment_key": "e3e01865-bd87-4934-bce4-52fcae82c30e",
"installment_number": 4,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 79.36,
"original_pre_fixed_amount": 20.11,
"original_principal_amortization_amount": 19.84,
"original_total_amount": 39.95,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 20.11,
"principal_amortization_amount": 19.84,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.5938112,
"total_accrual_amount": null,
"total_amount": 39.95,
"total_paid_amount": 0,
"workdays": 253
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2027-04-01",
"calendar_days": 365,
"digitable_line": null,
"due_date": "2027-04-01",
"due_interest": 0,
"due_principal": 59.52,
"fine_amount": null,
"has_interest": true,
"installment_key": "a0f2a23f-0766-4912-a0de-7b84c1df1c9e",
"installment_number": 5,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 59.52,
"original_pre_fixed_amount": 15.08,
"original_principal_amortization_amount": 22.21,
"original_total_amount": 37.29,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 15.08,
"principal_amortization_amount": 22.21,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.6647453,
"total_accrual_amount": null,
"total_amount": 37.29,
"total_paid_amount": 0,
"workdays": 249
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2028-04-03",
"calendar_days": 366,
"digitable_line": null,
"due_date": "2028-04-01",
"due_interest": 0,
"due_principal": 37.31,
"fine_amount": null,
"has_interest": true,
"installment_key": "a0916b23-c193-4a61-8850-1fbae73440d5",
"installment_number": 6,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 37.31,
"original_pre_fixed_amount": 9.48,
"original_principal_amortization_amount": 18.48,
"original_total_amount": 27.96,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 9.48,
"principal_amortization_amount": 18.48,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.5531064,
"total_accrual_amount": null,
"total_amount": 27.96,
"total_paid_amount": 0,
"workdays": 253
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2029-04-02",
"calendar_days": 365,
"digitable_line": null,
"due_date": "2029-04-01",
"due_interest": 0,
"due_principal": 18.83,
"fine_amount": null,
"has_interest": true,
"installment_key": "aeda565d-e743-408d-bbff-32374eadd02d",
"installment_number": 7,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 18.83,
"original_pre_fixed_amount": 4.77,
"original_principal_amortization_amount": 9.22,
"original_total_amount": 13.99,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 4.77,
"principal_amortization_amount": 9.22,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.2759546,
"total_accrual_amount": null,
"total_amount": 13.99,
"total_paid_amount": 0,
"workdays": 247
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2030-04-01",
"calendar_days": 365,
"digitable_line": null,
"due_date": "2030-04-01",
"due_interest": 0,
"due_principal": 9.61,
"fine_amount": null,
"has_interest": true,
"installment_key": "8a8dcf1a-40fb-4526-b7ab-ae133c12b388",
"installment_number": 8,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 9.61,
"original_pre_fixed_amount": 2.44,
"original_principal_amortization_amount": 4.55,
"original_total_amount": 6.99,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 2.44,
"principal_amortization_amount": 4.55,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.1361815,
"total_accrual_amount": null,
"total_amount": 6.99,
"total_paid_amount": 0,
"workdays": 251
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2031-04-01",
"calendar_days": 365,
"digitable_line": null,
"due_date": "2031-04-01",
"due_interest": 0,
"due_principal": 5.06,
"fine_amount": null,
"has_interest": true,
"installment_key": "10c9b5d0-0401-4e7c-b58e-635de70434c7",
"installment_number": 9,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 5.06,
"original_pre_fixed_amount": 1.28,
"original_principal_amortization_amount": 2.21,
"original_total_amount": 3.49,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 1.28,
"principal_amortization_amount": 2.21,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.0661453,
"total_accrual_amount": null,
"total_amount": 3.49,
"total_paid_amount": 0,
"workdays": 253
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2032-04-01",
"calendar_days": 366,
"digitable_line": null,
"due_date": "2032-04-01",
"due_interest": 0,
"due_principal": 2.85,
"fine_amount": null,
"has_interest": true,
"installment_key": "663f8109-cca3-469a-855a-4f0294fb77ba",
"installment_number": 10,
"installment_payment": [],
"installment_status": "canceled",
"installment_type": "principal",
"original_due_principal": 2.85,
"original_pre_fixed_amount": 0.75,
"original_principal_amortization_amount": 2.85,
"original_total_amount": 3.6,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": null,
"pre_fixed_amount": 0.75,
"principal_amortization_amount": 2.85,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.0853005,
"total_accrual_amount": null,
"total_amount": 3.6,
"total_paid_amount": 0,
"workdays": 253
}
],
"iof_charge_method": "financed",
"issue_amount": 251.71,
"net_external_contract_fee_amount": 26.98,
"number_of_installments": 10,
"prefixed_interest_rate": {
"annual_rate": 0.25340149,
"created_at": "2022-12-19T15:52:32",
"daily_rate": 0.00061899,
"interest_base": "calendar_days_365",
"monthly_rate": 0.019
},
"requester_identifier_key": "93a47fc5-5969-42ff-bdbb-3c9e8ec58d35",
"total_iof": 6.34,
"total_pre_fixed_amount": 136.64
},
"event_datetime": "2022-12-20 21:09:28",
"key": "93a47fc5-5969-42ff-bdbb-3c9e8ec58d35",
"status": "canceled_permanently",
"webhook_type": "debt"
}
Quando todas as reversões são executadas com sucesso, uma rotina é executada uma vez por dia, coletando o valor adequado e enviando para o fundo.
Response
STATUS
400ENDPOINT
/debt/[debt_key]/cancel_permanentlyMETHOD
POSTRequest Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Operation with status \{status\} cannot be cancelled.\", \"translation\": \"Essa operação com \{status\} não permite cancelamento.\", \"extra_fields\": {}, \"code\": \"COP000245\"}"
}
12 - Acompanhamento e mapeamento dos status das reservas
O objeto "last_response" traz os dados da última tentativa de reserva ou liberação (averbação ou desaverbação) realizada pela QI na Caixa.
O campo "last_response.success.enumerator" será retornado caso a reserva/liberação (averbação/desaverbação) tenha sido finalizada com sucesso.
O campo "last_response.errors.enumerator" traz a mensagem de erro retornada pela Caixa na última tentativa de reserva/liberação (averbação/desaverbação).
O campo "last_response_event_datetime" traz a data e horário da última tentativa de reserva/liberação (averbação/desaverbação)
12.1 - Casos de sucesso
Request
ENDPOINT
/debt/[debt_key]/collateralMETHOD
GETResponse
Response Body
{
"collateral_constituted": true,
"collateral_type": "fgts_balance",
"updated_at": "2023-05-24 19:13:02",
"collateral_data": {
"periods": [
{
"amount": 77.86,
"due_date": "2023-12-01"
},
{
"amount": 54.51,
"due_date": "2024-12-01"
},
{
"amount": 38.83,
"due_date": "2025-12-01"
},
{
"amount": 35.34,
"due_date": "2026-12-01"
}
],
"document_number": "73422975004",
"status": "waiting_protocol_activation",
"last_response": {
"success": [
{
"enumerator": "protocol_created"
}
]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z"
}
}
| Enumerador | Descrição | Ação da QI | Ação do cliente |
|---|---|---|---|
protocol_created | Protocolo criado com sucesso | Início da etapa de ativação de protocolo | Aguardar a ativação de protocolo |
successfully_reserved | Protocolo ativado com sucesso. Saldo está reservado | Envio do webhook de colateral constituído | Aguardar o cumprimento de todos os requsitos de desembolso e o pagamento da operação de crédito |
12.2 - Casos de erro
Request
ENDPOINT
/debt/[debt_key]/collateralMETHOD
GETResponse
Response Body
{
"collateral_constituted": false,
"collateral_type": "fgts_balance",
"updated_at": "2023-05-24 19:13:02",
"collateral_data": {
"periods": [
{
"amount": 77.86,
"due_date": "2023-12-01"
},
{
"amount": 54.51,
"due_date": "2024-12-01"
},
{
"amount": 38.83,
"due_date": "2025-12-01"
},
{
"amount": 35.34,
"due_date": "2026-12-01"
}
],
"document_number": "73422975004",
"status": "pending_protocol",
"last_response": {
"errors": [
{
"enumerator": "on_locked_date_range"
}
]
},
"last_response_event_datetime": "2023-05-22T19:13:02Z"
}
}
| Enumerador | Descrição | Ação da QI | Ação do Cliente |
|---|---|---|---|
unauthorized_institution | Instituição não autorizada pelo cliente | Cancelamento da operação, porém continuamos rententando a averbação | Orientar o cliente a realizar a autorização da "QI SOCIEDADE DE CREDITO S.A" para operar o Adiantamento do Saque Aniversário FGTS |
inexistent_anniversary_membership | Trabalhador não possui adesão ao saque aniversário na data vigente | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário orientar o cliente a aderir a modalidade de Saque Aniversário no aplicativo do FGTS |
on_locked_date_range | A Operação não é permitida na data atual | Retentativa de averbação apenas na data em que a operação passa a ser permitida | A operação é permitida no segundo dia útil do próximo mês. Como a operação fica travada até esse período, recomenda-se o envio cancelamento permanente e a devida comunicação com o cliente, visto que ele não conseguirá fazer a operação no momento em nenhuma outra instituição financeira |
insufficient_balance | Trabalhador não possui saldo disponível para a Operação Fiduciária | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Recomenda-se reduzir valor da operação ou cancelar a operação, caso o saldo seja zerado. |
processing_pending_changes | Operação não permitida por pendência no processo de pagamento de Saque Aniversário | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Orientar cliente a aguardar a regularização |
invalid_given_period | Uma ou mais datas de previsão do saque informadas não conferem com as datas previstas no sistema da Caixa ou os valores enviados para as parcelas são maiores do que o disponível | Recomenda-se reduzir valor da operação ou cancelar caso saldo seja zerado Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário a digitação de uma nova operação |
operation_in_process | Reserva pendente de protocolo | Retentativa de averbação do saldo do cliente | A Caixa tem uma rotina que destrava essas reservas a cada um ou dois dias. Sendo assim, é necessário orientar o cliente que a reserva está presa na Caixa e será liberada em breve |
not_found_operation | Status só é retornado para reservas em processo de desaverbação | Encaminhamos a reserva para nossa fila de deleção para garantir que não existe saldo do cliente bloqueado conosco, então mudamos o status da reserva para cancelado | Necessário a digitação de uma nova operação |
anniversary_membership_egress | Trabalhador com solicitação de retorno para saque rescisão | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Orientar cliente que ele solicitou o egresso da modalidade de Saque Aniversário, isso impede que ele faça o adiantamento de seus saques |
protocol_removed | Protocolo removido na CEF | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário a digitação de uma nova operação |
protocol_rejected | Protocolo recusado pela CEF | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário a digitação de uma nova operação |
protocol_in_process | Protocolo está em processamento na CEF | Retentativa de averbação do saldo do cliente | A Caixa tem uma rotina que destrava essas reservas a cada um ou dois dias. Sendo assim, é necessário orientar o cliente que a reserva está presa na Caixa e será liberada em breve |
timeout | A CEF retornou erro de timeout | Retentativa de averbação do saldo do cliente | Necessário acompanhar os próximos retornos da Caixa e aguardar a averbação do saldo do cliente. Esse erro é normal quando temos períodos de instabilidade na Caixa |
unexpected_error | A CEF retornou erro inesperado | Retentativa de averbação do saldo do cliente | Necessário acompanhar os próximos retornos da Caixa e aguardar a averbação do saldo do cliente. |
period_rejected | Período da reserva recusado pela CEF | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário a digitação de uma nova operação para que sejam enviados períodos atualizados |
deletion_request | A solicitação de desaverbação foi realizada antes da conclusão da reserva | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário a digitação de uma nova operação para que seja feito uma nova tentativa de averbação |
rate_limit_exceeded | Número máximo de requisições por segundo na CEF foi excedido | Retentativa de averbação do saldo do cliente | Acompanhar os próximos retornos da Caixa e aguardar a averbação do saldo do cliente |
misformatted_error | A CEF retornou um erro mal formatado | Retentativa de averbação do saldo do cliente | Acompanhar os próximos retornos da Caixa e aguardar a averbação do saldo do cliente |
unlisted_error | A CEF retornou um erro que não está listado | Retentativa de averbação do saldo do cliente | Acompanhar os próximos retornos da Caixa e aguardar a averbação do saldo do cliente |
registration_changes_or_debit_transactions | Foram feitas alterações cadastrais ou movimentações de débito na conta do FGTS, impossibilitando o processo de contratação. | Retentativa de averbação do saldo do cliente | Necessário a reapresentação da operação, após a regularização das pendências, se ainda houver opções de desembolso |
fgts_accounts_not_found | O trabalhador informado não tem contas do FGTS | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Necessário a digitação de uma nova operação para que seja feito uma nova tentativa de averbação, assim que o processo de pagamento pendente for resolvido |
inexistent_anniversary_membership_on_period | A CEF retornou um erro que não está listado | Retentativa de averbação do saldo do cliente | Acompanhar os próximos retornos da Caixa e aguardar a averbação do saldo do cliente |
insufficient_balance_available | O valor indicado não está disponível para contratação | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Recomenda-se reduzir o valor da operação para fazer uma nova tentativa, se houver saldo disponível. Ou cancelar a operação, redigitando a operação para conseguir um saldo atualizado. |
insufficient_balance_for_guarantee | O saldo disponível não é suficiente para a garantia requerida | Cancelamento da operação, saldo do cliente não é averbado (retirada da nossa fila de retentativas) | Recomenda-se reduzir o valor da operação para fazer uma nova tentativa, se houver saldo disponível. Ou cancelar a operação, redigitando a operação para conseguir um saldo atualizado. |