# QI Tech — Crédito Consignado Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 59 página(s). Índice: - Consulta Offline de Saldo (/documentation/guides/INSS/inquiries/offline-balance-request) - Mocks (Sandbox) (/documentation/guides/INSS/mocks-sandbox) - Novo e Refin Puro (/documentation/guides/INSS/new-credit-and-refinancing/end-to-end) - Recálculo (/documentation/guides/INSS/new-credit-and-refinancing/recalculate) - Anuência (pending confirmation) (/documentation/guides/INSS/pending_confirmation) - Alterando o Cessionário (/documentation/guides/INSS/portability+refinancing/alterando-cessionario) - Consultas e Enumeradores (/documentation/guides/INSS/portability+refinancing/consultas-e-enumeradores) - Portabilidade + Refin (/documentation/guides/INSS/portability+refinancing/end-to-end) - Máquinas de Status (/documentation/guides/INSS/portability+refinancing/maquinas-de-status) - Recálculo e Reformalização do Refinanciamento (/documentation/guides/INSS/portability+refinancing/reformalization) - Fura-fila (priority request) (/documentation/guides/INSS/reservations/priority-request) - Fila prioritária (/documentation/guides/INSS/reservations/priority-reservation) - Assinatura em grupo (INSS) (/documentation/guides/INSS/signatures/batch-group-signature) - Manual Consignado Privado - Formalização Externa (/documentation/manual_consignado_privado/manual_assinatura_externa) - Manual Consignado Privado - Acompanhamento da Operação de crédito (/documentation/manual_consignado_privado/manual_assinatura_leilao) - Manual Consignado Privado - Averbação e Desembolso (/documentation/manual_consignado_privado/manual_averbacao_desembolso) - Manual Consignado Privado - Configuração dos Filtros de Recebimento de Propostas de Leilão (/documentation/manual_consignado_privado/manual_configuracao_filtros) - Manual Consignado Privado - Consulta de Escriturações (/documentation/manual_consignado_privado/manual_consultas_conciliacao) - Manual Consignado Privado - Consultas do Trabalhador (/documentation/manual_consignado_privado/manual_consultas_trabalhador) - Manual Consignado Privado - Crédito Novo (/documentation/manual_consignado_privado/manual_credito_novo) - Manual Consignado Privado - Fluxo Ativo de Emissão (/documentation/manual_consignado_privado/manual_detalhamento_fluxo_ativo) - Manual Consignado Privado - Fluxo de Emissão Via Leilão (/documentation/manual_consignado_privado/manual_detalhamento_fluxo_leilao) - Manual Consignado Privado - Leilão Interno (/documentation/manual_consignado_privado/manual_leilao_interno) - Manual Consignado Privado - Refinanciamento (/documentation/manual_consignado_privado/manual_refinanciamento) - Manual Consignado Privado – Averbação e revínculo (/documentation/manual_consignado_privado/manual_vinculos_empregaticios) - Manual Consignado Privado - Portabilidade: Consultas Prévias (/documentation/manual_consignado_privado/portabilidade/consultas) - Manual Consignado Privado - Portabilidade: Consultas e Operações Pós-Proposta (/documentation/manual_consignado_privado/portabilidade/consultas_pos_proposta) - Manual Consignado Privado - Portabilidade: Enumeradores (/documentation/manual_consignado_privado/portabilidade/enumeradores) - Manual Consignado Privado - Portabilidade: Formalização (/documentation/manual_consignado_privado/portabilidade/formalizacao) - Manual Consignado Privado - Portabilidade: Acompanhamento da Operação (/documentation/manual_consignado_privado/portabilidade/maquina_de_status) - Manual Consignado Privado - Portabilidade: Mocks e Sandbox (/documentation/manual_consignado_privado/portabilidade/mocks_sandbox) - Manual Consignado Privado - Portabilidade: Digitação da Proposta (/documentation/manual_consignado_privado/portabilidade/proposta) - Manual Consignado Privado - Portabilidade: Simulação (/documentation/manual_consignado_privado/portabilidade/simulacao) - Manual Consignado Privado - Portabilidade + Refinanciamento (/documentation/manual_consignado_privado/portabilidade/visao_geral) - Assinatura em Lote (/documentation/manual_exercito/assinatura-em-lote) - Cancelamento, Desaverbação e Reversal (/documentation/manual_exercito/cancelamento) - Consulta de Margem Consignável (/documentation/manual_exercito/consulta-margem) - Conta Interna para Desembolso (/documentation/manual_exercito/conta-interna-desembolso) - Modelos de Formalização (/documentation/manual_exercito/formalizacao) - Consignado do Exército — Introdução (/documentation/manual_exercito/introducao) - Mapa de Status (/documentation/manual_exercito/mapa-de-status) - Margem Livre (Crédito Novo) (/documentation/manual_exercito/margem-livre) - Mocks (Sandbox) (/documentation/manual_exercito/mocks-sandbox) - Portabilidade + Refinanciamento (/documentation/manual_exercito/portabilidade-refin) - Webhooks (/documentation/manual_exercito/webhooks) - Manual Previdência Privada - Averbação e Desembolso (/documentation/manual_previdencia_privada/manual_previdencia_privada_averbacao_desembolso) - Manual Previdência Privada - Consulta (/documentation/manual_previdencia_privada/manual_previdencia_privada_consulta) - Manual Previdência Privada - Crédito Novo (/documentation/manual_previdencia_privada/manual_previdencia_privada_credito_novo) - Assinatura em Lote (/documentation/siape/assinatura-em-lote) - Cancelamento, Desaverbação e Reversal (SIAPE) (/documentation/siape/cancelamento) - Consulta de Margem Consignável (SIAPE) (/documentation/siape/consulta-margem) - Conta Interna para Desembolso (/documentation/siape/conta-interna-desembolso) - Modelos de Formalização (SIAPE) (/documentation/siape/formalizacao) - SIAPE-SIGEPE — Introdução (/documentation/siape/introducao) - Mapa de Status (/documentation/siape/mapa-de-status) - Margem Livre (Crédito Novo) (/documentation/siape/margem-livre) - Mocks (Sandbox) (/documentation/siape/mocks-sandbox) - Portabilidade + Refinanciamento (/documentation/siape/portabilidade-refin) - Webhooks (/documentation/siape/webhooks) --- # Consulta Offline de Saldo URL: /documentation/guides/INSS/inquiries/offline-balance-request Consulta Offline de Saldo Consulta os dados de saldo mais recentes salvos no nosso banco, de forma instantânea. :::tip Vantagens Técnicas - **Retorno síncrono** — sem fila de processamento ou espera por webhook; - **Acesso a benefícios bloqueados** — retorna os últimos dados salvos no sistema, mesmo que o benefício esteja bloqueado; - **Consulta em cache** — independe da disponibilidade da Dataprev e não gera consumo de chamadas. ::: Request ENDPOINT /social_security/balance_request/offline MÉTODO GET Query Params document_number string obrigatório CPF do beneficiário (apenas números, 11 dígitos). benefit_number string obrigatório Número do benefício INSS. **Python** ```python title="ENDPOINT" GET /social_security/balance_request/offline?document_number=14950479032&benefit_number=22255220 ``` **curl** ```bash title="ENDPOINT" curl -X GET \ 'https://api-auth.sandbox.qitech.app/social_security/balance_request/offline?document_number=14950479032&benefit_number=22255220' \ -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \ -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \ -H 'Content-Type: application/json' ``` Response STATUS 200 Atributos last_successful_balance_request object | null Última consulta bem-sucedida. `null` se nunca houve sucesso. **Atributos de last_successful_balance_request** consulted_at string Data e hora da consulta (ISO 8601). data object Dados completos de saldo do benefício. Mesma estrutura do [webhook de consulta de saldo](/documentation/roteiros_laas/webhooks_inss). Veja [detalhamento dos campos](#campos-de-data). **Atributos de data** name string Nome do beneficiário. document_number string CPF do beneficiário. benefit_number string Status do benefício (`elegible`, `inelegible`). block_type string Tipo de bloqueio (`not_blocked`, `blocked_by_tbm`, etc.). benefit_situation string Situação do benefício (`active`, `inactive`, etc.). assistance_type string Tipo de assistência/aposentadoria. available_total_balance number Margem total disponível para consignação. consigned_credit object Saldo de crédito consignado (`balance`). payroll_card object Cartão consignado (`balance`, `limit`). benefit_card object Cartão benefício (`balance`, `limit`). number_of_active_reservations integer Número de reservas ativas. disbursement_bank_account object Dados da conta bancária de desembolso (`bank_code`, `account_digit`, `account_branch`, `account_number`). last_blocked_status object | null Status de bloqueio mais recente. `null` se não há informação disponível. Derivado automaticamente da fonte **mais recente** — seja consulta de saldo, tentativa de reserva ou verificação do benefício. **Atributos de last_blocked_status** consulted_at string Data e hora da verificação mais recente (ISO 8601). status string `"blocked"` ou `"unblocked"`. :::info Ao menos um dos dois campos será preenchido em uma resposta 200. Caso não exista nenhum dado para a combinação informada, o endpoint retorna 404. ::: ```json title="RESPONSE BODY" { "last_successful_balance_request": { "consulted_at": "2025-01-15T14:32:10-03:00", "data": { "name": "NOME BENEFICIARIO", "state": "RS", "alimony": "not_payer", "birth_date": "18021978", "block_type": "not_blocked", "grant_date": "2006-05-22", "credit_type": "checking_account", "benefit_card": { "limit": 2259.20, "balance": 0 }, "benefit_number": "22255220", "benefit_status": "elegible", "payroll_card": { "limit": 2259.20, "balance": 0 }, "assistance_type": "retirement_invalidity_social_security", "document_number": "14950479032", "benefit_end_date": null, "consigned_credit": { "balance": 0 }, "benefit_situation": "active", "last_inquiry_date": "2018-06-18", "max_total_balance": 635.40, "used_total_balance": 635.40, "politically_exposed": { "type": "not_politically_exposed", "is_politically_exposed": false }, "has_power_of_attorney": false, "available_total_balance": 0, "has_judicial_concession": false, "number_of_portabilities": 0, "disbursement_bank_account": { "bank_code": "748", "account_digit": "4", "account_branch": "0155", "account_number": "000070963" }, "has_entity_representation": false, "social_benefit_max_balance": 635.40, "social_benefit_used_balance": 635.40, "benefit_quota_expiration_date": null, "number_of_active_reservations": 3, "number_of_suspended_reservations": 0, "number_of_refinanced_reservations": 0, "number_of_active_suspended_reservations": 3 } }, "last_blocked_status": { "consulted_at": "2025-01-15T14:32:10-03:00", "status": "unblocked" } } ``` ### Cenários de resposta | Cenário | `last_successful_balance_request` | `last_blocked_status.status` | |---------|-----------------------------------|------------------------------| | Apenas consultas com sucesso | Dados da última consulta | `"unblocked"` | | Apenas consultas com bloqueio | `null` | `"blocked"` | | Consulta com sucesso seguida de bloqueio posterior | Dados da última consulta | `"blocked"` | | Bloqueio seguido de consulta com sucesso | Dados da última consulta | `"unblocked"` | --- ## Erros | Código HTTP | Código QI | Descrição | |-------------|-----------|-----------| | 401/403 | (padrão) | Headers de autenticação ausentes ou inválidos | | 404 | `SSC000101` | Nenhum dado encontrado para a combinação de `document_number` + `benefit_number` | **Exemplo de resposta 404** ```json { "title": "Offline Balance Not Found", "description": "No balance data found for document_number {document_number} and benefit_number {benefit_number}.", "translation": "Nenhum dado de saldo encontrado para document_number {document_number} e benefit_number {benefit_number}", "code": "SSC000101" } ``` --- # Mocks (Sandbox) URL: /documentation/guides/INSS/mocks-sandbox Mocks (Sandbox) :::danger Aviso Importante! Não utilize dados pessoais reais (CPF, CNPJ etc.) em ambiente sandbox. ::: A `social-security-api` intercepta as chamadas à Dataprev em ambiente sandbox/dev e retorna respostas mockadas via [`dataprev_mocker.py`](https://gitlab.qitech.com.br/qilaas/social-security-api/-/blob/master/src/connectors/dataprev_mocker.py). Cada etapa da jornada tem sua própria chave de simulação: | Etapa | O que decide o cenário | |---|---| | [Consulta de saldo/margem](#consulta-de-saldo) | CPF — match exato ou **primeiro dígito** | | [Averbação da reserva](#averbacao) | **Primeiro dígito** do CPF | | [Anuência (`pending_confirmation`)](#anuencia) | **Último dígito** do número do benefício | :::tip Jornada completa em sandbox Para que a operação percorra a jornada inteira até o desembolso, o CPF e o número do benefício precisam cair, ao mesmo tempo, num cenário de sucesso de **saldo**, de **averbação** e de **anuência**. Combinação recomendada: CPF iniciado em `1` e benefício terminado em `0`. ::: ## Consulta de saldo {#consulta-de-saldo} A consulta de saldo/margem (`DataprevMocker.get_balance_mocker`) resolve o `document_number` em duas etapas: 1. Tenta um **match exato** do CPF contra a massa de teste. 2. Se não encontrar, usa o **primeiro dígito** do CPF como chave. Se nenhuma das duas resolver, retorna o erro fixo: ```json { "erros": [ { "codigo": "QIE", "mensagem": "CPF divergente da massa de teste informada na documentação." } ] } ``` com HTTP `412`. ### Cenários por primeiro dígito (fallback) Qualquer CPF de teste cujo primeiro dígito seja um dos abaixo cai num destes cenários genéricos — útil quando você não precisa de um CPF fixo: | 1º dígito | Cenário | `margemDisponivel` | Status | |---|---|---|---| | `1` | Margem completa, elegível, sem bloqueios | 431.3 | 200 | | `2` | Erro Dataprev `D1` — dados do benefício incompletos/inconsistentes/nulos | — | 412 | | `3` | Margem de cartão/RCC reduzida (R$ 75,90) | 431.3 | 200 | | `4` | Margem completa (idêntico ao dígito `1`) | 431.3 | 200 | | `8` | Margem de cartão/RCC zerada | 431.3 | 200 | CPFs com primeiro dígito `0`, `5`, `6`, `7` ou `9` (e que não tenham match exato) caem no erro `QIE` acima. Além desses, o mocker reconhece 42 CPFs com match exato — a tabela completa está abaixo. ### CPFs com match exato Campos já mapeados para o schema público da QI: `consigned_credit.balance` vem de `margemDisponivel`, `available_total_balance` vem de `valorDisponivelAverbacaoEmprestimo`. Boa parte dos CPFs com `retirement_invalidity_work_accident` existe só pra cobrir uma faixa de valores de `available_total_balance` (de R$ 50 a R$ 900) — útil pra testar simulação de dívida contra um teto de margem específico. | CPF | Benefício (código) | Elegível | Situação | Bloqueio | `consigned_credit.balance` | `available_total_balance` | Status | |---|---|---|---|---|---|---|---| | `18166261553` | retirement_by_contribution_time (42) — **margem negativa** | Sim | ATIVO | - | **-7.84** | **-7.84** | 200 | | `30449750345` | pension_by_death_statute (22) | Não | INATIVO | Bloqueado por TBM | 1000 | 0 | 200 | | `58992386400` | pension_by_death_statute (22) | Não | ATIVO | Bloqueado por TBM | 1000 | 0 | 200 | | `15588881010` | retirement_capin_extra_emploee (37) | Sim | ATIVO | - | 1000 | 200 | 200 | | `80436724154` | retirement_invalidity_work_accident (92) | Não | INATIVO | Bloqueado por TBM | 1000 | 5000 | 200 | | `34166302540` | pension_by_death_federal_emploee (27) | Não | ATIVO | Bloqueado por TBM | 1000 | 5000 | 200 | | `71020884851` | pension_by_death_diplomat (20) | Não | ATIVO | Bloqueado por TBM | 1000 | 5000 | 200 | | `76241089684` | retirement_invalidity_work_accident (92) | Não | ATIVO | Bloqueado por TBM | 1000 | 5000 | 200 | | `44559483922` | pension_by_death (21) | Não | ATIVO | Bloqueado por TBM | 1000 | 5000 | 200 | | `14429281238` | pension_by_death_statute (22) | Sim | ATIVO | - | 1000 | 300 | 200 | | `15843101037` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 2000 | 200 | | `13686315092` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 2000 | 200 | | `14937159097` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 50 | 200 | | `15986213009` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 1000 | 200 | | `17427272048` | retirement_by_age (41) | Sim | ATIVO | - | 1000 | 1600 | 200 | | `16110575070` | retirement_by_age (41) | Sim | ATIVO | - | 1000 | 2000 | 200 | | `14996024054` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 100 | 200 | | `17702273003` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 150 | 200 | | `12228342009` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 200 | 200 | | `11709160071` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 250 | 200 | | `12452312002` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 300 | 200 | | `10650137019` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 350 | 200 | | `17287554097` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 400 | 200 | | `19815793039` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 450 | 200 | | `11985375079` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 500 | 200 | | `14732376029` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 750 | 200 | | `10178596043` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 600 | 200 | | `17859801060` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 650 | 200 | | `11524380857` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 700 | 200 | | `19447847056` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 800 | 200 | | `10813389038` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 850 | 200 | | `35776131499` | retirement_invalidity_work_accident (92) | Sim | ATIVO | - | 1000 | 900 | 200 | | `17283313079` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 300 | 200 | | `14552515004` | retirement_by_age (41) | Sim | ATIVO | - | 1000 | 300 | 200 | | `14036419005` | retirement_invalidity_social_security (32) | Sim | ATIVO | - | 1000 | 300 | 200 | | `13423241020` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 200 | 200 | | `12382929090` | retirement_special (46) | Sim | ATIVO | - | 1000 | 200 | 200 | | `73527133011` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 300 | 200 | | `55111830081` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 300 | 200 | | `83995332030` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 300 | 200 | | `65954790019` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 300 | 200 | | `16257311080` | retirement_by_contribution_time (42) | Sim | ATIVO | - | 1000 | 300 | 200 | Todos os CPFs acima retornam `bloqueadoParaEmprestimo: false`, exceto os marcados com "Bloqueado por TBM" na coluna Bloqueio (que ainda assim respondem HTTP 200 com `elegivelEmprestimo: false`). **Exemplo de requisição** (funciona com qualquer CPF da tabela): ENDPOINT /social_security/balance_request/synchronous MÉTODO POST ```python title="ENDPOINT" POST /social_security/balance_request/synchronous { "document_number": "18166261553", "benefit_number": "2052711150" } ``` Resposta (HTTP 200) para o CPF de margem negativa, já mapeada para o schema público: ```json { "assistance_type": "retirement_by_contribution_time", "available_total_balance": -7.84, "consigned_credit": { "balance": -7.84 }, "payroll_card": { "balance": 0, "limit": 2083.2 }, "benefit_card": { "balance": 0, "limit": 2083.2 }, "block_type": "not_blocked", "benefit_situation": "active" } ``` ## Averbação {#averbacao} O envio da reserva à Dataprev (`DataprevMocker.send_reserve_balance`) é resolvido **apenas pelo primeiro dígito do CPF** — o número do benefício não influencia esta etapa: | 1º dígito do CPF | Retorno mockado | Status | |---|---|---| | `1` | Sucesso `BZ` — "Averbação registrada" | 200 | | `2` | Erro `AN` — "Conta corrente/DV do favorecido inválidos" | 412 | | `3` | Depende do valor da operação: até R$ 1.000,00 sucesso `BZ`; acima disso, erro `HW` — "Margem consignável excedida" | 200 / 412 | | `4` | Sucesso `BZ` — "Averbação registrada" | 200 | Qualquer outro primeiro dígito retorna o erro `QIE` ("CPF divergente da massa de teste informada na documentação"), com HTTP `412`. :::note Averbação bem-sucedida **não** conclui a reserva: em crédito novo e refinanciamento ela entra em [anuência](#anuencia). Portabilidade não exige anuência e segue direto para `reserved`. ::: ## Anuência {#anuencia} Depois da averbação, crédito novo e refinanciamento ficam em `pending_confirmation` até a Dataprev informar a confirmação do beneficiário — veja [Anuência (pending confirmation)](/documentation/guides/INSS/pending_confirmation) para o fluxo e os webhooks. Em sandbox, a resposta dessa consulta é determinada pelo **último dígito do número do benefício** informado na reserva: | Último dígito do benefício | Situação Dataprev simulada | Desfecho da reserva | |---|---|---| | `0`, `1`, `6` | 0 — Ativo | ✅ Confirmada → `reserved`, webhook de averbação e desembolso | | `5` | 5 — Averbação programada | ✅ Confirmada → `reserved` | | `3` | 18 na 1ª página, 0 na 2ª | ✅ Confirmada → `reserved` (exercita a paginação) | | `8` | 18 — Pendente de confirmação | ⏳ Permanece em `pending_confirmation` | | `9` | 19 — Não confirmado pelo beneficiário | ❌ Cancelada — `social_security_confirmation_denied_by_beneficiary` | | `7` | 20 — Confirmação expirada | ❌ Nova tentativa de reserva ou cancelamento — `social_security_confirmation_expired` | | `2` | Resposta sem registros | ⏳ Permanece em `pending_confirmation` | | `4` | Erro `GR` — "O período está inválido" | ⏳ Permanece em `pending_confirmation` | :::warning Benefícios terminados em `2` e `4` Nesses dois cenários a consulta nunca devolve uma situação conclusiva, então a reserva fica em `pending_confirmation` indefinidamente e os webhooks de averbação e de pagamento não são emitidos. Se o objetivo é testar a jornada completa, use um benefício terminado em `0`, `1`, `3`, `5` ou `6`. ::: ## Referências - [`dataprev_mocker.py`](https://gitlab.qitech.com.br/qilaas/social-security-api/-/blob/master/src/connectors/dataprev_mocker.py) — massa de teste completa - [Consulta Offline de Saldo](/documentation/guides/INSS/inquiries/offline-balance-request) — schema de resposta completo --- # Novo e Refin Puro URL: /documentation/guides/INSS/new-credit-and-refinancing/end-to-end Fluxo Completo - Crédito Novo e Refinanciamento Puro :::danger 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. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: :::info Duração de Termo de Autorização O termo de autorização tem validade de 30 dias após a assinatura. Durante o periodo hábil, é possível consultar os dados do benefício sem reenviar autorização do cliente. ::: ## 1 - Consulta da lista de benefícios com formalização do Termo de Autorização realizada através do parceiro: ### Request Caso 1: Titular do benefício é o assinante do Termo de Autorização. ENDPOINT /social_security/benefits_request MÉTODO POST Testar no Playground Request Body ```json { "document_number": "14950479032", "authorization_term": { "document_number": "14950479032", "signature": { "signer": { "name": "Maria da Silva", "email": "maria.silva@email.com", "phone": { "number": "999538380", "area_code": "11", "country_code": "55" }, "document_number": "87237271016" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2024-11-07T14:28:23.382748Z", "ip_address": "179.145.48.219", "fingerprint": {}, "third_party_additional_data": {}, "session_id": "3571e292-3a83-4011-904d-20ee963022ef" }, "signed_object": { "document_key": "93a0f18b-f58f-4a22-ab63-2b796cbf7383" } } } } ``` Caso 2: Titular do benefício não é o assinante do Termo de Autorização (com representante legal). ENDPOINT /social_security/benefits_request MÉTODO POST Request Body ```json { "document_number": "14950479032", "authorization_term": { "document_number": "14950479032", "legal_representative_document_number": "87237271016", "signature": { "signer": { "name": "Maria da Silva", "email": "maria.silva@email.com", "phone": { "number": "999538380", "area_code": "11", "country_code": "55" }, "document_number": "87237271016" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2024-11-07T14:28:23.382748Z", "ip_address": "179.145.48.219", "fingerprint": {}, "third_party_additional_data": {}, "session_id": "3571e292-3a83-4011-904d-20ee963022ef" }, "signed_object": { "document_key": "93a0f18b-f58f-4a22-ab63-2b796cbf7383" } } } } ``` :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: --- "***document_key***": utilizar a GUID retornada no endpoint /upload Ao invés da chave do documento pdf assinado no objeto "authorization_term.signed_object.document_key", também é possível enviar o texto corrido do Termo de Autorização, através do objeto "authorization_term.signed_object.raw_text". ### Response ENDPOINT /social_security/benefits_request MÉTODO POST Response Body ```json { "benefits_request_key": "\", "status": "pending_search" } ``` Em caso de sucesso na consulta da lista de benefícios: ### Webhooks WEBHOOK_TYPE social_security_benefits_request STATUS Success Webhook Body ```json { "webhook_type": "social_security_benefits_request", "key": "\", "event_datetime": "\", "status": "success", "data": [{ "benefit_number": "\", "benefit_status": "inelegible", "grant_date": "2023-06-13" }] } ``` | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | benefit_status | Status do beneficio | [Enumeradores](#benefit_status_enumerator) | Em caso de falha na consulta da lista de benefícios WEBHOOK_TYPE social_security_benefits_request STATUS Failure Webhook Body ```json { "webhook_type": "social_security_benefits_request", "key": "\", "event_datetime": "\", "status": "failure", "data": { "enumerator": "not_found_legal_representative", "description": "no legal representative for the beneficiary" } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_benefits_errors_enumerators) | ### Simulando cenários de sucesso e insucesso na consulta de benefício em Sandbox: A simulação de cenários é baseado no primeiro dígito do CPF informado na operação. **11.1.** Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook. **11.2.** Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo. | Início do CPF | Enumerador | Descrição | |---------------|------------------------|----------------------| | 2 | inexistent_beneficiary | no beneficiary found | :::caution Atenção Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado. | Enumerador | Descrição | |---------------|------------------------------------------------------------------| | mock_error | Informed document number is not a valid mock on test environment | ::: --- ## 2 - Consulta de dados do benefício: {#consulta-de-dados} ### Caso 1 Consulta de dados do benefício com o Termo de Autorização previamente enviado. #### Request ENDPOINT /social_security/balance_request MÉTODO POST Testar no Playground Request Body ```json { "document_number": "14950479032", "benefit_number": "22255220" } ``` #### Response ENDPOINT /social_security/balance_request MÉTODO POST Response Body ```json { "balance_request_key": "\", "status": "pending_search" } ``` ### Caso 2 Consulta de dados do benefício com envio do Termo de Autorização. #### Request ENDPOINT /social_security/balance_request MÉTODO POST Request Body ```json { "document_number": "14950479032", "benefit_number": "22255220", "authorization_term": { "document_number": "14950479032", "legal_representative_document_number": "87237271016", "signature": { "signer": { "name": "Maria da Silva", "email": "maria.silva@email.com", "phone": { "number": "999538380", "area_code": "11", "country_code": "55" }, "document_number": "87237271016" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2024-11-07T14:28:23.382748Z", "ip_address": "179.145.48.219", "fingerprint": {}, "third_party_additional_data": {}, "session_id": "3571e292-3a83-4011-904d-20ee963022ef" }, "signed_object": { "document_key": "93a0f18b-f58f-4a22-ab63-2b796cbf7383" } } } } ``` :::info Duração de Termo de Autorização O termo de autorização tem validade de 30 dias após a assinatura. Durante o periodo hábil, é possível consultar os dados do benefício sem reenviar autorização do cliente. Caso não tenha sido enviada a autorização, é necessário enviar o termo durante esta requisição. ::: :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: --- #### Response ENDPOINT /social_security/balance_request MÉTODO POST Response Body ```json { "balance_request_key": "\", "status": "pending_authorization" } ``` ### Webhook de sucesso Em caso de sucesso na consulta de dados do benefício WEBHOOK_TYPE social_security_balance_request STATUS Success Webhook Body ```json { "webhook_type": "social_security_balance_request", "key": "\", "event_datetime": "\", "status": "success", "data": { "name": "IVOLANDO MIRANDA", "state": "SP", "alimony": "not_payer", "birth_date": "07021961", "grant_date": "2022-09-02", "credit_type": "checking_account", "block_type": "not_blocked", "benefit_card": { "limit": 2083.2, "balance": 0 }, "benefit_number": "22255220", "benefit_status": "elegible", "payroll_card": { "limit": 2083.2, "balance": 0 }, "assistance_type": "retirement_by_age", "document_number": "14950479032", "benefit_end_date": "2020-12-01", "consigned_credit": { "balance": 1000 }, "benefit_situation": "active", "max_total_balance": 2000, "used_total_balance": 1000, "politically_exposed": { "type": "politically_exposed_level_1", "is_politically_exposed": true }, "has_power_of_attorney": false, "available_total_balance": 1000, "has_judicial_concession": false, "number_of_portabilities": 0, "disbursement_bank_account": { "bank_code": "341", "account_digit": "6", "account_branch": "0155", "account_number": "000059923" }, "has_entity_representation": false, "social_benefit_max_balance": 2000, "social_benefit_used_balance": 1000, "benefit_quota_expiration_date": null, "number_of_active_reservations": 0, "number_of_suspended_reservations": 0, "number_of_refinanced_reservations": 0, "number_of_active_suspended_reservations": 3 } } ``` #### Detalhamento de campos no webhook de sucesso | Campo | Descrição | Valores | |---------------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| | assistance_type | Tipo do benefício | [Enumeradores](#benefit_type_enumerator) | | benefit_status | Status do beneficio | [Enumeradores](#benefit_status_enumerator) | | has_entity_representation | Possui entidade de representação (não permite averbação) | True ou False | | alimony_code | Classificador da Pensão alimentícia | not_payer, payer, benefit | | has_judicial_concession | Benefício concedido por liminar | True ou False | | has_power_of_attorney | Possui procurador? | True ou False | | credit_type | Tipo de crédito - recebimento do benefício | Magnetic_card, checking_account | | benefit_situation | Situação do benefício | [Enumeradores](#benefit_situation_enumerator) | | used_total_balance | Valor total comprometido em averbações de empréstimos, reservado para portabilidade, refinanciamento, alterações, RMC e RCC | Numérico | | max_total_balance | Valor comprometido possível para a respectiva espécie do benefício | Numérico | | available_total_balance | Valor total disponível para empréstimo, somando todas as modalidades (diferença entre max_total_balance e used_total_balance) | Numérico | | benefit_quota_expiration_date | Data de extinção do benefício. A informação está disponível apenas para alguns benefícios de pensão por morte. | String ou nulo | block_type | Tipo de bloqueio do benefício | [Enumeradores](#block_type_enumerator) | politically_exposed.type | Pessoa politicamente exposta | [Enumeradores](#politically_exposed_enumerator) | is_politically_exposed | Pessoa politicamente exposta | True ou False ### Webhook de bloqueio Para os casos que o benefício está bloqueado WEBHOOK_TYPE social_security_balance_request STATUS Blocked Webhook Body ```json { "webhook_type": "social_security_balance_request", "key": "\", "event_datetime": "\", "status": "blocked", "data": { "benefit_blocked": true, "document_number": "12345678910", "balance_request_date": "2025-12-01", "block_date": "2025-11-17", "assistance_type": "retirement_by_age", "block_type": "blocked_by_benefitiary" } } ``` #### Detalhamento de campos no webhook de bloqueio | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | benefit_blocked | Status do bloqueio | True | | balance_request_date | Data da consulta | String | | block_date | Data do bloqueio | String ou nulo | | block_type | Tipo de bloqueio | [Enumeradores](#block_type_enumerator) | ### Webhook de falha Em caso de falha na consulta da lista de benefícios WEBHOOK_TYPE social_security_balance_request STATUS Failure Webhook Body ```json { "webhook_type": "social_security_balance_request", "key": "\", "event_datetime": "\", "status": "failure", "data": { "enumerator": "not_found_legal_representative", "description": "no legal representative for the beneficiary" } } ``` #### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_balance_errors_enumerators) | ### Simulando cenários de sucesso e insucesso na consulta de benefício em Sandbox: A simulação de cenários é baseado no primeiro dígito do CPF informado na operação. **11.1.** Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook. **11.2.** Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo. | Início do CPF | Enumerador | Descrição | |---------------|------------------------|----------------------| | 2 | inexistent_beneficiary | no beneficiary found | :::caution Atenção Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado. | Enumerador | Descrição | |---------------|------------------------------------------------------------------| | mock_error | Informed document number is not a valid mock on test environment | ::: **11.3.** O CPF `18166261553` simula, com sucesso (HTTP 200, sem erro), um benefício com **margem consignável negativa** (`available_total_balance: -7.84`). Use este CPF para testar a rejeição de novas operações quando o beneficiário já excedeu a margem disponível. Lista completa de CPFs e cenários mockados: [Mocks (Sandbox)](/documentation/guides/INSS/mocks-sandbox). --- ## 3 - Simulação da dívida: ### Request crédito novo ENDPOINT /debt_simulation MÉTODO POST Testar no Playground **Valor de parcela** ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "installment_face_value": 100, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "social_security" } ] } ``` **Valor desembolsado** ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "disbursed_amount": 1000, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "social_security" } ] } ``` ### Request refinanciamento ENDPOINT /debt_simulation MÉTODO POST **Valor de Parcela** ```json { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "installment_face_value": 100, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "social_security" } ], "refinanced_credit_operations": [ { "operation_key": "324caa35-ba10-4590-ae2b-5efef71709c3" } ] } ``` **Valor desembolsado** ```json { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "disbursed_amount": 1000, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "social_security" } ], "refinanced_credit_operations": [ { "operation_key": "324caa35-ba10-4590-ae2b-5efef71709c3" } ] } ``` :::info Na request acima existem 2 simulações sendo realizadas. A primeira está fixando o valor de parcela ao cliente (varia o valor desembolsado) e a segunda, esta fixando o valor desembolsado (varia o valor desembolsado). ::: ### Response ENDPOINT /debt_simulation MÉTODO POST Response Body ```json { "type": "debt", "key": "8f01672d-9910-43a6-9e7d-07c031bc6fed", "status": "finished", "event_datetime": "2024-11-05 16:50:00", "data": { "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "interest_payment_month_period": 1, "principal_grace_period": 0, "principal_amortization_month_period": 1, "operation_type": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2024-11-05", "number_of_installments": 4, "requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a", "final_disbursement_amount": 0.0, "disbursement_options": [ { "iof_amount": 3.93, "total_pre_fixed_amount": 17.8715883143, "cet": 0.0257, "annual_cet": 0.355163, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.29 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.29, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-05", "first_due_date": "2024-12-09", "installments": [ { "calendar_days": 34, "workdays": 23.0, "business_due_date": "2024-12-09", "due_date": "2024-12-09", "due_principal": 382.13, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 7.6967422515, "tax_amount": 0.257341482602818, "total_amount": 100, "principal_amortization_amount": 92.3032577485, "installment_number": 1 }, { "calendar_days": 29, "workdays": 19.0, "business_due_date": "2025-01-07", "due_date": "2025-01-07", "due_principal": 289.8267422515, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 4.9718040699, "tax_amount": 0.4909156601748966, "total_amount": 100, "principal_amortization_amount": 95.0281959301, "installment_number": 2 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-07", "due_date": "2025-02-07", "due_principal": 194.7985463214, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.5742034136, "tax_amount": 0.7432500400879712, "total_amount": 100, "principal_amortization_amount": 96.4257965864, "installment_number": 3 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-07", "due_date": "2025-03-07", "due_principal": 98.372749735, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.6288385793, "tax_amount": 0.9841050988526828, "total_amount": 100, "principal_amortization_amount": 98.3711614207, "installment_number": 4 } ], "issue_amount": 382.13, "disbursed_issue_amount": 374.91, "assignment_amount": 382.13, "final_disbursement_amount": 374.91, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.77, "total_pre_fixed_amount": 24.2597288075, "cet": 0.0243, "annual_cet": 0.334037, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.25 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.25, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-06", "first_due_date": "2025-01-07", "installments": [ { "calendar_days": 62, "workdays": 41.0, "business_due_date": "2025-01-07", "due_date": "2025-01-07", "due_principal": 375.74, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.9149280115, "tax_amount": 0.437656505989534, "total_amount": 100, "principal_amortization_amount": 86.0850719885, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-07", "due_date": "2025-02-07", "due_principal": 289.6549280115, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.722070128765373, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-07", "due_date": "2025-03-07", "due_principal": 194.969623951, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9601685182659746, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1979530917, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.2239426674782687, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 375.74, "disbursed_issue_amount": 367.72, "assignment_amount": 375.74, "final_disbursement_amount": 367.72, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.74, "total_pre_fixed_amount": 24.0392857898, "cet": 0.0243, "annual_cet": 0.334673, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-07", "first_due_date": "2025-01-07", "installments": [ { "calendar_days": 61, "workdays": 40.0, "business_due_date": "2025-01-07", "due_date": "2025-01-07", "due_principal": 375.96, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.6944849939, "tax_amount": 0.4317001860605122, "total_amount": 100, "principal_amortization_amount": 86.3055150061, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-07", "due_date": "2025-02-07", "due_principal": 289.6544849939, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.714305933832412, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-07", "due_date": "2025-03-07", "due_principal": 194.9691809334, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.952233241255512, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1975100741, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757157, "tax_amount": 1.2158904130882027, "total_amount": 100, "principal_amortization_amount": 98.1982242843, "installment_number": 4 } ], "issue_amount": 375.96, "disbursed_issue_amount": 367.96, "assignment_amount": 375.96, "final_disbursement_amount": 367.96, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.71, "total_pre_fixed_amount": 23.8187134405, "cet": 0.0244, "annual_cet": 0.335196, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-08", "first_due_date": "2025-01-07", "installments": [ { "calendar_days": 60, "workdays": 39.0, "business_due_date": "2025-01-07", "due_date": "2025-01-07", "due_principal": 376.18, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.4739126445, "tax_amount": 0.42570834978906, "total_amount": 100, "principal_amortization_amount": 86.5260873555, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-07", "due_date": "2025-02-07", "due_principal": 289.6539126445, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.706541738899451, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-07", "due_date": "2025-03-07", "due_principal": 194.968608584, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9442979642450494, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1969377247, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.20783815869566, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 376.18, "disbursed_issue_amount": 368.21, "assignment_amount": 376.18, "final_disbursement_amount": 368.21, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } } ] } } ``` --- ## 4 - Emissão de Operação: :::caution Atenção Para operações em que ainda não se passaram 90 dias desde a data de Despacho Benefício e a averbação não é permitida, é necessário garantir que a soma de disbursement_date e limit_days_to_disburse resulte em uma data posterior aos 90 dias. Caso essa regra não seja cumprida, a operação será cancelada permanentemente, com o CancelReason: social_security_margin_release_after_disbursement_end_date. ::: O campo "assistance_type", localizado dentro do objeto "collateral_data", refere-se ao tipo de benefício que está sendo utilizado para o empréstimo. O mesmo é retornado na consulta de dados do benefício. Para visualizar os valores possíveis (enumeradores), consultar a tabela [Tabela de enumerador](#benefit_type_enumerator) :::warning Atenção O objeto `credit_agent` representa o agente de crédito, por vezes conhecido como pastinha, responsável pela originação desta dívida. Este campo é obrigatório para a emissão de dívidas de consignados. ::: :::warning CIN — Carteira de Identidade Nacional O campo `document_identification_type` agora aceita o valor `cin` (Carteira de Identidade Nacional). Quando utilizado, o campo `document_identification_number` **deve ser igual ao CPF** do portador (`individual_document_number`). O número do CIN é o próprio CPF. Valores aceitos em `document_identification_type`: `rg`, `rne`, `cnh`, `ctps`, `class_document`, `passport`, `other`, `cin`. **Atenção:** o envio do documento de identificação (`document_identification`) passará a ser **obrigatório** nas operações de crédito INSS (crédito novo e portabilidade). Comunique seus integradores com antecedência. ::: :::info Assinatura em grupo (opcional) Para reunir esta dívida com outras operações INSS do **mesmo beneficiário** e coletar **uma única assinatura**, envie `document_batch_group_key` na **raiz** do payload (mesmo nível de `borrower`, `financial` etc.). Nesse caso, a assinatura fica vinculada à pasta do grupo e o link único é obtido no envio do grupo para assinatura. Consulte o fluxo de [Assinatura em grupo](/documentation/guides/INSS/signatures/batch-group-signature). ::: ### Request Caso 1: Emissão sem representante legal ENDPOINT /debt MÉTODO POST Testar no Playground **Crédito Novo** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2023-09-20", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.0166, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 101.84, "limit_days_to_disburse": 7, "number_of_installments": 10, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "subcorban_document_number": "12123456000101" }, "collateral_type": "social_security" } ], "additional_data": { "contract": { "contract_number": "TST0000644799" } }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` **Refinanciamento** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-09-20", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 1000, "limit_days_to_disburse": 7, "number_of_installments": 84, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "subcorban_document_number": "12123456000101" }, "collateral_type": "social_security" } ], "additional_data": { "contract": { "contract_number": "TST0000644715" } }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ], "refinanced_credit_operations": [ { "operation_key": "4f32e501-212c-4129-8ac3-d9943b78583b" } ] } ``` **Crédito Novo - Aumento Salarial** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-09-20", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 1000, "limit_days_to_disburse": 7, "number_of_installments": 84, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "operation_category": "minimum_wage_increase", "subcorban_document_number": "12123456000101" }, "collateral_type": "social_security" } ], "additional_data": { "contract": { "contract_number": "TST0000644715" } }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` Caso 2: Emissão com representante legal ENDPOINT /debt MÉTODO POST **Crédito Novo** ```json { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "related_parties": [ { "name": "Representante legal", "email": "teste@qitech.com.br", "phone": { "number": "991294043", "area_code": "55", "country_code": "055" }, "address": { "street": "AV LEONOR", "state": "SP", "city": "GUARULHOS", "neighborhood": "", "number": "1", "postal_code": "07025200", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "is_pep": false, "individual_document_number": "19125869086", "birth_date": "1970-04-20", "mother_name": " Ana Lúcia" } ], "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-09-20", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 1000, "limit_days_to_disburse": 7, "number_of_installments": 84, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "subcorban_document_number": "12123456000101" }, "collateral_type": "social_security" } ], "additional_data": { "contract": { "contract_number": "TST0000644715" } }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` **Refinanciamento** ```json { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "related_parties": [ { "name": "Representante legal", "email": "teste@qitech.com.br", "phone": { "number": "991294043", "area_code": "55", "country_code": "055" }, "address": { "street": "AV LEONOR", "state": "SP", "city": "GUARULHOS", "neighborhood": "", "number": "1", "postal_code": "07025200", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "is_pep": false, "individual_document_number": "19125869086", "birth_date": "1970-04-20", "mother_name": " Ana Lúcia" } ], "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-09-20", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 1000, "limit_days_to_disburse": 7, "number_of_installments": 84, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "subcorban_document_number": "12123456000101" }, "collateral_type": "social_security" } ], "additional_data": { "contract": { "contract_number": "TST0000644715" } }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ], "refinanced_credit_operations": [ { "operation_key": "4f32e501-212c-4129-8ac3-d9943b78583b" } ] } ``` **Crédito Novo - Aumento Salarial** ```json { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "related_parties": [ { "name": "Representante legal", "email": "teste@qitech.com.br", "phone": { "number": "991294043", "area_code": "55", "country_code": "055" }, "address": { "street": "AV LEONOR", "state": "SP", "city": "GUARULHOS", "neighborhood": "", "number": "1", "postal_code": "07025200", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "is_pep": false, "individual_document_number": "19125869086", "birth_date": "1970-04-20", "mother_name": " Ana Lúcia" } ], "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-09-20", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 1000, "limit_days_to_disburse": 7, "number_of_installments": 84, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "operation_category": "minimum_wage_increase", "subcorban_document_number": "12123456000101" }, "collateral_type": "social_security" } ], "additional_data": { "contract": { "contract_number": "TST0000644715" } }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ], "refinanced_credit_operations": [ { "operation_key": "4f32e501-212c-4129-8ac3-d9943b78583b" } ] } ``` Exemplo de objeto financial com rebates ```json { "financial": { "first_due_date": "2022-12-07", "installment_face_value": 100, "disbursement_date": "2022-11-03", "limit_days_to_disburse": 3, "number_of_installments": 24, "disbursed_amount": 1876, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "rebates": [ { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ] } } ``` ### Response ENDPOINT /debt MÉTODO POST Response Body ```json { "webhook_type": "debt", "key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00", "status": "waiting_signature", "event_datetime": "2024-11-07 23:19:22", "data": { "borrower": { "name": "Nome devedor", "document_number": "14471835092", "related_party_key": "28b7fc16-6d1f-467d-9667-62a8c13daea6" }, "contract": { "number": "TST0000644710", "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/a2e9c83a-3666-4def-8b27-e96fabb8705c/NOME_DEVEDOR-CCB-TST0000644710-20241107231916.pdf" ], "signature_information": [ { "signer_name": "Nome devedor", "signer_document_number": "14471835092", "signer_role": "issuer", "signer_email": null, "signer_external_key": null, "signature_url": null } ] }, "requester_identifier_key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00", "iof_charge_method": "financed", "collaterals": [ { "absolute_amount": null, "collateral_constituted": false, "collateral_data": { "state": "SP", "benefit_number": 2052711150, "reservation_method": "issuing", "subcorban_document_number": "12123456000101" }, "collateral_key": "26c7f4f4-51f3-41fa-b880-9691211136aa", "collateral_type": "social_security", "created_at": "2024-11-07T23:19:16.413448", "external_key": null, "percentage": 1, "reservation_method": { "enumerator": "issuing" }, "updated_at": "2024-11-07T23:19:16.413441" } ], "disbursement_options": [ { "disbursement_date": "2024-11-07", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.3, "issue_amount": 909.75, "cet": "2,0100%", "annual_cet": "27,0481%", "base_iof": 16.259002146803677, "additional_iof": 3.45705, "total_iof": 19.72, "total_pre_fixed_amount": 108.6508885851, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 74, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 909.75, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 37.1789024864, "principal_amortization_amount": 64.6610975136, "tax_amount": 0.3923635397125248, "total_amount": 101.84, "workdays": 49.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0889024864, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.753721435360089, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5486660915, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9845001990781314, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2772376046, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.222548377175604, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4632222376, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4797864582180404, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.4416948163, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.72770892770474, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7989345071, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.999011328473856, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5716418016, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.274874127227187, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.570357168, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.570318634292211, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3090744135, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8541691195612935, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-08", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.79, "issue_amount": 910.24, "cet": "2,0200%", "annual_cet": "27,0539%", "base_iof": 16.187351160427028, "additional_iof": 3.458912, "total_iof": 19.65, "total_pre_fixed_amount": 108.1583324947, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 73, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 910.24, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.6863463961, "principal_amortization_amount": 65.1536536039, "tax_amount": 0.3900097704729454, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0863463961, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7465431359757072, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5461100012, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9770979419422056, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2746815143, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.21518362791551, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4606661473, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4721586929694939, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.439138726, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7200302213593857, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7963784168, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.991202690472005, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5690857113, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.266920021887232, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.5678010777, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.562261209106342, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3065183232, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.845943848326202, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-09", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.28, "issue_amount": 910.73, "cet": "2,0200%", "annual_cet": "27,0599%", "base_iof": 16.115620969325082, "additional_iof": 3.460774, "total_iof": 19.58, "total_pre_fixed_amount": 107.6655097248, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 72, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 910.73, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.1935236262, "principal_amortization_amount": 65.6464763738, "tax_amount": 0.3875767965109152, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0835236262, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7393648365913253, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5432872313, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9696956848062798, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2718587444, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.207818878655416, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4578433774, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4645309277209473, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.4363159561, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7123515150140312, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7935556469, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.983394052470154, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5662629414, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2589659165472766, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.5649783078, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.554203783920473, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3036955533, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.837718577088265, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-10", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.79, "issue_amount": 911.23, "cet": "2,0200%", "annual_cet": "27,0635%", "base_iof": 16.0438115087348, "additional_iof": 3.462674, "total_iof": 19.51, "total_pre_fixed_amount": 107.1724201311, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 71, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 911.23, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.7004340324, "principal_amortization_amount": 66.1395659676, "tax_amount": 0.3850645530633672, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0904340324, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7321865372069436, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5501976375, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.962293427670354, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2787691506, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.200454129395322, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4647537836, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4569031624724007, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.4432263623, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7046728086686769, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.8004660531, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.975585414468303, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5731733476, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2510118112073214, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.571888714, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.546146358734604, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3106059595, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.829493305847507, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-11", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.28, "issue_amount": 911.72, "cet": "2,0200%", "annual_cet": "27,0698%", "base_iof": 15.971922713858204, "additional_iof": 3.464536, "total_iof": 19.44, "total_pre_fixed_amount": 106.6790635687, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 70, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 911.72, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.2070774702, "principal_amortization_amount": 66.6329225298, "tax_amount": 0.382472975321052, "total_amount": 101.84, "workdays": 47.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0870774702, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7250082378225619, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5468410753, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9548911705344282, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2754125884, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.193089380135228, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4613972214, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.449275397223854, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.4398698001, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6969941023233224, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7971094909, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.967776776466452, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5698167854, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.243057705867366, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.5685321518, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.538088933548735, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3072493973, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141714, "principal_amortization_amount": 100.3081858286, "tax_amount": 2.8212680346152035, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-12", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.77, "issue_amount": 912.21, "cet": "2,0200%", "annual_cet": "27,0762%", "base_iof": 15.899954519820076, "additional_iof": 3.466398, "total_iof": 19.37, "total_pre_fixed_amount": 106.1854398936, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 69, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 912.21, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.7134537949, "principal_amortization_amount": 67.1265462051, "tax_amount": 0.3798019984284558, "total_amount": 101.84, "workdays": 46.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0834537949, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.71782993843818, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5432174, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9474889133985024, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2717889131, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.185724630875134, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4577735461, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4416476319753073, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.4362461248, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.689315395977968, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7934858156, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.959968138464601, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5661931101, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2351036005274114, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.5649084765, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.530031508362866, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.303625722, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8130427633716497, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-13", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.27, "issue_amount": 912.71, "cet": "2,0200%", "annual_cet": "27,0802%", "base_iof": 15.827906861727051, "additional_iof": 3.468298, "total_iof": 19.3, "total_pre_fixed_amount": 105.691548961, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 68, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 912.71, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.2195628621, "principal_amortization_amount": 67.6204371379, "tax_amount": 0.3770515574809304, "total_amount": 101.84, "workdays": 45.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0895628621, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7106516390537982, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5493264672, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9400866562625766, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2778979803, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.17835988161504, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4638826133, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4340198667267607, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.442355192, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6816366896326136, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7995948828, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.95215950046275, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5723021773, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.227149495187456, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.5710175437, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.521974083176997, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3097347892, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141718, "principal_amortization_amount": 100.3081858282, "tax_amount": 2.8048174921281284, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-14", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.57 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.07, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.77, "issue_amount": 913.2, "cet": "2,0200%", "annual_cet": "27,0870%", "base_iof": 15.755779674642707, "additional_iof": 3.47016, "total_iof": 19.23, "total_pre_fixed_amount": 105.1973906257, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-20", "calendar_days": 67, "due_date": "2025-01-20", "due_interest": 0.0, "due_principal": 913.2, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 33.7254045271, "principal_amortization_amount": 68.1145954729, "tax_amount": 0.3742215875281126, "total_amount": 101.84, "workdays": 44.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-20", "calendar_days": 31, "due_date": "2025-02-20", "due_interest": 0.0, "due_principal": 845.0854045271, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7034733396694164, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-20", "calendar_days": 28, "due_date": "2025-03-20", "due_interest": 0.0, "due_principal": 757.5451681322, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9326843991266508, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-22", "calendar_days": 33, "due_date": "2025-04-22", "due_interest": 0.0, "due_principal": 667.2737396453, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.170995132354946, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-20", "calendar_days": 28, "due_date": "2025-05-20", "due_interest": 0.0, "due_principal": 577.4597242783, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4263921014782142, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-20", "calendar_days": 31, "due_date": "2025-06-20", "due_interest": 0.0, "due_principal": 484.438196857, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6739579832872593, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7954365478, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.944350862460899, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-20", "calendar_days": 30, "due_date": "2025-08-20", "due_interest": 0.0, "due_principal": 295.5681438423, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.219195389847501, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-22", "calendar_days": 33, "due_date": "2025-09-22", "due_interest": 0.0, "due_principal": 198.5668592087, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.513916657991128, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-20", "calendar_days": 28, "due_date": "2025-10-20", "due_interest": 0.0, "due_principal": 100.3055764542, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.79659222089858, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-20", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } } ] } } ``` Caso a operação não seja assinada ou averbada até a última opção de data de desembolso o parceiro receberá um webhook informando a respeito do cancelamento da operação: WEBHOOK_TYPE debt STATUS Canceled **Webhook Body** ```json { "key": "\", "data": { "cancel_reason": "Operacao cancelada manualmente", "cancel_reason_enumerator": "manual" }, "status": "canceled", "webhook_type": "debt", "event_datetime": "2022-11-01 03:46:31" } ``` ### Simulando cenários de sucesso e insucesso na averbação em Sandbox: A simulação de cenários é baseado no primeiro dígito do CPF informado na operação. **11.1.** Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook. **11.2.** Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo. **11.3.** Erros com Ação "cancel" receberá um webhook com o resultado final da operação. | Início do cpf | Enumerador | Descrição | Ação | |---------------|------------------------------|-----------------------------------------------------------------------------------|--------| | 2 | invalid_disbursement_account | Invalid disbursemente bank account | cancel | | 3 | operation_not_allowed_IR | Operation not allowed due to operation deadline greatter than benefit termination | cancel | :::caution Atenção Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado. | Enumerador | Descrição | |---------------|------------------------------------------------------------------| | mock_error | Informed document number is not a valid mock on test environment | ::: ## 5 - Envio de documentos É obrigatório o envio (segundo IN 138 do INSS) dos dados complementares do contrato. Os documentos devem ser enviados através do [endpoint de upload de documentos](../upload_de_documentos) e devem seguir a seguinte formatação: | Validações | Valores | |----------------|--------------| | Formato | JPEG | | Tamanho mínimo | 250 x 250 px | | Tamanho máximo | 2 MB | :::caution Atenção Contratos que tiverem documentos vinculados que não respeitam as regras de tamanho mínimo ou máximo serão cancelados permanentemente. ::: Após o upload dos documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da operação ou após, através do seguinte endpoint: ENDPOINT /debt/ DEBT-KEY /related_party/ RELATED-PARTY-KEY /attached_document MÉTODO POST Testar no Playground Request Body ```json { "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41", "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431", "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c" } ``` :::info Informação A **related_party_key** é retornada na response da criação de dívida dentro do objeto **borrower** ::: ## 6 - Formalização da operação Após o input dos documentos a operação pode seguir para formalização. No caso de assinatura por parte do representante legal, no campo "**data.contract.signers[i]**" serão retornados os dados do representante legal, e o valor do objeto "**data.contract.signers[i].signer_role**" será "**issuer_legal_representative**". **No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 5. Os campos obrigatórios são os seguintes: _ip_address_ e _signature_datetime_.** ### Request ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST Testar no Playground Request Body ```json { ..., "ip_address": "192.168.0.0", "signature_datetime": "2020-03-20T14:28:23.382748Z", "similarity_score": 0.98000, "biometry_analysis_reference": "serpro", "type": "data-signature" } ``` :::caution Atenção O payload de envio da assinatura varia de acordo com o processo de formalização do parceiro e deve ser alinhado com o time de integração da QI Tech. ::: #### Enumeradores _Biometry Analysis Reference_ | Enumerador | Descrição | |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **serpro** | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro) | | **tse** | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE | | **not_found** | Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro. | :::danger QI Sign A QI Tech oferece o serviço de assinatura que atende ao determinado pela IN 138. Com biometria facial e envio de documentos. Para receber uma cotação consulte nosso time comercial: comercial@qitech.com.br ou (11) 2339-4763 ::: ### Response ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST Response Body ```json { "data": {}, "event_datetime": "2022-11-07 15:24:47", "key": "\", "status": "signature_received", "webhook_type": "debt" } ``` Após o recebimento da assinatura, uma validação dos documentos enviados e do campo assistance type será feita. Caso seja enviado um tipo de benefício [(assistance_type)](#benefit_type_enumerator) que não esteja mapeado, a operação será cancelada permanentemente. O mesmo vale para as validações de documentos, caso haja duplicidade, falta ou documentos fora dos padrões mínimos exigidos, a operação será cancelada permanente. Em ambos os casos, um webhook será enviado com o seguinte payload: WEBHOOK_TYPE debt STATUS Canceled Permanently Webhook Body ```json { "key": "", "data": {}, "status": "canceled_permanently", "webhook_type": "debt", "event_datetime": "2022-11-01 03:46:31" } ``` ## 7 - Averbação e Desaverbação :::caution Atenção Para que o pedido de averbação seja criado com sucesso, é preciso que seja feita uma consulta de dados válida para o benefício **previamente**. Para isso basta seguir os passos do item [2 - Consulta de dados do benefício](#consulta-de-dados). ::: ### Falha na averbação por margem exedida Se uma reserva com categoria de novo beneficiário ou de aumento salarial receber margem excedida na tentativa de averbação, o status do pedido de averbação ficará como "aguardando ação do parceiro", e será enviado um webhook no seguinte formato para informar o ocorrido: WEBHOOK_TYPE social_security_margin_exceeded_for_new_beneficiary ou social_security_margin_exceeded_for_minimum_wage_increase STATUS Pending requester action Webhook Body **Novo Beneficiario** ```json { "webhook": { "key": "\", "data": { "enumerator": "margin_exceeded_for_new_beneficiary", "description": "The margin for this reservation has been exceeded. Reservation Amount: 551.18", }, "status": "pending_requester_action", "webhook_type": "social_security_margin_exceeded_for_new_beneficiary", "event_datetime": "2024-10-15T15:33:59" } } ``` **Aumento Salarial** ```json { "webhook": { "key": "\", "data": { "enumerator": "margin_exceeded_for_minimum_wage_increase", "description": "The margin for this reservation has been exceeded. Reservation Amount: 551.18", }, "status": "pending_requester_action", "webhook_type": "social_security_margin_exceeded_for_minimum_wage_increase", "event_datetime": "2024-10-15T15:33:59" } } ``` ### Falha na averbação por falta de uma consulta de dados válida do benefício Se uma consulta dos dados do benefício não for realizada com sucesso antes do pedido de averbação, o status do pedido de averbação ficará como "aguardando ação do parceiro" e será enviado um webhook no seguinte formato para informar o ocorrido: WEBHOOK_TYPE social_security_success_balance_request_not_found STATUS Pending requester action Webhook Body ```json { "webhook": { "key": "\", "data": { "enumerator": "success_balance_request_not_found", "description": "Success balance request not found for the specified benefit number" }, "status": "pending_requester_action", "webhook_type": "social_security_success_balance_request_not_found", "event_datetime": "2024-10-15T15:33:59" } } ``` Para prosseguir, as seguintes ações deverão ser tomadas: 1. Realizar a consulta dos dados do benefício em questão seguindo os passos do item 2 - [Consulta de dados do benefício](#consulta-de-dados); 2. Enviar uma requisição no formato abaixo para informar que a consulta foi realizada. ENDPOINT /social_security/reservation/external_key/ DEBT-KEY /validate_reservation MÉTODO POST Testar no Playground :::info Importante Essa requisição não apenas confirma a existência de uma consulta válida dos dados do benefício, mas também verifica se as informações enviadas para a criação da averbação estão corretas, permitindo assim a continuidade do processo. ::: ### Sistema de priorização de requisições (Fura fila) Devido à limitação da Dataprev, que permite no máximo **25 requisições por segundo**, o sistema de requisições opera de maneira assíncrona, ou seja, as tentativas de averbação são organizadas em uma fila para processamento. Dessa forma, as requisições são priorizadas com base no tipo de operação e probabilidade de sucesso. Nesse contexto, pensando em evitar a perda de margem em situações em que há alta probabilidade de sucesso na averbação, mas ainda vai demorar para ocorrer a próxima tentativa de averbação, foi desenvolvido esse sistema que permite realizar uma requisição de forma síncrona, ou seja, sem precisar esperar passar pela fila. Todavia, para garantir o controle adequado e evitar o uso indevido desse sistema, foi implementado um mecanismo de **balde de fichas**, que funciona da seguinte forma: - Cada requisição consome uma ficha para ser realizada; - Se a requisição resultar em uma averbação bem-sucedida, a ficha é devolvida ao balde; - Caso contrário, a ficha é perdida; - Existe um limite máximo de fichas por balde; - Uma rotina de reposição de fichas é ativada periodicamente, para reabastecer as fichas perdidas até atingir o limite máximo; - Se as fichas se esgotarem, novas requisições não poderão ser feitas até que a rotina reponha uma nova ficha. Exemplo Sistema de Balde Nesse exemplo, a configuração do balde é: - **Número máximo de fichas:** 10 - **Tempo de reposição:** 30min **HORA 0:** O balde é criado com sua capacidade máxima; **9min:** Uma requisição é feita, mas o contrato não é averbado (erro), ocasionando na perda de 1 ficha; **17min:** Uma requisição é feita e o contrato é averbado (sucesso), mantendo inalterado o número de fichas; **30min:** Ocorre a primeira reposição de fichas, levando o balde a sua capacidade máxima novamente; **47min:** 10 requisições são realizadas com sucesso e nenhuma ficha é perdida; **1h:** Ocorre a segunda reposição de fichas, mas como o balde já está cheio, o número de fichas permanece inalterado; **1:12h:** 5 requisições são realizadas com erro, levando a perda de 5 fichas; **1:30h:** Ocorre a terceira reposição de fichas, deixando o balde com 6 fichas; **1:38h:** 6 requisições são realizadas com erro, esgotando todas as fichas; **1:51h:** Uma tentativa de requisição é feita, mas como o balde não possui nenhuma ficha, a requisição é barrada; **2h:** Ocorre a quarta reposição de fichas, levando a balde a 1 ficha e permitindo novas tentativas de requisições; Para fazer a requisição prioritária, basta bater no seguinte endpoint utilizando a DEBT-KEY correspondente à operação que deseja averbar: #### Request ENDPOINT /social_security/reservation/external_key/ DEBT-KEY /priority_request MÉTODO POST Testar no Playground #### Response Response Body - Sucesso ```json { "max_bucket_capacity": 10, "bucket_fill_rate_minutes": 30, "available_tokens": 7, "status": "pending_document_submission", "next_refill_at": "2025-02-04T20:28:35Z" } ``` Response Body - Erros ```json Erro na averbação: { "title": "Reservation Failed", "description": "Last Response: consignable_margin_excceded, Tokens Available: 9, Next Refill At: 2025-02-04T20:18:35Z", "translation": "Ultima resposta: consignable_margin_excceded, Fichas disponiveis: 9, Proxima Recarga: 2025-02-04T20:18:35Z", "extra_fields": {}, "code": "SSC000083" } Erro de nenhuma ficha disponível: { "title": "Rate limit exceeded", "description": "Request limit exceeded. No tokens available, next refill in 8 minutes.", "translation": "Limite de solicitacoes excedido. Nenhuma ficha disponivel, proxima recarga em 8 minutos.", "extra_fields": {}, "code": "SSC000080" } ``` Por fim, é possível consultar as configurações atuais do balde sem a necessidade de realizar uma requisição no endpoint de priorização. Para isso, disponibilizamos o seguinte endpoint para consulta: #### Request ENDPOINT /social_security/bucket_configuration MÉTODO GET Testar no Playground #### Response Response Body ```json { "max_bucket_capacity": 10, "bucket_fill_rate_minutes": 30, "available_tokens": 7, "next_refill_at": "2025-02-04T20:08:35Z" } ``` ### Sucesso na averbação Em caso de sucesso na averbação o parceiro receberá o seguinte webhook: WEBHOOK_TYPE credit_operation.collateral STATUS Success Webhook Body ```json { "key": "\", "data": { "collateral_type": "social_security", "collateral_constituted": true }, "event_time": "2022-10-31 15:23:46", "webhook_type": "credit_operation.collateral" } ``` ### Correção de dados no caso de falha na averbação É possível corrigir os dados bancários, número do benefício e o nome do contrato em tentativa de averbação. Para isso basta utilizar a seguinte chamada: ENDPOINT /debt/ DEBT-KEY /collateral MÉTODO PATCH Testar no Playground Request Body **Dados Bancários** ```json { "disbursement_bank_account": { "bank_code": "123", "account_digit": "1", "account_branch": "1234", "account_number": "5678", "document_number": "12345678901" } } ``` **Número do Benefício** ```json { "benefit_number": 1234567890 } ``` **Nome** ```json { "name": "Nome do Beneficiário" } ``` ### Desaverbação A desaverbação de um contrato é realizada através da rota de cancelamento permanente. Essa rota coloca um status final no contrato, o qual não é passível de retentativa e dispara a desaverbação da margem averbada. Para realizar o cancelamento definitivo, deve ser utilizado o seguinte endpoint: ENDPOINT /debt/ DEBT-KEY /cancel_permanently MÉTODO POST Testar no Playground #### Webhooks WEBHOOK_TYPE debt STATUS canceled_permanently Webhook Body ```json { "key": "\", "data": {}, "status": "canceled_permanently", "webhook_type": "debt", "event_datetime": "2022-11-01 03:46:31" } ``` ## 8 - Falha no desembolso ### TED Em caso de falha no desembolso via TED WEBHOOK_TYPE debt STATUS canceled Webhook Body ```json { "status": "canceled", "key": "\", "data": { "ted_refusal": { "transaction_key": "16faabfc-3876-437d-a4f6-aae17a1d68c9", "description": "341 0000 000000-7 12345678900 - NOME BENEFICIÁRIO", "origin": { "account_key": "a1d2dea5-fa90-4676-a125-da355fdc3ed0", "account_number": "00086", "bank_code": "329", "name": "ACCOUNT TRANSITORY", "type": "payment_account", "document": "32402502000135", "branch_digit": null, "account_digit": "8", "branch": "0001" }, "fee": 0, "reason_enumerator": "agencia_conta_invalida", "timestamp": "2022-11-07T14:36:05", "amount": 483.6, "reason": "Agência ou Conta Destinatária do Crédito Inválida", "destination": { "branch": "0000", "account_number": "000000", "name": "NOME BENEFICIÁRIO", "purpose": "Crédito em Conta", "type": "checking_account", "branch_digit": null, "document": "12345678900", "bank_code": "341", "account_digit": "7" } }, "cancel_reason": "ted_refusal" } } ``` ### Pix Em caso de falha no desembolso via Pix WEBHOOK_TYPE debt STATUS canceled Webhook Body ```json { "webhook_type": "debt", "data": { "pix_refusal": { "reason": "Número da conta de destino é inexistente ou inválido.", "reason_enumerator": "invalid_account", "cancel_reason_enumerator": "invalid_account" }, "cancel_reason": "pix_refusal", "cancel_reason_enumerator": "pix_refusal" }, "status": "canceled", "key": "\", "event_datetime": "2025-09-04 15:29:37" } ``` ## 9 - Reapresentação de Pagamento Altera a data de desembolso sem afetar os valores financeiros da operação. ### Request ENDPOINT /debt/ DEBT-KEY /change_disbursement_date MÉTODO POST Testar no Playground Request Body ```json { "disbursement_date": "2022-11-04", "disbursement_bank_accounts": [ { "branch_number": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "document_number": "14950479032", "bank_code": 184, "ispb_number": "17298092", "name": "Maria da Silva", "percentage_receivable": 100 } ] } ``` ### Response ENDPOINT /debt/ DEBT-KEY /change_disbursement_date MÉTODO POST Response Body ```json { "disbursement_accounts": [ { "account_branch": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "amount_receivable": null, "created_at": "2022-05-24T14:51:46", "digitable_line": null, "disbursement_type": "ted", "document_number": "37197645832", "financial_institutions": { "code_number": 184, "ispb": 17298092, "name": "BCO ITAÚ BBA S.A." }, "financial_institutions_code_number": 184, "is_pix_disbursement": false, "ispb": "17298092", "name": "Márcio e Catarina Gráfica Ltda", "percentage_receivable": 50.0, "pix_key": null, "pix_transfer_key": null, "pix_type": null, "qr_code_key": null, "retry_counter": 0, "retry_vector": null, "transaction_key": null, "webhook_key": null } ], "disbursement_date": "2022-11-04" } ``` --- ![Competence Diagram](@site/static/img/imagem_manual_credito_novo_inss.webp) ## 10 - Recuperar resposta da última request O last response é uma forma de mapear, de forma simples e objetiva, a resposta da comunicação entre a QI e a Dataprev, possibilitando saber quando essa requisição foi feita e qual o retorno obtido (através de um enumerador). Os enumeradores estão diretamente relacionados aos códigos de retorno da Dataprev e são divididos em duas formas: "errors" e "success". Cada enumerador tem uma descrição detalhada e o código de referência da Dataprev. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response. ### Casos de sucesso #### Request ENDPOINT /debt/DEBT-KEY/collateral MÉTODO GET Testar no Playground #### Response Response Body ```json { "collateral_constituted": true, "collateral_type": "type", "updated_at": "2023-05-24 19:13:02", "collateral_data": { "state": "SP", "benefit_number": 1976703155, "status": "reserved", "last_response": { "success": [ { "enumerator": "succesfully_included", "reservation_method" : "new_credit" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z" } } ``` ### Detalhamento de campos no retorno da request | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_response_enumerator_success)| | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ### Casos de erro #### Request ENDPOINT /debt/DEBT-KEY/collateral MÉTODO GET #### Response Response Body ```json { "collateral_constituted": false, "collateral_type": "type", "updated_at": "2023-05-24 19:13:02", "collateral_data": { "state": "SP", "benefit_number": 1976703155, "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "benefit_blocked_by_tbm", "reservation_method" : "new_credit" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z" } } ``` ### Detalhamento de campos no retorno da request | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_response_enumerator_errors)| | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ## 11 - Recuperar última consulta do benefício Por esse endpoint é possível consultar quando foi a última consulta do benefício na Dataprev. #### Request ENDPOINT /social_security/benefit/BENEFIT-NUMBER MÉTODO GET Testar no Playground #### Response Response Body ```json { "last_balance_check": "2025-08-22T19:13:02Z", "status": "pending_balance_request" } ``` ## 12 - Webhook de resposta da última tentativa de averbação Caso a operação não tenha sucesso na averbação, a mesma ficará em retentativa e será enviado o seguinte webhook, detalhando o motivo da não averbação, o horário desta tentativa e o método de averbação utilizado: WEBHOOK_TYPE credit_operation.collateral *Body:* **body.json** ```json { "webhook_type": "credit_operation.collateral", "key": "\", "event_time": "2022-11-24T15:42:12", "data": { "collateral_type": "social_security", "collateral_constituted": false, "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [{ "enumerator": "consignable_margin_excceded" }] }, "last_response_event_datetime": "2023-05-22T19:13:02Z", "reservation_method": "new_credit", } } } ``` ## 13. Mapeamento de enumeradores ### Tabela de retorno de erros Dataprev - averbação {#dataprev_response_enumerator_errors} | Código Dataprev | Enumerador | Descrição | Ação Qi | |-----------------|--------------------------------------------------|-------------------------------------------------------------|----------------------| | HW | consignable_margin_excceded | Exceeded consignable margin | Teimosinha | | IT | benefit_blocked_by_tbm | Benefit blocked due to benefit transfer | Teimosinha | | IE | benefit_blocked_by_beneficiary | Benefit blocked by beneficiary | Teimosinha | | AN | invalid_disbursement_account | Invalid disbursement bank account | Cancelar | | HX | reservation_already_included | Reservation already included | Confirmar averbação | | IF | benefit_blocked_by_granting_process | Benefit blocked during granting process | Teimosinha | | AV | processing_payroll | Operation couldn`t be done during processing payroll period | Teimosinha | | OF | invalid_cbc | Invalid cbc | Teimosinha | | IA | first_name_mismatch | First name mismatch benefit owner or legal representative | Teimosinha | | OS | legal_representative_document_number_mismatch | Document number mismatch legal representative | Teimosinha | | AY | invalid_state | Invalid state | Teimosinha | | HZ | operation_not_allowed_on_this_reservation_status | Operation couldn`t be done with current reservation status | Teimosinha | | AP | invalid_contract_date | Accrual, end or start contract date is invalid | Teimosinha | | GA | required_fields_missing | Required fields are missing | Teimosinha | | BC | cbc_missing | CBC is missing | Teimosinha | | NC | contract_number_missing | Contract number is missing | Teimosinha | | NB | benefit_number_missing | Benefit number is missing | Teimosinha | | CA | invalid_bank_code | Invalid bank code | Teimosinha | | HR | exceeded_number_of_allowed_contracts | Amount of contracts is above the limit | Teimosinha | | PV | invalid_image_format | Image with wrong format | Teimosinha | | IR | operation_not_allowed_IR | Operation date is greater than benefit expiration | Cancelar | | PK | wrong_bank_code_destination | Portability number was found with wrong bank code destination| Teimosinha | | PH | wrong_benefit_number_on_portability | Portability number was found with wrong benefit number | Teimosinha | | PI | invalid_contract_total_amount | Reservation contract total amount should be greater than Dataprev reference amount | Teimosinha | ### Tabela de retorno de sucesso - averbação {#dataprev_response_enumerator_success} | Código Dataprev | Enumerador | Descrição | |--------|--------------------------|-----------------------------------------| | BD | successfully_included | Inclusion has been successfully done | | BF | successfully_removed | Removal has been successfully done | | BR | successfully_reactivated | Reactivation has been successfully done | | BS | successfully_suspended | Suspension has been successfully done | ### Tabela de retorno de erros na consulta de saldo {#dataprev_balance_errors_enumerators} | Código | Enumerador | Descrição | |--------|---------------------------------------|---------------------------------------------------------------------------------| | CR | not_found_legal_representative | no legal representative for the beneficiary | | CD | inexistent_beneficiary | no beneficiary found | | AS | benefity_without_legal_representative | beneficiary does not have a legal representative | | BI | inexistent_benefit | no benefit found | | D1 | inconsistent_balance_benefit_data | The balance benefit data registered is either inconsistent, null or incomplete. | ### Tabela de retorno de erros na consulta de benefícios {#dataprev_benefits_errors_enumerators} | Código | Enumerador | Descrição | |--------|---------------------------------------|---------------------------------------------------------------------------------| | CR | not_found_legal_representative | no legal representative for the beneficiary | | CD | inexistent_beneficiary | no beneficiary found | | AS | benefity_without_legal_representative | beneficiary does not have a legal representative | ### Tabela de situação de benefícios {#benefit_situation_enumerator} | Items | |-------| | active | | excluded | | terminated | | suspended | | suspended_by_CONPAG | | terminated_by_SISOBI | | receiving_monthly_recover_6_months | | receiving_monthly_recover_18_months | | suspended_by_name_error | | suspended_by_credentialed_payer | | suspended_by_inspection | | suspended_by_audit | | terminated_by_inspection | | terminated_by_audit | | receiving_monthly_recover_6_months_inspection | | receiving_monthly_recover_18_months_inspection | | suspended_by_SISOBI | | canceled_by_audit | ### Tabela de status de benefícios {#benefit_status_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | Elegible | Elegível para empréstimo | | Inelegible | Benefício inelegível para empréstimo | | Blocked | Benefício elegível, porém bloqueado para empréstimo | ### Tabela de tipos de bloqueio {#block_type_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | not_blocked | Sem bloqueio | | blocked_by_benefitiary | Bloqueado pelo Segurado | | blocked_by_tbm | Bloqueado por TBM | | blocked_in_concession | Bloqueado na Concessão | ### Tabela de tipos de politicamente exposto {#politically_exposed_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | 0 | Pessoa Não Exposta Politicamente | | 1 | Pessoa Exposta Politicamente - Nível 1 | ### Tabela de benefícios {#benefit_type_enumerator} | código | benefício | | --- | ------------------------------------------------ | | 1 | pension_by_death_rural_worker | | 2 | pension_by_death_accident_rural_worker | | 3 | pension_by_death_rural_employer | | 4 | retirement_invalidity_rural_emploee | | 5 | retirement_invalidity_accident_rural_worker | | 6 | retirement_invalidity_rural_employer | | 7 | retirement_by_eldness_rural_worker | | 8 | retirement_by_age_rural_employer | | 9 | complement_by_work_accident_rural_worker | | 11 | support_invalidity_rural_worker | | 12 | support_by_age_rural_worker | | 13 | aid_sickness_rural_worker | | 15 | aid_time_off_rural_worker | | 16 | aid_federal | | 17 | international_agreement | | 18 | inclusion_benefit | | 19 | pension_student_law7004 | | 20 | pension_by_death_diplomat | | 21 | pension_by_death | | 22 | pension_by_death_statute | | 23 | pension_by_death_veteran | | 24 | pension_special_institutional_act | | 25 | aid_time_off | | 26 | pension_by_death_special_law593 | | 27 | pension_by_death_federal_emploee | | 28 | pension_by_death_general_regime_law20465 | | 29 | pension_by_death_marine_veteran | | 30 | monthly_income_lifetime_invalidity | | 31 | aid_sickness | | 32 | retirement_invalidity_social_security | | 33 | retirement_invalidity_aeronautic | | 34 | retirement_invalidity_marine_law1756 | | 35 | aid_sickness_veteran | | 36 | aid_social_security_accident | | 37 | retirement_capin_extra_emploee | | 38 | retirement_federal_extra_emploee | | 39 | aid_invalidity_student_law7004 | | 40 | monthly_income_lifetime_by_age_upper70_law6179 | | 41 | retirement_by_age | | 42 | retirement_by_contribution_time | | 43 | retirement_by_time_of_service_veteran | | 44 | retirement_special_aeronautic | | 45 | retirement_by_time_of_service_journalist | | 46 | retirement_special | | 47 | allowance_25 | | 48 | allowance_20 | | 49 | retirement_ordinary | | 50 | aid_sickness_extinct_basic_plan | | 51 | retirement_invalidity_extinct_basic_plan | | 52 | retirement_by_age_extinct_basic_plan | | 53 | aid_time_off_extinct_basic_plan | | 54 | pension_indemnity_federal | | 55 | pension_by_death_extinct_basic_plan | | 56 | pension_lifetime_syndrome_thalidomide | | 57 | retirement_by_teacher_labor_time | | 58 | retirement_anisty | | 59 | pension_by_death_amnesty | | 60 | indemnity | | 61 | aid_birth | | 62 | aid_funeral | | 63 | aid_funeral_rural_worker | | 64 | aid_funeral_rural_employer | | 65 | savings_special_autarchy | | 67 | savings_mandatory_ipase_law5128 | | 68 | savings_special_retirement_ps_affiliated_upper60 | | 69 | savings_student_law7004 | | 70 | restitution | | 71 | monthly_income | | 72 | retirement_by_time_of_service_law1756 | | 73 | monthly_income_family_statute | | 74 | complement_pension_federal | | 75 | complement_retirement_federal | | 76 | monthly_income_statute | | 77 | monthly_income_sinpas_family_statute | | 78 | retirement_by_age_law1756 | | 79 | advantage | | 80 | monthly_income_maternity | | 81 | compulsory_retirement | | 82 | retirement_by_time_of_service_sasse | | 83 | retirement_invalidity_ex_sasse | | 84 | pension_by_death_sasse | | 85 | pension_lifetime_rubber_tapper_law7986 | | 86 | pension_lifetime_rubber_tapper_dependent_law7986 | | 87 | continuous_aid_physical_disabilities | | 88 | continuous_aid_eldness | | 89 | pension_special_hemodialysis_victim_caruaru | | 90 | medic_assistency_work_accident | | 91 | aid_sickness_by_work_accident | | 92 | retirement_invalidity_work_accident | | 93 | pension_by_death_work_accident | | 94 | aid_work_accident | | 95 | aid_additional_work_accident | | 96 | pension_special_leprosy_law11520 | | 97 | savings_by_death_work_accident | | 98 | aid_longshoreman | | 99 | time_off_15 | --- # Recálculo URL: /documentation/guides/INSS/new-credit-and-refinancing/recalculate Recálculo Recalcula as condições financeiras de uma operação de crédito existente a partir de um **novo valor de parcela**. Ideal para quando a margem consignável do beneficiário muda e o valor da parcela precisa ser ajustado. ## Request ENDPOINT /v2/credit_operation/ CREDIT_OPERATION_KEY /recalculate MÉTODO POST ### Path Params credit_operation_key string (UUID) obrigatório Chave única da operação de crédito a ser recalculada. ### Body Params installment_face_value number obrigatório Novo valor de face da parcela. Deve ser menor ou igual ao valor original e acima do mínimo permitido (20.00). ```python { "installment_face_value": 180.50 } ``` :::caution Atenção O novo `installment_face_value` precisa ser **menor** que o valor original. O endpoint rejeita valores superiores ao original ou fora da redução máxima permitida (30%). ::: ### Pré-condições A operação deve atender **todas** as condições abaixo para ser recalculada: | Condição | Erro se não atendida | |----------|----------------------| | Operação existe | [`COP000027`](#COP000027) (404) | | Requisitante é dono da operação | [`QIT000005`](#QIT000005) (403) | | Garantia do tipo `social_security` | [`COP000276`](#COP000276) | | Status: `waiting_signature`, `issued` ou `canceled` | [`COP000489`](#COP000489) | | Garantia ainda não constituída | [`COP000489`](#COP000489) | | Tipo de operação: `structured_operation` | [`COP000489`](#COP000489) | | Data limite de desembolso não expirada | [`COP000489`](#COP000489) | | Operação original possui `installment_face_value` | [`COP000489`](#COP000489) | | Novo valor dentro dos limites permitidos | [`COP000490`](#COP000490) | ## Response STATUS 200 Retorna o objeto completo da operação de crédito recalculada — mesma estrutura da [consulta por credit_operation_key](/documentation/emissao_de_divida/consulta_por_credit_operation_key). ## Erros | Código HTTP | Código QI | Descrição | Tradução | |-------------|-----------|-----------|----------| | 404 | `COP000027` | Credit Operation not found | Operação não encontrada | | 403 | `QIT000005` | Selected agent does not own this item | O agente selecionado não é dono do item | | 400 | `COP000276` | Collateral type doesn't allow recalculation | Garantia do contrato não permite que a operação seja recalculada | | 400 | `COP000335` | Assignment amount exceeds operation final amount | O valor de cessão é superior ao valor final da operação | | 400 | `COP000339` | Final disbursement amount cannot be negative | O valor de desembolso final não pode ser negativo | | 400 | `COP000489` | Operation not allowed to be recalculated | A operação de crédito não está permitida para ser recalculada | | 400 | `COP000490` | Installment face value variance not allowed | A variação do valor da parcela não está permitida | Motivos detalhados do erro COP000489 O código `COP000489` é retornado para diferentes pré-condições não atendidas. O campo `reason` na resposta indica o motivo específico: | Motivo | Descrição | |--------|-----------| | Status inválido | O status da operação de crédito não permite ser recalculada | | Garantia já constituída | A operação de crédito já possui garantia constituída | | Tipo de operação inválido | O tipo de operação de crédito não permite ser recalculada | | Data de desembolso expirada | A data de término do desembolso da operação de crédito está no passado | | Valor de parcela ausente | O valor da parcela não foi informado na operação original | --- # Anuência (pending confirmation) URL: /documentation/guides/INSS/pending_confirmation Anuência (pending confirmation) Após a averbação, a reserva entra em **`pending_confirmation`** aguardando a confirmação do beneficiário no INSS. A QI Tech notifica o parceiro via webhook e segue consultando a Dataprev até a confirmação, recusa ou expiração do prazo. :::info Escopo Aplica-se a **crédito novo** e **refinanciamento**. **Portabilidade não exige anuência.** ::: :::tip Vigência **19/05/2026 às 06:00.** Mapeie o novo webhook para acionar o beneficiário com agilidade. ::: ## Fluxo - Averbação bem-sucedida → reserva entra em `pending_confirmation`. - QI Tech envia o webhook `laas.social_security.reservation.status_change` e dispara SMS ao beneficiário. - Consulta à Dataprev **a cada 3 horas**; **cada consulta redispara o webhook**. - SMS adicional ao beneficiário **uma vez por dia** enquanto a operação estiver pendente. - **Prazo máximo:** 5 dias corridos. Se expirar ou for recusada, ocorre **desaverbação** automática. | Desfecho | Webhook | |---|---| | Beneficiário confirma | `credit_operation.collateral` com `collateral_constituted: true` | | Beneficiário recusa | `debt` / `canceled` — `social_security_confirmation_denied_by_beneficiary` | | Prazo expira | `debt` / `canceled` — `social_security_confirmation_expired` | ## Webhook — anuência pendente WEBHOOK_TYPE laas.social_security.reservation.status_change STATUS pending_confirmation ```json { "key": "", "webhook_type": "laas.social_security.reservation.status_change", "status": "pending_confirmation", "event_datetime": "2026-05-19 06:15:00", "data": { "confirmation_deadline": "2026-05-20T14:25:03Z" } } ``` ## Webhook — anuência concluída Mesmo webhook de averbação já existente. Veja [Sucesso na averbação](/documentation/guides/INSS/new-credit-and-refinancing/end-to-end#sucesso-na-averbação). WEBHOOK_TYPE credit_operation.collateral ```json { "key": "", "data": { "collateral_type": "social_security", "collateral_constituted": true }, "event_time": "2026-05-19 12:42:00", "webhook_type": "credit_operation.collateral" } ``` ## Webhook — recusa ou expiração Mesmo webhook de cancelamento já existente, distinguindo o motivo via `cancel_reason_enumerator`: | Enumerador | Quando | |---|---| | `social_security_confirmation_denied_by_beneficiary` | Beneficiário recusou a confirmação | | `social_security_confirmation_expired` | Prazo de 5 dias expirou | WEBHOOK_TYPE debt STATUS canceled ```json { "key": "", "status": "canceled", "data": { "cancel_reason": "Beneficiário recusou a confirmação da reserva", "cancel_reason_enumerator": "social_security_confirmation_denied_by_beneficiary" }, "webhook_type": "debt", "event_datetime": "2026-05-21 09:10:00" } ``` ## Testando em sandbox Em sandbox o desfecho da anuência é simulado pelo **último dígito do número do benefício** — terminados em `0`, `1`, `3`, `5` ou `6` confirmam automaticamente; `9` recusa; `7` expira; `8`, `2` e `4` permanecem pendentes. Tabela completa em [Mocks (Sandbox)](/documentation/guides/INSS/mocks-sandbox#anuencia). ## Forçar consulta imediata (Fura-fila) O [Fura-fila](/documentation/guides/INSS/reservations/priority-request) passa a aceitar reservas em `pending_confirmation`, forçando uma consulta imediata à Dataprev. :::warning Consumo de ficha Se a reserva **ainda não tiver sido confirmada**, retorna `ReservationFailed` com `last_response = confirmation_still_pending` e **consome uma ficha** do balde. Ajuste sua lógica de retentativas. ::: --- # Alterando o Cessionário URL: /documentation/guides/INSS/portability+refinancing/alterando-cessionario Alterando o Cessionário Em uma operação de Portabilidade + Refinanciamento, é possível definir um cessionário diferente do padrão no momento de aceite do refinanciamento. Isso é feito por meio do campo `purchaser_document_number` no corpo da requisição de aceite. ## Endpoint de Aceite O cessionário é configurado ao aceitar a operação de refinanciamento (Troco) via: - MÉTODO POST - ENDPOINT /v2/credit_transfer/proposal/**\{proposal_key\}**/refinancing_credit_operation/acceptance Consulte o [Fluxo Completo](./end-to-end) para o contexto completo da chamada de aceite, incluindo os demais campos obrigatórios. ## Campo `purchaser_document_number` | Campo | Tipo | Obrigatoriedade | Descrição | |---|---|---|---| | `purchaser_document_number` | string | Opcional | CNPJ (14 dígitos) do cessionário a ser utilizado nesta operação. Sobrescreve o cessionário padrão do parceiro. | :::info Se o campo `purchaser_document_number` for omitido, a operação utilizará o cessionário padrão configurado para o parceiro na QI Tech. ::: :::caution O campo `purchaser_document_number` só pode ser definido no momento do aceite (POST). Não é possível alterá-lo posteriormente via endpoints de correção (PUT). ::: ## Exemplo de Request Body O exemplo abaixo destaca o uso do campo `purchaser_document_number` junto aos campos `financial` e `disbursement_bank_accounts`: ```json { "financial": { "installment_face_value": 379.87, "monthly_interest_rate": 0.0166, "number_of_installments": 84, "limit_days_to_disburse": 7, "disbursement_date": "2024-07-02", "rebates": [] }, "disbursement_bank_accounts": [ { "document_number": "92093764000197", "branch_number": "0001", "name": "TESTE LTDA", "percentage_receivable": 100, "account_number": "120012", "account_digit": "3", "bank_code": "329" } ], "purchaser_document_number": "28534595027164" } ``` O campo `purchaser_document_number` deve conter o CNPJ do cessionário desejado, com 14 dígitos numéricos sem formatação. --- # Consultas e Enumeradores URL: /documentation/guides/INSS/portability+refinancing/consultas-e-enumeradores Consultas e Enumeradores Endpoints auxiliares e tabelas de referência para o fluxo de Port+Refin INSS. ## 9 - Consulta de Lista de Participantes do CTC - CIP: **Request** - MÉTODO GET - ENDPOINT /v2/credit_transfer/participants Testar no Playground *Response:* **response.json** ```json [ { "name": "\", "bank_code": "\", "ispb": "\" } ] ``` ## 10 - Recuperar resposta da última request O last response é uma forma de mapear, de forma simples e objetiva, a resposta da comunicação entre a QI e a Dataprev, possibilitando saber quando essa requisição foi feita e qual o retorno obtido (através de um enumerador). Os enumeradores estão diretamente relacionados aos códigos de retorno da Dataprev e são divididos em duas formas: "errors" e "success". Cada enumerador tem uma descrição detalhada e o código de referência da Dataprev. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response. ### Casos de sucesso #### Request - Credit Transfer ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /CREDIT-OPERATION-TYPE/collateral MÉTODO GET #### PATH PARAMETERS credit-operation-type | Enumerador | Descrição | |-------------------------------------------|--------------------------------| | refinancing_credit_operation | Operação de refinanciamento | | portability_credit_operation | Operação de portabilidade | #### Response Response Body ```json { "collateral_data":{ "benefit_number":1976703155, "state":"PI", "last_response":{ "success":[ { "enumerator":"succesfully_included", "reservation_method":"portability" } ] }, "last_response_event_datetime":"2023-05-22T19:13:02Z", "status":"reserved" }, "collateral_constituted":true, "collateral_type":"social_security" } ``` ### Detalhamento de campos no retorno da request | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_response_enumerator_success)| | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ### Casos de erro #### Request ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /CREDIT-OPERATION-TYPE/collateral MÉTODO GET #### Response Response Body ```json { "collateral_constituted": false, "collateral_type": "type", "updated_at": "2023-05-24 19:13:02", "collateral_data": { "state": "SP", "benefit_number": 1976703155, "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "benefit_blocked_by_tbm", "reservation_method" : "portability" }, { "enumerator": "benefit_blocked_by_tbm", "reservation_method" : "new_credit" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z" } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_response_enumerator_errors) | | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ## 11 - Webhook de resposta da última tentativa de averbação Caso a operação não tenha sucesso na averbação, a mesma ficará em retentativa e será enviado o seguinte webhook, detalhando o motivo da não averbação, o horário desta tentativa e o método de averbação utilizado: **Ver exemplos de webhook** **Webhook portabilidade** WEBHOOK_TYPE credit_transfer.proposal.credit_operation ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "portability", "credit_operation_key": "\", "collateral_type": "social_security", "collateral_constituted": false, "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [{ "enumerator": "consignable_margin_excceded" }] }, "last_response_event_datetime": "2023-05-22T19:13:02Z", "reservation_method": "new_credit", } } } ``` **Webhook refinanciamento** WEBHOOK_TYPE credit_operation.collateral ```json { "webhook_type": "credit_operation.collateral", "key": "\", "event_time": "2022-11-24T15:42:12", "data": { "collateral_type": "social_security", "collateral_constituted": false, "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [{ "enumerator": "consignable_margin_excceded" }] }, "last_response_event_datetime": "2023-05-22T19:13:02Z", "reservation_method": "refinancing", } } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_response_enumerator_errors) | | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ## 12 - Consulta de portabilidade de origem É possível consultar os dados da portabilidade do banco de origem como, por exemplo, o número do benefício, a data de início da portabilidade, o número dos contratos excluídos, os valores das parcelas desaverbadas, ultima parcela paga, data de exclusão, entre outros. **Request** - MÉTODO POST - ENDPOINT /social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract *Payload:* **payload.json** ```json { "request_type":"portability_number", "portability_number": "202402070000298096242" } ``` **Response** - MÉTODO POST - ENDPOINT /social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract **body.json** ```json { "origin_contract_request_key": "9bb68c89-4b88-400d-9359-99ad8d42a69e", "status": "pending_search", "status_events": [ { "status": "pending_search" } ] } ``` Em caso de sucesso na consulta do número de benefício **Webhook** - WEBHOOK_TYPE social_security_portability_origin_contract_request - STATUS Success **body.json** ```json { "webhook": { "key": "25e93655-4713-488b-8800-7ac4fddf745f", "data": { "portability_number": 9223372036854776000, "portability_status": "open", "benefit_number": 1544326820, "portability_start_date": "2024-02-22", "deleted_contracts": [ { "origin_bank": { "bank_code": 752, "name": "CETELEM-BNP" }, "contract_number": "22-844817807/20", "last_installment_paid": 84, "exclusion_date": "22022024", "period_amount": 165.73 } ] }, "status": "success", "webhook_type": "social_security_portability_origin_contract_request", "event_datetime": "2024-02-26T21:36:22" } } ``` Em caso de falha na consulta do número de benefício **Webhook** - WEBHOOK_TYPE social_security_portability_origin_contract_request - STATUS Failure **body.json** ```json { "webhook": { "key": "522b5d7d-2dfc-4e92-99b7-d4df3d97edb2", "data": { "enumerator": "invalid_bank_code", "description": "Invalid bank code" }, "status": "failure", "webhook_type": "social_security_portability_origin_contract_request", "event_datetime": "2024-02-26T21:36:22" } } ``` ## 13. Diminuir o valor das parcelas Este endpoint permite a redução do valor das parcelas de um contrato de portabilidade de crédito. Esta funcionalidade é especialmente útil em casos onde a margem consignável é excedida devido ao banco de origem desaverbar uma quantia menor do que a esperada. **Request** - MÉTODO PUT - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /portability_credit_operation *Payload:* **payload.json** ```json { "installment_face_value": 382.18 } ``` **Response sucesso - HTTP 200** **body.json** ```json { "credit_operation_key": "7aa77bca-c724-4c1a-bfae-9b1b7bd81ab2", "contract_number": "0000000007/WO", "document_key": "045a8f35-6170-4112-8d83-29a753d0c78e", "document_url": "http://teste.com", "signed_url": "signed_url_test", "credit_operation_status": "waiting_signature", "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_accounts": [ { "account_digit": "3", "account_branch": "0001", "account_number": "94134", "ispb": "32402502", "name": "Wilker Teste", "document_number": "37197645832" } ], "disbursement_options": [ { "prefixed_interest_rate": { "annual_rate": 3.0, "daily_rate": 0.00385824, "interest_base": "calendar_days", "monthly_rate": 0.12246205 }, "total_iof": 7.03, "external_contract_fee_amount": 0.0, "external_contract_fees": [], "contract_fee_amount": 0.0, "number_of_installments": 3, "contract_fees": [], "disbursed_issue_amount": 1000.0, "issue_amount": 1007.03, "disbursement_date": "2022-08-24", "cet": 12.6, "annual_cet": 315.3944, "installments": [ { "business_due_date": "2022-08-30", "calendar_days": 5, "due_date": "2022-08-29", "due_principal": 1007.03, "installment_number": 1, "pre_fixed_amount": 84.43554587915118, "principal_amortization_amount": 297.73445412084885, "total_amount": 382.17, "workdays": 3 }, { "business_due_date": "2022-09-30", "calendar_days": 31, "due_date": "2022-09-29", "due_principal": 709.2955458791512, "installment_number": 2, "pre_fixed_amount": 47.97894031795043, "principal_amortization_amount": 334.19105968204957, "total_amount": 382.17, "workdays": 22 }, { "business_due_date": "2022-11-01", "calendar_days": 32, "due_date": "2022-10-31", "due_principal": 375.1044861971016, "installment_number": 3, "pre_fixed_amount": 7.055513802898396, "principal_amortization_amount": 375.1044861971016, "total_amount": 382.16, "workdays": 21 } ], "final_disbursement_amount": 997.87 } ], "final_disbursement_amount": 997.87, "collateral_is_constituted": false } ``` ## 14. Mapeamento de enumeradores ### Enumeradores Retention Reason {#retention_reason_enumerator} | Enumerador | Descrição | |------------------------------------------|--------------------------------------------------------| | **issuer_retention** | Retenção do Cliente | | **different_from_original** | Condições da proposta divergentes do contrato original | | **issuer_lawsuit** | Cliente com ação judicial | | **insurance_in_progress** | Indenização de seguro em andamento | | **collateral_in_execution** | Garantia em Execução | | **contract_not_found** | Contrato não encontrado | | **invalid_contract_type** | Tipo de contrato inválido | | **portability_in_progress** | Portabilidade em andamento | | **assigned_contract** | Contrato cedido | | **issuer_document_number_invalid** | CPF não é do contrato | | **unrelated_issuer_document_number** | CPF informado não é o do titular | | **assigned_without_co_obligation** | Contrato cedido sem coobrigação | | **fgts_in_use** | FGTS AMORTIZAR em uso | | **fgts_funding** | FGTS funding | | **portability_not_requested** | O cliente não solicitou a portabilidade | | **wrong_original_financial_institution** | IF Credora Original Incorreta | ### Tabela de retorno de erros Dataprev - averbação {#dataprev_response_enumerator_errors} | Código Dataprev | Enumerador | Descrição | Ação Qi | |-----------------|--------------------------------------------------|-------------------------------------------------------------|----------------------| | HW | consignable_margin_excceded | Exceeded consignable margin | Teimosinha | | IT | benefit_blocked_by_tbm | Benefit blocked due to benefit transfer | Teimosinha | | IE | benefit_blocked_by_beneficiary | Benefit blocked by beneficiary | Teimosinha | | AN | invalid_disbursement_account | Invalid disbursement bank account | Teimosinha | | HX | reservation_already_included | Reservation already included | Confirmar averbação | | IF | benefit_blocked_by_granting_process | Benefit blocked during granting process | Teimosinha | | AV | processing_payroll | Operation couldn`t be done during processing payroll period | Teimosinha | | OF | invalid_cbc | Invalid cbc | Teimosinha | | IA | first_name_mismatch | First name mismatch benefit owner or legal representative | Teimosinha | | OS | legal_representative_document_number_mismatch | Document number mismatch legal representative | Teimosinha | | AY | invalid_state | Invalid state | Teimosinha | | HZ | operation_not_allowed_on_this_reservation_status | Operation couldn`t be done with current reservation status | Teimosinha | | AP | invalid_contract_date | Accrual, end or start contract date is invalid | Teimosinha | | GA | required_fields_missing | Required fields are missing | Teimosinha | | BC | cbc_missing | CBC is missing | Teimosinha | | NC | contract_number_missing | Contract number is missing | Teimosinha | | NB | benefit_number_missing | Benefit number is missing | Teimosinha | | CA | invalid_bank_code | Invalid bank code | Teimosinha | | HR | exceeded_number_of_allowed_contracts | Amount of contracts is above the limit | Teimosinha | | PV | invalid_image_format | Image with wrong format | Teimosinha | | IR | operation_not_allowed_IR | Operation date is greater than benefit expiration | Teimosinha | | PK | wrong_bank_code_destination | Portability number was found with wrong bank code destination| Teimosinha | | PH | wrong_benefit_number_on_portability | Portability number was found with wrong benefit number | Teimosinha | | PI | invalid_contract_total_amount | Reservation contract total amount should be greater than Dataprev reference amount | Teimosinha | :::danger Atenção! Todas as taxas e valores do contrato são validados no momento da criação da reserva. A crítica "invalid_contract_total_amount" ocorre nos casos em que os contratos se estendem por muito tempo sem serem averbados, o que impacta os valores previamente estabelecidos. ::: ### Tabela de retorno de sucesso - averbação {#dataprev_response_enumerator_success} | Código Dataprev | Enumerador | Descrição | |--------|--------------------------|-----------------------------------------| | BD | successfully_included | Inclusion has been successfully done | | BF | successfully_removed | Removal has been successfully done | | BR | successfully_reactivated | Reactivation has been successfully done | | BS | successfully_suspended | Suspension has been successfully done | ### Tabela de retorno de erros na consulta de saldo {#dataprev_balance_errors_enumerators} | Código | Enumerador | Descrição | |--------|---------------------------------------|---------------------------------------------------------------------------------| | CR | not_found_legal_representative | no legal representative for the beneficiary | | CD | inexistent_beneficiary | no beneficiary found | | AS | benefity_without_legal_representative | beneficiary does not have a legal representative | | BI | inexistent_benefit | no benefit found | | D1 | inconsistent_balance_benefit_data | The balance benefit data registered is either inconsistent, null or incomplete. | ### Tabela de retorno de erros na consulta de benefícios {#dataprev_benefits_errors_enumerators} | Código | Enumerador | Descrição | |--------|---------------------------------------|---------------------------------------------------------------------------------| | CR | not_found_legal_representative | no legal representative for the beneficiary | | CD | inexistent_beneficiary | no beneficiary found | | AS | benefity_without_legal_representative | beneficiary does not have a legal representative | ### Tabela de situação de benefícios {#benefit_situation_enumerator} | Items | |-------| | active | | excluded | | terminated | | suspended | | suspended_by_CONPAG | | terminated_by_SISOBI | | receiving_monthly_recover_6_months | | receiving_monthly_recover_18_months | | suspended_by_name_error | | suspended_by_credentialed_payer | | suspended_by_inspection | | suspended_by_audit | | terminated_by_inspection | | terminated_by_audit | | receiving_monthly_recover_6_months_inspection | | receiving_monthly_recover_18_months_inspection | | suspended_by_SISOBI | | canceled_by_audit | ### Tabela de status de benefícios {#benefit_status_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | Elegible | Elegível para empréstimo | | Inelegible | Benefício inelegível para empréstimo | | Blocked | Benefício elegível, porém bloqueado para empréstimo | ### Tabela de tipos de bloqueio {#block_type_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | 0 | Sem bloqueio | | 1 | Bloqueado pelo Segurado | | 2 | Bloqueado por TBM | | 3 | Bloqueado na Concessão | ### Tabela de tipos de politicamente exposto {#politically_exposed_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | 0 | Pessoa Não Exposta Politicamente | | 1 | Pessoa Exposta Politicamente - Nível 1 | ### Tabela de benefícios {#benefit_type_enumerator} | código | benefício | | --- | ------------------------------------------------ | | 1 | pension_by_death_rural_worker | | 2 | pension_by_death_accident_rural_worker | | 3 | pension_by_death_rural_employer | | 4 | retirement_invalidity_rural_emploee | | 5 | retirement_invalidity_accident_rural_worker | | 6 | retirement_invalidity_rural_employer | | 7 | retirement_by_eldness_rural_worker | | 8 | retirement_by_age_rural_employer | | 9 | complement_by_work_accident_rural_worker | | 11 | support_invalidity_rural_worker | | 12 | support_by_age_rural_worker | | 13 | aid_sickness_rural_worker | | 15 | aid_time_off_rural_worker | | 16 | aid_federal | | 17 | international_agreement | | 18 | inclusion_benefit | | 19 | pension_student_law7004 | | 20 | pension_by_death_diplomat | | 21 | pension_by_death | | 22 | pension_by_death_statute | | 23 | pension_by_death_veteran | | 24 | pension_special_institutional_act | | 25 | aid_time_off | | 26 | pension_by_death_special_law593 | | 27 | pension_by_death_federal_emploee | | 28 | pension_by_death_general_regime_law20465 | | 29 | pension_by_death_marine_veteran | | 30 | monthly_income_lifetime_invalidity | | 31 | aid_sickness | | 32 | retirement_invalidity_social_security | | 33 | retirement_invalidity_aeronautic | | 34 | retirement_invalidity_marine_law1756 | | 35 | aid_sickness_veteran | | 36 | aid_social_security_accident | | 37 | retirement_capin_extra_emploee | | 38 | retirement_federal_extra_emploee | | 39 | aid_invalidity_student_law7004 | | 40 | monthly_income_lifetime_by_age_upper70_law6179 | | 41 | retirement_by_age | | 42 | retirement_by_contribution_time | | 43 | retirement_by_time_of_service_veteran | | 44 | retirement_special_aeronautic | | 45 | retirement_by_time_of_service_journalist | | 46 | retirement_special | | 47 | allowance_25 | | 48 | allowance_20 | | 49 | retirement_ordinary | | 50 | aid_sickness_extinct_basic_plan | | 51 | retirement_invalidity_extinct_basic_plan | | 52 | retirement_by_age_extinct_basic_plan | | 53 | aid_time_off_extinct_basic_plan | | 54 | pension_indemnity_federal | | 55 | pension_by_death_extinct_basic_plan | | 56 | pension_lifetime_syndrome_thalidomide | | 57 | retirement_by_teacher_labor_time | | 58 | retirement_anisty | | 59 | pension_by_death_amnesty | | 60 | indemnity | | 61 | aid_birth | | 62 | aid_funeral | | 63 | aid_funeral_rural_worker | | 64 | aid_funeral_rural_employer | | 65 | savings_special_autarchy | | 67 | savings_mandatory_ipase_law5128 | | 68 | savings_special_retirement_ps_affiliated_upper60 | | 69 | savings_student_law7004 | | 70 | restitution | | 71 | monthly_income | | 72 | retirement_by_time_of_service_law1756 | | 73 | monthly_income_family_statute | | 74 | complement_pension_federal | | 75 | complement_retirement_federal | | 76 | monthly_income_statute | | 77 | monthly_income_sinpas_family_statute | | 78 | retirement_by_age_law1756 | | 79 | advantage | | 80 | monthly_income_maternity | | 81 | compulsory_retirement | | 82 | retirement_by_time_of_service_sasse | | 83 | retirement_invalidity_ex_sasse | | 84 | pension_by_death_sasse | | 85 | pension_lifetime_rubber_tapper_law7986 | | 86 | pension_lifetime_rubber_tapper_dependent_law7986 | | 87 | continuous_aid_physical_disabilities | | 88 | continuous_aid_eldness | | 89 | pension_special_hemodialysis_victim_caruaru | | 90 | medic_assistency_work_accident | | 91 | aid_sickness_by_work_accident | | 92 | retirement_invalidity_work_accident | | 93 | pension_by_death_work_accident | | 94 | aid_work_accident | | 95 | aid_additional_work_accident | | 96 | pension_special_leprosy_law11520 | | 97 | savings_by_death_work_accident | | 98 | aid_longshoreman | | 99 | time_off_15 | --- # Portabilidade + Refin URL: /documentation/guides/INSS/portability+refinancing/end-to-end Fluxo Completo - Portabilidade + Refinanciamento :::danger 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. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: Para iniciar o processo de Portabilidade + Refinanciamento - INSS, primeiramente é necessário coletar os dados do benefício para checagem da elegibilidade como também os dados da conta de pagamento do benefício. Os itens 1 e 2, descrevem o procedimento para consulta da lista de benefícios de um determinado beneficiário e procedimento para consulta dos dados do benefício. Para acompanhamento dos status após a formalização, consulte [Máquinas de Status](./maquinas-de-status). ## 1 - Consulta da lista de benefícios com formalização do Termo de Autorização realizada através do parceiro: **1.1.** Titular do benefício é o assinante do Termo de Autorização. **Request** - ENDPOINT /social_security/benefits_request - MÉTODO POST Testar no Playground *Payload:* **payload.json** ```json { "document_number": "16514548091", "authorization_term": { "document_number": "16514548091", "signature": { "signer": { "name": "Nome Devedor", "phone": { "number": "887577622", "area_code": "19", "country_code": "55" }, "document_number": "16514548091" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2023-12-05T21:04:06", "ip_address": "200.223.171.82", "fingerprint": { "lat": "-44.00524157713981", "long": "-19.807649431219804", "name": "Nome Cliente", "model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1", "localeHashValue": "hash cliente" }, "third_party_additional_data": {}, "session_id": "3571e292-3a83-4011-904d-20ee963022ef" }, "signed_object": { "document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b" } } } } ``` **1.2.** Titular do benefício **não** é o assinante do Termo de Autorização (com representante legal). :::caution Atenção Como o assinante do termo nesse caso é o representante legal, os dados que preenchem o objeto **signer**, são os dados do representante legal. ::: **Request** - ENDPOINT /social_security/benefits_request - MÉTODO POST *Payload:* **payload.json** ```json { "document_number": "16514548091", "authorization_term": { "document_number": "16514548091", "legal_representative_document_number": "70957091060", "signature": { "signer": { "name": "Nome Representante legal", "phone": { "number": "887577622", "area_code": "19", "country_code": "55" }, "document_number": "70957091060" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2023-12-05T21:04:06", "ip_address": "200.223.171.82", "fingerprint": { "lat": "-44.00524157713981", "long": "-19.807649431219804", "name": "Nome Cliente", "model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1", "localeHashValue": "hash cliente" }, "third_party_additional_data": {}, "session_id": "3571e292-3a83-4011-904d-20ee963022ef" }, "signed_object": { "document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b" } } } } ``` :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: --- "**document_key**": utilizar a GUID retornada no endpoint /upload :::info **Ao invés** da chave do documento pdf assinado no objeto **"authorization_term.signed_object.document_key"**, também é possível enviar o texto corrido do Termo de Autorização, através do objeto **"authorization_term.signed_object.raw_text"**. ::: **Response** - MÉTODO POST - ENDPOINT social_security/benefits_request **body.json** ```json { "benefits_request_key": "c9d2aa83-006b-4753-92ad-64411a7aa700", "document_number": "18028522041", "status": "pending_authorization", "authorization_term": { "authorization_term_key": "5a7b6489-8a47-4b61-a85a-6986b058fda6", "status": "signed" }, "status_events": [ { "status": "pending_authorization", "event_date": "2023-12-22T16:12:50" } ] } ``` Em caso de sucesso na consulta da lista de benefícios: **Webhook** - WEBHOOK_TYPE social_security_benefits_request - STATUS Success **body.json** ```json { "webhook": { "key": "54cddd0f-b976-4266-91ea-90279bfb49a1", "data": [ { "grant_date": [ "2010-10-18" ], "benefit_number": 2052711150, "benefit_status": "elegible" } ], "status": "success", "webhook_type": "social_security_benefits_request", "event_datetime": "2023-12-22T13:20:44" } } ``` | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | benefit_number | Número do beneficio | - | | benefit_status | Status do beneficio | [Enumeradores](#benefit_status_enumerator) | Em caso de falha na consulta da lista de benefícios: **Webhook** - WEBHOOK_TYPE social_security_benefits_request - STATUS Failure **body.json** ```json { "webhook": { "key": "0020653e-c3b0-4606-af31-2ea4a577a5ce", "data": { "enumerator": "inexistent_beneficiary", "description": "no beneficiary found" }, "status": "failure", "webhook_type": "social_security_benefits_request", "event_datetime": "2023-12-22T15:46:31" } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_benefits_errors_enumerators) | ### Simulando cenários de sucesso e insucesso na consulta de benefício em Sandbox: A simulação de cenários é baseado no primeiro dígito do CPF informado na operação. **11.1.** Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook. **11.2.** Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo. | Início do CPF | Enumerador | Descrição | |---------------|------------------------|----------------------| | 2 | inexistent_beneficiary | no beneficiary found | :::caution Atenção Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado. | Enumerador | Descrição | |---------------|------------------------------------------------------------------| | mock_error | Informed document number is not a valid mock on test environment | ::: --- ## 2 - Consulta de dados do benefício {#consulta-de-dados} **2.1.** Consulta de dados do benefício com o Termo de Autorização previamente enviado. **Request** - MÉTODO POST - ENDPOINT /social_security/balance_request Testar no Playground *Payload:* **payload.json** ```json { "document_number": "16514548091", "benefit_number": 2052711150 } ``` **Response** - MÉTODO POST - ENDPOINT /social_security/balance_request **body.json** ```json { "balance_request_key": "ffda1935-9cad-47df-b848-cd33c96024e4", "document_number": "16514548091", "status": "pending_authorization", "authorization_term": { "authorization_term_key": "19196811-366f-4422-a729-4d0aa552449b", "status": "allowed" }, "status_events": [ { "status": "pending_authorization", "event_date": "2023-12-22T16:18:18" } ] } ``` **2.2.** Consulta de dados do benefício com envio do Termo de Autorização. **Request** - MÉTODO POST - ENDPOINT /social_security/balance_request *Payload:* **payload.json** ```json { "document_number": "14950479032", "benefit_number": 22255220, "authorization_term": { "document_number": "14950479032", "legal_representative_document_number": "32866210050", // CPF do representante legal (caso aplicável) "signature": { "signer": { "name": "Nome Cliente", "phone": { "number": "887577622", "area_code": "19", "country_code": "55" }, "document_number": "14950479032" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2023-12-05T21:04:06", "ip_address": "200.223.171.82", "fingerprint": { "lat": "-44.00524157713981", "long": "-19.807649431219804", "name": "Nome Cliente", "model": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1", "localeHashValue": "hash cliente" }, "third_party_additional_data": {}, "session_id": "b75c7ac2-3be3-41b6-b769-4d982a5824a2" }, "signed_object": { "document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b" } } } } ``` :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: --- **Response** - MÉTODO POST - ENDPOINT /social_security/balance_request **body.json** ```json { "balance_request_key": "ffda1935-9cad-47df-b848-cd33c96024e4", "document_number": "14950479032", "status": "pending_authorization", "authorization_term": { "authorization_term_key": "19196811-366f-4422-a729-4d0aa552449b", "status": "signed" }, "status_events": [ { "status": "pending_authorization", "event_date": "2023-12-22T16:18:18" } ] } ``` Em caso de sucesso na consulta de dados do benefício **Webhook** - WEBHOOK_TYPE /social_security/balance_request - STATUS Success **body.json** ```json { "webhook": { "key": "ffda1935-9cad-47df-b848-cd33c96024e4", "data": { "name": "IVOLANDO MIRANDA", "state": "SP", "alimony": "not_payer", "birth_date": "07021961", "grant_date": "2022-09-02", "credit_type": "checking_account", "block_type": "not_blocked", "benefit_card": { "limit": 2083.2, "balance": 0 }, "benefit_number": "22255220", "benefit_status": "elegible", "payroll_card": { "limit": 2083.2, "balance": 0 }, "assistance_type": "retirement_by_age", "document_number": "14950479032", "benefit_end_date": "2020-12-01", "consigned_credit": { "balance": 1000 }, "benefit_situation": "active", "max_total_balance": 2000, "used_total_balance": 1000, "politically_exposed": { "type": "politically_exposed_level_1", "is_politically_exposed": true }, "has_power_of_attorney": false, "available_total_balance": 1000, "has_judicial_concession": false, "number_of_portabilities": 0, "disbursement_bank_account": { "bank_code": "341", "account_digit": "6", "account_branch": "0155", "account_number": "000059923" }, "has_entity_representation": false, "social_benefit_max_balance": 2000, "social_benefit_used_balance": 1000, "benefit_quota_expiration_date": null, "number_of_active_reservations": 0, "number_of_suspended_reservations": 0, "number_of_refinanced_reservations": 0, "number_of_active_suspended_reservations": 3 }, "status": "success", "webhook_type": "social_security_balance_request", "event_datetime": "2023-12-22T16:18:21" } } ``` ### Detalhamento de campos no webhook de sucesso | Campo | Descrição | Valores | |---------------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| | assistance_type | Tipo do benefício | [Enumeradores](#benefit_type_enumerator) | | benefit_status | Status do beneficio | [Enumeradores](#benefit_status_enumerator) | | has_entity_representation | Possui entidade de representação (não permite averbação) | True ou False | | alimony_code | Classificador da Pensão alimentícia | not_payer, payer, benefit | | has_judicial_concession | Benefício concedido por liminar | True ou False | | has_power_of_attorney | Possui procurador? | True ou False | | credit_type | Tipo de crédito - recebimento do benefício | Magnetic_card, checking_account | | benefit_situation | Situação do benefício | [Enumeradores](#benefit_situation_enumerator) | | used_total_balance | Valor total comprometido em averbações de empréstimos, reservado para portabilidade, refinanciamento, alterações, RMC e RCC | Numérico | | max_total_balance | Valor comprometido possível para a respectiva espécie do benefício | Numérico | | available_total_balance | Valor total disponível para empréstimo, somando todas as modalidades (diferença entre max_total_balance e used_total_balance) | Numérico | | benefit_quota_expiration_date | Data de extinção do benefício. A informação está disponível apenas para alguns benefícios de pensão por morte. | String ou nulo | block_type | Tipo de bloqueio do benefício | [Enumeradores](#block_type_enumerator) | politically_exposed.type | Pessoa politicamente exposta | [Enumeradores](#politically_exposed_enumerator) | is_politically_exposed | Pessoa politicamente exposta | True ou False Em caso de falha na consulta da lista de benefícios **Webhook** - WEBHOOK_TYPE /social_security/balance_request - STATUS Failure **body.json** ```json { "webhook": { "key": "37a14593-b934-457c-8cf6-e51f184b1f1c", "data": { "enumerator": "inexistent_beneficiary", "description": "no beneficiary found" }, "status": "failure", "webhook_type": "social_security_balance_request", "event_datetime": "2023-12-22T16:22:29" } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código Dataprev | [Enumeradores](#dataprev_balance_errors_enumerators) | ### Simulando cenários de sucesso e insucesso na consulta de dados do benefício em Sandbox: A simulação de cenários é baseado no primeiro dígito do CPF informado na operação. **11.1.** Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook. **11.2.** Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo. | Início do CPF | Enumerador | Descrição | |---------------|------------------------|----------------------| | 2 | inexistent_beneficiary | no beneficiary found | :::caution Atenção Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado. | Enumerador | Descrição | |---------------|------------------------------------------------------------------| | mock_error | Informed document number is not a valid mock on test environment | ::: **11.3.** O CPF `18166261553` simula, com sucesso (HTTP 200, sem erro), um benefício com **margem consignável negativa** (`available_total_balance: -7.84`). Use este CPF para testar a rejeição de novas operações quando o beneficiário já excedeu a margem disponível. Lista completa de CPFs e cenários mockados: [Mocks (Sandbox)](/documentation/guides/INSS/mocks-sandbox). --- ## 3 - Simulando Proposta de Portabilidade e/ou Refinanciamento: :::caution Atenção Para propostas que envolvam troco após o refinanciamento, é necessário o valor do troco calculado de acordo com as condições do contrato seja de pelo menos 5% da diferença entre a soma de todas as parcelas do refinanciamento subtraida da soma de todas as parcelas da portabilidade. Caso contrário, a requisição receberá o seguinte erro: STATUS 400 **Response Body** ```json { "title": "Bad Request", "code": "CT000118", "description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.", "translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00." } ``` ::: **3.1. Simulação de Portabilidade com Refinanciamento:** Antes de realizar a digitação da Proposta de Portabilidade com Refinanciamento, é possível simular as condições financeiras da proposta, sem a necessidade de coletar os dados cadastrais do cliente. **Ver exemplos de payload (Taxa Fixa / Valor Liberado Fixo)** **Com Taxa Fixa** **3.1.1. Simulação de Portabilidade com Refinanciamento, com taxa fixa:** Assim como na Digitação da Proposta (4.1.1), é possível realizar a simulação fixando a taxa do contrato: **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal_simulation *Request:* **body.json** ```json { "borrower": { "person_type": "natural" }, "collaterals": [{ "collateral_type": "social_security" }], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 } }, "refinancing_credit_operation": { "financial": { "days_to_accrual": 0, "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 } }, "origin_contract": { "last_due_balance": 997.87 } } ``` :::info No payload acima, são descritos os dados mínimos para realização da simulação. ::: **Response** - MÉTODO POST - STATUS /v2/credit_transfer/proposal_simulation *Payload:* **response.json** ```json { "borrower": { "individual_document_number": "98765432100", "related_party_key": "fa55dca3-3147-45d2-bb8d-941f2d7191da", "role_type": "issuer" }, "portability_credit_operation": { "credit_operation_key": "a66675e6-bdc2-4468-8420-2889d5cec0a8", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.173044, "cet": 0.0134, "contract_fee_amount": 0.0, "contract_fees": [ { "amount": 0.5, "amount_type": "percentage", "fee_amount": 0.0, "fee_type": "tac" } ], "disbursed_issue_amount": 997.87, "disbursement_date": "2023-12-22", "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": "spread", "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": "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": "insurance_premium", "irrf_amount": 0, "net_fee_amount": 0.0, "pis_amount": 0, "tax_amount": 0.0 } ], "installments": [ { "business_due_date": "2024-02-22", "calendar_days": 62, "due_date": "2024-02-22", "due_principal": 997.87, "installment_number": 1, "pre_fixed_amount": 27.413791524708554, "principal_amortization_amount": 81.34620847529145, "total_amount": 108.76, "workdays": 40 }, { "business_due_date": "2024-03-22", "calendar_days": 29, "due_date": "2024-03-22", "due_principal": 916.5237915247086, "installment_number": 2, "pre_fixed_amount": 11.692366920719124, "principal_amortization_amount": 97.06763307928088, "total_amount": 108.76, "workdays": 21 }, { "business_due_date": "2024-04-22", "calendar_days": 31, "due_date": "2024-04-22", "due_principal": 819.4561584454277, "installment_number": 3, "pre_fixed_amount": 11.179911547915339, "principal_amortization_amount": 97.58008845208467, "total_amount": 108.76, "workdays": 20 }, { "business_due_date": "2024-05-22", "calendar_days": 30, "due_date": "2024-05-22", "due_principal": 721.876069993343, "installment_number": 4, "pre_fixed_amount": 9.5288330736045, "principal_amortization_amount": 99.2311669263955, "total_amount": 108.76, "workdays": 21 }, { "business_due_date": "2024-06-24", "calendar_days": 33, "due_date": "2024-06-24", "due_principal": 622.6449030669476, "installment_number": 5, "pre_fixed_amount": 9.046812945831448, "principal_amortization_amount": 99.71318705416856, "total_amount": 108.76, "workdays": 22 }, { "business_due_date": "2024-07-22", "calendar_days": 28, "due_date": "2024-07-22", "due_principal": 522.9317160127789, "installment_number": 6, "pre_fixed_amount": 6.439743824282488, "principal_amortization_amount": 102.32025617571752, "total_amount": 108.76, "workdays": 20 }, { "business_due_date": "2024-08-22", "calendar_days": 31, "due_date": "2024-08-22", "due_principal": 420.61145983706143, "installment_number": 7, "pre_fixed_amount": 5.738438681013405, "principal_amortization_amount": 103.0215613189866, "total_amount": 108.76, "workdays": 23 }, { "business_due_date": "2024-09-23", "calendar_days": 32, "due_date": "2024-09-23", "due_principal": 317.58989851807485, "installment_number": 8, "pre_fixed_amount": 4.473657660291388, "principal_amortization_amount": 104.28634233970861, "total_amount": 108.76, "workdays": 22 }, { "business_due_date": "2024-10-22", "calendar_days": 29, "due_date": "2024-10-22", "due_principal": 213.30355617836625, "installment_number": 9, "pre_fixed_amount": 2.721176981322744, "principal_amortization_amount": 106.03882301867725, "total_amount": 108.76, "workdays": 21 }, { "business_due_date": "2024-11-22", "calendar_days": 31, "due_date": "2024-11-22", "due_principal": 107.26473315968899, "installment_number": 10, "pre_fixed_amount": 1.4934220715493307, "principal_amortization_amount": 107.26657792845067, "total_amount": 108.76, "workdays": 22 } ], "issue_amount": 997.87, "number_of_installments": 10, "prefixed_interest_rate": { "annual_rate": 0.17042118, "daily_rate": 0.00043722, "interest_base": "calendar_days", "monthly_rate": 0.0132 }, "total_iof": 0.0 } ], "final_disbursement_amount": 0.0 }, "proposal_key": "28a925f6-570e-4724-9132-3bd42f267c4f", "proposal_number": "17032788499215403", "proposal_status": "pending_submission", "refinancing_credit_operation": { "credit_operation_key": "aaf9abe0-2b8a-4688-8e09-413e1bd5285e", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.172031, "cet": 0.0133, "contract_fee_amount": -0.4, "contract_fees": [ { "amount": 0.5, "amount_type": "percentage", "fee_amount": -0.4, "fee_type": "tac" } ], "disbursed_issue_amount": 918.04, "disbursement_date": "2023-12-22", "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": "spread", "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": "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": "insurance_premium", "irrf_amount": 0, "net_fee_amount": 0.0, "pis_amount": 0, "tax_amount": 0.0 } ], "installments": [ { "business_due_date": "2024-02-22", "calendar_days": 62, "due_date": "2024-02-22", "due_principal": 917.64, "installment_number": 1, "pre_fixed_amount": 25.2095730147, "principal_amortization_amount": 74.7904269853, "total_amount": 100.0, "workdays": 40 }, { "business_due_date": "2024-03-22", "calendar_days": 29, "due_date": "2024-03-22", "due_principal": 842.8495730147, "installment_number": 2, "pre_fixed_amount": 10.7524369787, "principal_amortization_amount": 89.2475630213, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-04-22", "calendar_days": 31, "due_date": "2024-04-22", "due_principal": 753.6020099934, "installment_number": 3, "pre_fixed_amount": 10.2814172859, "principal_amortization_amount": 89.7185827141, "total_amount": 100.0, "workdays": 20 }, { "business_due_date": "2024-05-22", "calendar_days": 30, "due_date": "2024-05-22", "due_principal": 663.8834272793, "installment_number": 4, "pre_fixed_amount": 8.7632941742, "principal_amortization_amount": 91.2367058258, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-06-24", "calendar_days": 31, "due_date": "2024-06-22", "due_principal": 572.6467214535, "installment_number": 5, "pre_fixed_amount": 7.8126464787, "principal_amortization_amount": 92.1873535213, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-07-22", "calendar_days": 30, "due_date": "2024-07-22", "due_principal": 480.4593679322, "installment_number": 6, "pre_fixed_amount": 6.3420966342, "principal_amortization_amount": 93.6579033658, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-08-22", "calendar_days": 31, "due_date": "2024-08-22", "due_principal": 386.8014645664, "installment_number": 7, "pre_fixed_amount": 5.2771618926, "principal_amortization_amount": 94.7228381074, "total_amount": 100.0, "workdays": 23 }, { "business_due_date": "2024-09-23", "calendar_days": 31, "due_date": "2024-09-22", "due_principal": 292.078626459, "installment_number": 8, "pre_fixed_amount": 3.9848593609, "principal_amortization_amount": 96.0151406391, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-10-22", "calendar_days": 30, "due_date": "2024-10-22", "due_principal": 196.0634858199, "installment_number": 9, "pre_fixed_amount": 2.5880710578, "principal_amortization_amount": 97.4119289422, "total_amount": 100.0, "workdays": 22 }, { "business_due_date": "2024-11-22", "calendar_days": 31, "due_date": "2024-11-22", "due_principal": 98.6515568777, "installment_number": 10, "pre_fixed_amount": 1.3459361963, "principal_amortization_amount": 98.6540638037, "total_amount": 100.0, "workdays": 22 } ], "issue_amount": 917.64, "number_of_installments": 10, "prefixed_interest_rate": { "annual_rate": 0.17042118, "daily_rate": 0.00043722, "interest_base": "calendar_days", "monthly_rate": 0.0132 }, "total_iof": 0.0 } ], "final_disbursement_amount": -79.83 } } ``` **Com Valor Liberado Fixo** **3.1.2. Simulação de Portabilidade com Refinanciamento, com valor liberado fixo:** Assim como na digitação da proposta (**4.1.2**), é possível realizar a simulação fixando o valor liberado ao cliente: **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal_simulation *Payload:* **payload.json** ```json { "borrower": { "person_type": "natural" }, "collaterals": [{ "collateral_type": "social_security" }], "portability_credit_operation": { "financial": { "installment_face_value": 100, "number_of_installments": 10 } }, "refinancing_credit_operation": { "financial": { "days_to_accrual": 0, "disbursed_amount": 1000, "installment_face_value": 100, "number_of_installments": 10 } }, "origin_contract": { "last_due_balance": 997.87 } } ``` **Response** - MÉTODO POST - STATUS /v2/credit_transfer/proposal_simulation *Payload:* **payload.json** ```json { "portability_credit_operation": { "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [{ "installments": [{ "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-08-09", "calendar_days": 53, "due_date": "2021-08-08", "due_principal": 997.87, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-09-08", "calendar_days": 31, "due_date": "2021-09-08", "due_principal": 690.89, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 0, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 1000, "issue_amount": 1000, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 }] }, "refinancing_credit_operation": { "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [{ "installments": [{ "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-08-09", "calendar_days": 53, "due_date": "2021-08-08", "due_principal": 997.87, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-09-08", "calendar_days": 31, "due_date": "2021-09-08", "due_principal": 690.89, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 0, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 1000, "issue_amount": 1000, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 }] } } ``` **3.2. Simulação de Portabilidade:** Também é possível simular as condições financeiras de uma Proposta de Portabilidade (Portabilidade Pura), sem a necessidade de coletar os dados cadastrais do cliente. **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal_simulation *Payload:* **payload.json** ```json { "borrower": { "person_type": "natural" }, "collaterals": [{ "collateral_type": "social_security" }], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 } }, "origin_contract": { "last_due_balance": 997.87 } } ``` **Response** - MÉTODO POST - STATUS /v2/credit_transfer/proposal_simulation *Payload:* **payload.json** ```json { "portability_credit_operation": { "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [{ "installments": [{ "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-08-09", "calendar_days": 53, "due_date": "2021-08-08", "due_principal": 997.87, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-09-08", "calendar_days": 31, "due_date": "2021-09-08", "due_principal": 690.89, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 0, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 1000, "issue_amount": 1000, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 }] } } ``` --- ## 4 - Digitação da Proposta: :::caution Atenção Para que os pedidos de averbação, tanto da portabilidade, como do refinanciamento sejam criados com sucesso, é preciso que seja feita uma consulta de dados válida para o benefício **previamente**. Para isso basta seguir os passos do item [2 - Consulta de dados do benefício](#consulta-de-dados). ::: :::info Assinatura em grupo (opcional) Para reunir esta proposta com outras operações INSS do **mesmo beneficiário** e coletar **uma única assinatura**, envie `document_batch_group_key` na **raiz** do payload de criação da proposta. Nesse caso, a resposta **não retorna** `signature_information` — o link de assinatura é único e obtido no envio do grupo para assinatura. Consulte o fluxo de [Assinatura em grupo](/documentation/guides/INSS/signatures/batch-group-signature). ::: ### Falha na averbação por falta de uma consulta de dados válida do benefício Se uma consulta dos dados do benefício não for realizada com sucesso antes do pedido de averbação, o status do pedido de averbação ficará como "aguardando ação do parceiro" e será enviado um webhook no seguinte formato para informar o ocorrido: WEBHOOK_TYPE social_security_success_balance_request_not_found STATUS Pending requester action Webhook Body ```json { "webhook": { "key": "\", "data": { "enumerator": "success_balance_request_not_found", "description": "Success balance request not found for the specified benefit number" }, "status": "pending_requester_action", "webhook_type": "social_security_success_balance_request_not_found", "event_datetime": "2024-02-26T21:36:22" } } ``` Para prosseguir, as seguintes ações deverão ser tomadas: 1. Realizar a consulta dos dados do benefício em questão seguindo os passos do item 2 - [Consulta de dados do benefício](#consulta-de-dados); 2. Enviar uma requisição no formato abaixo para informar que a consulta foi realizada. ENDPOINT /social_security/reservation/external_key/ DEBT-KEY /validate_reservation MÉTODO POST Testar no Playground :::info Importante Essa requisição não apenas confirma a existência de uma consulta válida dos dados do benefício, mas também verifica se as informações enviadas para a criação da averbação estão corretas, permitindo assim a continuidade do processo. ::: :::warning CIN — Carteira de Identidade Nacional O campo `document_identification_type` agora aceita o valor `cin` (Carteira de Identidade Nacional). Quando utilizado, o campo `document_identification_number` **deve ser igual ao CPF** do portador (`individual_document_number`). O número do CIN é o próprio CPF. Valores aceitos em `document_identification_type`: `rg`, `rne`, `cnh`, `ctps`, `class_document`, `passport`, `other`, `cin`. **Atenção:** o envio do documento de identificação (`document_identification`) passará a ser **obrigatório** nas operações de portabilidade INSS. Comunique seus integradores com antecedência. ::: **4.1. Digitação da Proposta de Portabilidade com Refinanciamento:** Essa forma de digitação é utilizada para realizar a portabilidade de um contrato de crédito, liberando, ao final, mais dinheiro para o devedor. O valor liberado após a portabilidade é chamado de "Troco". A Proposta de Portabilidade e a Proposta de Refinanciamento podem ser geradas em uma mesma Request. Para a digitação da proposta devem ser enviadas as seguintes informações: - Dados cadastrais do tomador do crédito. - Dados cadastrais do Representante Legal (caso aplicável). - Dados financeiros da operação de portabilidade informando sempre o número de parcelas e uma das opções entre taxa de juros e valor de face da parcela. - Dados financeiros da operação de refinanciamento (operação que quita a operação de portabilidade e libera o troco) juntamente com os dados de conta bancária para pagamento do troco, conforme retornado na consulta dos dados do benefício. - Agente de crédito responsável pela originação da proposta, também conhecido como 'pastinha. - Saldo devedor, número do contrato original e ispb do credor original. Como a operação de Refinanciamento não possui data de desembolso fixa, a mudança na data de desembolso altera os valores da operação, sendo necessário informar se a taxa ("**monthly_interest_rate**") deve ser fixa ou se o valor liberado ao cliente ("**disbursed_amount**") deve ser fixo. **Caso a proposta seja de cliente analfabeto, os dados do rogado e testemunhas devem ser enviados no campo additional_data do payload de criação da proposta. Porém, deve ser previamente alinhado com a QI Tech quais informações e formato serão utilizados** :::danger Documento de identificação obrigatório (a partir de 03/08/2026) A Núclea passará a exigir o documento de identificação do tomador no registro da portabilidade a partir de **06/08/2026**. Por isso, a partir de **segunda-feira, 03/08/2026**, `borrower.document_identification_type` e `borrower.document_identification_number` passam a ser **obrigatórios** na digitação da proposta — propostas sem esses campos retornam erro. Quando `document_identification_type` for `cin`, o `document_identification_number` **pode** ser igual ao `individual_document_number` (CPF), já que a CIN usa o número do CPF. Para os demais tipos (`rg`, `cnh`), enviar o CPF em `document_identification_number` retorna erro. ::: #### Documento de identificação do tomador | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `borrower.document_identification_type` | string | ✅ | Tipo do documento de identificação. Valores: `rg`, `cnh`, `cin`. | | `borrower.document_identification_number` | string (máx. 16) | ✅ | Número do documento informado em `document_identification_type`. Igual ao CPF **somente** quando o tipo for `cin`. | | `borrower.document_identification_date` | string | — | Data de emissão do documento (`YYYY-MM-DD`). | Os mesmos campos existem em cada item de `related_parties` (representante legal) e seguem a mesma regra de preenchimento. **Ver exemplos de payload (Taxa Fixa / Valor Liberado Fixo)** **Com Taxa Fixa** **4.1.1. Digitação da Proposta de Portabilidade com Refinanciamento com taxa fixa:** Segue abaixo, exemplo de digitação da proposta fixando a taxa da operação: **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal Testar no Playground *Payload:* **Sem Registro na C3** ```json title='Request Body' { "proposal_type": "inss", "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "borrower": { "person_type": "natural", "name": "Marilene da Silva", "mother_name": "Maria Mariane", "birth_date": "1990-05-06", "profession": "Desenvolvedora", "nationality": "Brasileira", "marital_status": "single", "is_pep": false, "individual_document_number": "20676928013", "document_identification_number": "381803326", // obrigatório "document_identification_type": "rg", // obrigatório — rg | cnh | cin "document_identification_date": "2019-01-28", "email": "elaineisadoradacruz@hotmal.com", "phone": { "country_code": "055", "area_code": "11", "number": "912828135" }, "address": { "street": "Passagem Mariana", "state": "PA", "city": "Ananindeua", "neighborhood": "Águas Lindas", "number": "660", "postal_code": "67118003", "complement": "complemento" }, "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d", "document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a", "selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076" }, "related_parties": [ { "name": "Nome Representante Legal", "email": "email@email.com.br", "birth_date": "2000-12-12", "is_pep": false, "mother_name": "maria", "phone": { "number": "991294043", "area_code": "11", "country_code": "055" }, "address": { "street": "Avenida das Castanheiras", "state": "SP", "city": "Brasília", "neighborhood": "bairro", "number": "12", "postal_code": "71900100", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "individual_document_number": "20676928013", "document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650", "document_identification_type": "rg", "document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b", "document_identification_number": "123456789", "selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1" } ], "collaterals": [ { "collateral_type": "social_security", "collateral_data": { "benefit_number": "22255220", "state": "SP", "subcorban_document_number": "12123456000101" } } ], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 }, "contract_number": "300523588BF" }, "refinancing_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "000059923", "ispb": "341", "bank_code": "341", "branch_number": "0155" }, "contract_number": "200523588BF" }, "origin_contract": { "ispb": "60746948", "contract_number": "558472", "last_due_balance": 997.87 }, "additional_data": {} } ``` **Com Registro na C3** ```json title='Request Body' { "proposal_type": "inss", "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "borrower": { "person_type": "natural", "name": "Marilene da Silva", "mother_name": "Maria Mariane", "gender": "female", "birth_date": "1990-05-06", "profession": "Desenvolvedora", "nationality": "Brasileira", "marital_status": "single", "is_pep": false, "individual_document_number": "20676928013", "document_identification_number": "381803326", // obrigatório "document_identification_type": "rg", // obrigatório — rg | cnh | cin "document_identification_date": "2019-01-28", "email": "elaineisadoradacruz@hotmal.com", "phone": { "country_code": "055", "area_code": "11", "number": "912828135" }, "address": { "street": "Passagem Mariana", "state": "PA", "city": "Ananindeua", "neighborhood": "Águas Lindas", "number": "660", "postal_code": "67118003", "complement": "complemento" }, "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d", "document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a", "selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076" }, "related_parties": [ { "name": "Nome Representante Legal", "email": "email@email.com.br", "birth_date": "2000-12-12", "is_pep": false, "mother_name": "maria", "phone": { "number": "991294043", "area_code": "11", "country_code": "055" }, "address": { "street": "Avenida das Castanheiras", "state": "SP", "city": "Brasília", "neighborhood": "bairro", "number": "12", "postal_code": "71900100", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "individual_document_number": "20676928013", "document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650", "document_identification_type": "rg", "document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b", "document_identification_number": "123456789", "selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1" } ], "collaterals": [ { "collateral_type": "social_security", "collateral_data": { "benefit_number": "22255220", "state": "SP", "subcorban_document_number": "12123456000101" } } ], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 }, "contract_number": "300523588PF" }, "refinancing_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "000059923", "ispb": "341", "bank_code": "341", "branch_number": "0155" }, "contract_number": "200523588PK" }, "origin_contract": { "ispb": "60746948", "contract_number": "558472", "last_due_balance": 997.87 }, "additional_data": {} } ``` :::info Carência Conforme mudança da IN 204, a partir de 19/05, as operações poderão ter carência. Para tal, basta digitar dentro do "**collateral_data**" o campo "**number_of_grace_periods**". contendo o valor do número de meses desejados de carência, como no exemplo abaixo: ```json "collaterals": [ { "collateral_type": "social_security", "collateral_data": { "benefit_number": "22255220", "state": "RS", "number_of_grace_periods": 3, "subcorban_document_number": "12123456000101" } } ] ``` ::: :::caution Atenção A lista "**related_parties**", só deve ser enviada caso seja uma operação com Representante Legal. Quando enviado, deve conter os dados cadastrais do representante legal e o campo "**role_type**" deve ser enviado contendo o valor: "**issuer_legal_representative**". ::: :::info No campo "**origin_contract.ispb**" é informado o **ISPB** da instituição Credora Original. O **ISPB** é a base do CNPJ da instituição. Para ter acesso à lista completa de **ISPB's** de cada instituição participante do CTC - CIP (Central de Transferência de Crédito), basta utilizar o endpoint de consulta de participantes do CTC (índice): ::: **Com Valor Liberado Fixo** **4.1.2. Digitação da Proposta de Portabilidade com Refinanciamento com valor liberado fixo:** Segue abaixo, exemplo de digitação da proposta fixando o valor liberado ao cliente: **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal *Payload:* **Sem Registro na C3** ```json title='Request Body' { "proposal_type": "inss", "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "borrower": { "person_type": "natural", "name": "Elaine Isadora da Cruz", "mother_name": "Maria Mariane", "birth_date": "1990-05-06", "profession": "Desenvolvedora", "nationality": "Brasileira", "marital_status": "single", "is_pep": false, "individual_document_number": "90406718261", "document_identification_number": "381803326", // obrigatório "document_identification_type": "rg", // obrigatório — rg | cnh | cin "document_identification_date": "2019-01-28", "email": "elaineisadoradacruz@hotmal.com", "phone": { "country_code": "055", "area_code": "11", "number": "996363253" }, "address": { "street": "Passagem Mariana", "state": "PA", "city": "Ananindeua", "neighborhood": "Aguas Lindas", "number": "660", "postal_code": "67118003", "complement": "complemento" }, "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d", "document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a", "selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076" }, "related_parties": [{ "name": "Nome Representante Legal", "email": "email@email.com.br", "birth_date": "2000-12-12", "is_pep": false, "mother_name": "maria", "phone": { "number": "991294043", "area_code": "11", "country_code": "055" }, "address": { "street": "Avenida das Castanheiras", "state": "SP", "city": "Brasília", "neighborhood": "bairro", "number": "12", "postal_code": "71900100", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "individual_document_number": "45102538004", "document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650", "document_identification_type": "rg", "document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b", "document_identification_number": "123456789", "selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1" }], "collaterals": [{ "collateral_type": "social_security", "collateral_data": { "benefit_number": "12345678", "state": "SP", "subcorban_document_number": "12123456000101" } }], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 }, "contract_number": "3635259610" }, "refinancing_credit_operation": { "financial": { "disbursed_amount": 1000, "installment_face_value": 110, "number_of_installments": 10 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" }, "contract_number": "3635259632" }, "origin_contract": { "ispb": "60746948", "contract_number": "5584745", "last_due_balance": 800 }, "additional_data": {} } ``` **Com Registro na C3** ```json title='Request Body' { "proposal_type": "inss", "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "borrower": { "person_type": "natural", "name": "Elaine Isadora da Cruz", "mother_name": "Maria Mariane", "birth_date": "1990-05-06", "gender": "female", "profession": "Desenvolvedora", "nationality": "Brasileira", "marital_status": "single", "is_pep": false, "individual_document_number": "90406718261", "document_identification_number": "381803326", // obrigatório "document_identification_type": "rg", // obrigatório — rg | cnh | cin "document_identification_date": "2019-01-28", "email": "elaineisadoradacruz@hotmal.com", "phone": { "country_code": "055", "area_code": "11", "number": "996363253" }, "address": { "street": "Passagem Mariana", "state": "PA", "city": "Ananindeua", "neighborhood": "Aguas Lindas", "number": "660", "postal_code": "67118003", "complement": "complemento" }, "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d", "document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a", "selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076" }, "related_parties": [{ "name": "Nome Representante Legal", "email": "email@email.com.br", "birth_date": "2000-12-12", "is_pep": false, "mother_name": "maria", "phone": { "number": "991294043", "area_code": "11", "country_code": "055" }, "address": { "street": "Avenida das Castanheiras", "state": "SP", "city": "Brasília", "neighborhood": "bairro", "number": "12", "postal_code": "71900100", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "individual_document_number": "45102538004", "document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650", "document_identification_type": "rg", "document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b", "document_identification_number": "123456789", "selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1" }], "collaterals": [{ "collateral_type": "social_security", "collateral_data": { "benefit_number": "12345678", "state": "SP", "subcorban_document_number": "12123456000101" } }], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 }, "contract_number": "3635259611" }, "refinancing_credit_operation": { "financial": { "disbursed_amount": 1000, "installment_face_value": 110, "number_of_installments": 10 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" }, "contract_number": "3635259663" }, "origin_contract": { "ispb": "60746948", "contract_number": "5584745", "last_due_balance": 800 }, "additional_data": {} } ``` **4.1.3. Response** - MÉTODO POST - STATUS /v2/credit_transfer/proposal **body.json** ```json { "borrower": { "individual_document_number": "90406718261", "name": "Elaine Isadora da Cruz", "related_party_key": "d7f84a9d-28ba-4355-8e5e-a436ff4c3c2d", "role_type": "issuer" }, "portability_credit_operation": { "collateral_is_constituted": false, "contract_number": "3635259611", "credit_operation_key": "235ce3a5-eea1-4b13-9335-3de577318f8b", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.17295, "cet": 0.0134, "contract_fee_amount": 0.0, "contract_fees": [ { "amount": 0.5, "amount_type": "percentage", "fee_amount": 0.0, "fee_type": "tac" } ], "disbursed_issue_amount": 800.0, "disbursement_date": "2023-12-22", "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": "spread", "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": "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": "insurance_premium", "irrf_amount": 0, "net_fee_amount": 0.0, "pis_amount": 0, "tax_amount": 0.0 } ], "installments": [ { "business_due_date": "2024-02-22", "calendar_days": 62, "due_date": "2024-02-22", "due_principal": 800.0, "installment_number": 1, "pre_fixed_amount": 21.977846031814607, "principal_amortization_amount": 65.21215396818539, "total_amount": 87.19, "workdays": 40 }, { "business_due_date": "2024-03-22", "calendar_days": 29, "due_date": "2024-03-22", "due_principal": 734.7878460318146, "installment_number": 2, "pre_fixed_amount": 9.373907348762184, "principal_amortization_amount": 77.81609265123781, "total_amount": 87.19, "workdays": 21 }, { "business_due_date": "2024-11-22", "calendar_days": 31, "due_date": "2024-11-22", "due_principal": 86.03031050776795, "installment_number": 10, "pre_fixed_amount": 1.1637189988799015, "principal_amortization_amount": 86.0262810011201, "total_amount": 87.19, "workdays": 22 } ], "issue_amount": 800.0, "number_of_installments": 10, "prefixed_interest_rate": { "annual_rate": 0.17042118, "daily_rate": 0.00043722, "interest_base": "calendar_days", "monthly_rate": 0.0132 }, "total_iof": 0.0 } ], "document_key": "c4cedeaf-23bf-450d-9fba-5ec6b5d45afb", "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/c4cedeaf-23bf-450d-9fba-5ec6b5d45afb/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-3635259611.pdf", "final_disbursement_amount": 0.0 }, "proposal_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497", "proposal_number": "17032782193414588", "proposal_status": "pending_submission", "refinancing_credit_operation": { "collateral_is_constituted": false, "contract_number": "3635259663", "credit_operation_key": "f73ba4d2-cd0a-4405-a47e-a51f325a9756", "credit_operation_status": "waiting_signature", "disbursement_accounts": [ { "account_branch": "0001", "account_digit": "1", "account_number": "00001", "bank_code": "033" } ], "disbursement_options": [ { "annual_cet": 0.193423, "cet": 0.0148, "contract_fee_amount": 1.03, "disbursed_issue_amount": 1000.0, "disbursement_date": "2023-12-22", "issue_amount": 1005.24, "number_of_installments": 10, "final_disbursement_amount": 200.0 } ], "document_key": "f4dfb505-3cec-4a97-9b16-dadc39bb4c7e", "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/f4dfb505-3cec-4a97-9b16-dadc39bb4c7e/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-3635259663.pdf", "final_disbursement_amount": 200.0 }, "related_party_list": [ { "individual_document_number": "45102538004", "name": "Nome Representante Legal", "related_party_key": "632fa6c5-40e8-4e76-862e-e10951ed8bff", "role_type": "issuer_legal_representative" } ] } ``` Segue abaixo definições e descrições de alguns campos retornados na resposta da digitação da Proposta: **[A]**: ***"portability_credit_operation.disbursement_options.iof_amount"***: Na Operação de Portabilidade o IOF sempre será zero. **[B]**: ***"portability_credit_operation.disbursement_options.disbursed_issue_amount"***: É igual ao valor do saldo devedor do Contrato Original. **[C]**: ***"portability_credit_operation.disbursement_options.issue_amount"***: É o valor da Operação de Portabilidade. :::tip Relação [C] = [A] + [B] ::: **[D]**: ***"refinancing_credit_operation.disbursement_options.iof_amount"***: Valor de IOF da Operação de Refinanciamento (Troco). **[E]**: ***"refinancing_credit_operation.disbursement_options.disbursed_issue_amount"***: É o valor destinado à quitação do saldo devedor da Operação de Portabilidade. :::tip Relação [E] = [C] ::: **[F]**: **"refinancing_credit_operation.disbursement_options.final_disbursement_amount"**: É o valor do Troco liberado para o cliente na conta de desembolso informada no momento da digitação da Proposta (deve ser a conta informação da consulta dos dados do benefício). **[G]**: **"refinancing_credit_operation.disbursement_options.issue_amount"**: É o valor do Refinanciamento. :::tip Relação {"\n"} [G] = [F] + [E] + [D] {"\n"} ::: Os campos "**portability_credit_operation.disbursement_options.collateral_constituted**" e "**refinancing_credit_operation.disbursement_options.collateral_constituted**" informam se a margem do cliente esta averbada na Dataprev. O processo de averbação da Portabilidade será iniciado assim que os recursos para quitação do contrato original forem enviados a Instituição Credora Original (Item **6.4.**). O Processo de averbação do Refinanciamento é iniciado no momento em que o Parceiro decide por prosseguir com a Operação de Refinanciamento (Item **7.1.1.** e **7.2.**). **4.2. Digitação da Proposta de Portabilidade:** A Proposta de Portabilidade (Portabilidade Pura) deve ser digitada de forma semelhante ao descrito no item 4.1.1, porém deve ser enviada sem o objeto **"refinancing_credit_operation"**. **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal **body.json** ```json { "proposal_type": "inss", "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" }, "borrower": { "person_type": "natural", "name": "Elaine Isadora da Cruz", "mother_name": "Maria Mariane", "birth_date": "1990-05-06", "gender": "female", "profession": "Desenvolvedora", "nationality": "Brasileira", "marital_status": "single", "is_pep": false, "individual_document_number": "90406718261", "document_identification_number": "381803326", // obrigatório "document_identification_type": "rg", // obrigatório — rg | cnh | cin "document_identification_date": "2019-01-28", "email": "elaineisadoradacruz@hotmal.com", "phone": { "country_code": "055", "area_code": "11", "number": "996363253" }, "address": { "street": "Passagem Mariana", "state": "PA", "city": "Ananindeua", "neighborhood": "Aguas Lindas", "number": "660", "postal_code": "67118003", "complement": "complemento" }, "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d", "document_identification_back": "7b8f7848-78b5-405b-a62c-f23a432fde1a", "selfie": "2a2d000e-9f2b-4c4e-95f9-1561950db076" }, "related_parties": [{ "name": "Nome Representante Legal", "email": "email@email.com.br", "birth_date": "2000-12-12", "is_pep": false, "mother_name": "maria", "phone": { "number": "991294043", "area_code": "11", "country_code": "055" }, "address": { "street": "Avenida das Castanheiras", "state": "SP", "city": "Brasília", "neighborhood": "bairro", "number": "12", "postal_code": "71900100", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "individual_document_number": "45102538004", "document_identification": "359530eb-41dc-41bd-8385-b86d6bd6e650", "document_identification_type": "rg", "document_identification_back": "ae320312-532c-467c-b11f-48e3ec87452b", "document_identification_number": "123456789", "selfie": "f28e1a70-32e8-4620-9d72-c89ac8c7adb1" }], "collaterals": [{ "collateral_type": "social_security", "collateral_data": { "benefit_number": "12345678", "state": "SP", "subcorban_document_number": "12123456000101" } }], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 }, "contract_number": "1020252636" }, "origin_contract": { "ispb": "60746948", "contract_number": "558474520", "last_due_balance": 800 }, "additional_data": {} } ``` **Response** - MÉTODO POST - STATUS /v2/credit_transfer/proposal *Payload:* **payload.json** ```json { "borrower": { "individual_document_number": "90406718261", "name": "Elaine Isadora da Cruz", "related_party_key": "f9fbaa93-4d57-494f-b60f-dcba8cb64a45", "role_type": "issuer" }, "portability_credit_operation": { "collateral_is_constituted": false, "contract_number": "1020252636", "credit_operation_key": "1cd34a63-5a61-49a3-90a5-7a515ee98932", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.17295, "cet": 0.0134, "disbursed_issue_amount": 800.0, "disbursement_date": "2023-12-22", "issue_amount": 800.0, "number_of_installments": 10, "prefixed_interest_rate": { "annual_rate": 0.17042118, "daily_rate": 0.00043722, "interest_base": "calendar_days", "monthly_rate": 0.0132 }, "total_iof": 0.0 } ], "document_key": "2f9ac920-a5e8-4386-b049-dc971e1fc20b", "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/2f9ac920-a5e8-4386-b049-dc971e1fc20b/TESTEINSSS.A.-ELAINEISADORADACRUZ-CCB-1020252636.pdf", "final_disbursement_amount": 0.0 }, "proposal_key": "9661aef8-e897-4405-a44f-ca8a43d9cee3", "proposal_number": "17032785232138245", "proposal_status": "pending_submission", "related_party_list": [ { "individual_document_number": "45102538004", "name": "Nome Representante Legal", "related_party_key": "c8166f37-b496-455a-96e7-f75e24f084a1", "role_type": "issuer_legal_representative" } ] } ``` **4.3. Recuperando dados de uma proposta:** - MÉTODO GET - STATUS /v2/credit_transfer/proposal/PROPOSAL-KEY ou REQUESTER_CONTROL_KEY ## Path Params | Campo | Tipo | Descrição | Caracteres | |---|---| ---| ---| | `proposal_key` | string | Chave identificadora da proposta | - | | `requester_control_key` | string | Chave identificadora do cliente para recuperar os dados de uma proposta (casos de timeout ou operação duplicada), enviar no lugar da proposal_key | - | *Response:* **response.json** ```json { "borrower": { "address": { "city": "SAO PAULO", "complement": "Moradia", "neighborhood": "CENTRO", "number": "10", "postal_code": "01153000", "state": "SP", "street": "RUA CENTRAL" }, "birth_date": "1976-05-25", "document_identification_number": "306385466", "email": "ivanete@windowslive.com", "individual_document_number": "25500337874", "is_pep": false, "marital_status": "single", "mother_name": "EDITE MARIA DANTAS", "name": "IVANETE SATURNINO DE SOUZA", "nationality": "Brasleira", "person_type": "natural", "phone": { "area_code": "11", "country_code": "055", "number": "985814768" }, "profession": "Aposentado", "related_party_key": "511d7186-3c17-4f35-8887-c4aefaf270be", "role_type": "issuer" }, "collaterals": [ { "collateral_data": { "benefit_number": 2045043317, "state": "SP" }, "collateral_type": "social_security" } ], "origin_operation": { "contract_date": "2025-06-02", "contract_number": "0123489618691", "financial_institution_code_number": "237", "installment_number": 84, "ispb_number": "60746948", "last_due_balance": 17879.22, "opened_installment_number": 67, "overdue_installment_number": 0 }, "portability_credit_operation": { "collateral_is_constituted": false, "contract_number": "CTC0000024971", "credit_operation_key": "e5bfbd28-0144-4eaa-b7f1-d0efb0b6b155", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.2321, "cet": 0.0175, "disbursed_issue_amount": 17879.22, "disbursement_date": "2025-06-02", "issue_amount": 17879.22, "number_of_installments": 67, "prefixed_interest_rate": { "annual_rate": 0.2285378296, "daily_rate": 0.0005718988, "interest_base": "calendar_days", "monthly_rate": 0.0173 }, "total_iof": 0 } ], "document_key": "f85d9799-e29f-4133-80c3-3e95f16f2a54", "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/f85d9799-e29f-4133-80c3-3e95f16f2a54/MMRIOLTDA-IVANETESATURNINODESOUZA-CCB-CTC0000024971.pdf", "final_disbursement_amount": 17879.22 }, "proposal_key": "1e1d3f4d-21aa-4b6f-8515-6d978dc2afa5", "proposal_number": "17488903030996687", "proposal_status": "pending_submission", "refinancing_credit_operation": { "collateral_is_constituted": false, "contract_number": "CTC0000024972", "credit_operation_key": "7cc4d931-34d5-4b03-b04b-9ae4b6721f45", "credit_operation_status": "waiting_signature", "disbursement_accounts": [ { "account_branch": "1261", "account_digit": "1", "account_number": "000062293", "bank_code": "237" } ], "disbursement_options": [ { "annual_cet": 0.2517, "cet": 0.0189, "disbursed_issue_amount": 20373.27, "disbursement_date": "2025-06-02", "final_disbursement_amount": 2494.05, "issue_amount": 20458.57, "number_of_installments": 96, "prefixed_interest_rate": { "annual_rate": 0.2460411933, "daily_rate": 0.0006112186, "interest_base": "calendar_days", "monthly_rate": 0.0185 }, "total_iof": 85.3 } ], "document_key": "60763cba-da54-4826-bf76-b8f3d26c6326", "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/60763cba-da54-4826-bf76-b8f3d26c6326/MMRIOLTDA-A-CCB-CTC0000024972.pdf", "final_disbursement_amount": 2494.05 }, "requester_control_key": "0e856d23-0746-4444-a71a-2957a64c869a" } ``` :::info No caso da recuperação dos dados de uma proposta de portabilidade pura o objeto "refinancing_credit_operation" não será retornado. ::: ### Correção de dados para refinanciamento com nova assinatura da CCB: É possível corrigir os dados financeiros e os bancários da operação de refinanciamento enquanto o refinanciamento original não for averbado. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation MÉTODO PUT Testar no Playground Request Body ```json { "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-06-10", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "monthly_interest_rate": 0.0167, "installment_face_value": 410, "limit_days_to_disburse": 7, "number_of_installments": 84 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" } } ``` *Response:* **response.json** ```json { "credit_operation_key": "\", "contract_number": "00000002", "document_key": "\", "document_url": "\", "credit_operation_status": "issued", "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [{ "installments": [{ "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-08-09", "calendar_days": 53, "digitable_line": null, "due_date": "2021-08-08", "due_interest": 0, "due_principal": 997.87, "fine_amount": null, "has_interest": true, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-09-08", "calendar_days": 31, "digitable_line": null, "due_date": "2021-09-08", "due_interest": 0, "due_principal": 690.8886500498395, "fine_amount": null, "has_interest": true, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "tax_amount": 0, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 50, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 997.87, "final_disbursement_amount": 100, "issue_amount": 1147.87, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 }], "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "ispb": "00000000", "branch_number": "0001" } } ``` :::caution A key da operação de refinanciamento, a document key, a document url, a related_party_key e a borrower related_party_key mudarão após essa ação, sendo necessário a reassinatura da CCB. ::: ### Correção de dados para refinanciamento: É possível recalcular o valor da parcela da operação de refinanciamento sem gerar uma nova CCB. O novo valor de parcela deve ser menor que o valor original. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation/recalculate MÉTODO PUT Testar no Playground Request Body ```json { "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-06-10", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "monthly_interest_rate": 0.0167, "installment_face_value": 410, "limit_days_to_disburse": 7, "number_of_installments": 84 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" } } ``` *Response:* **response.json** ```json { "credit_operation_key": "\", "contract_number": "00000002", "document_key": "\", "document_url": "\", "credit_operation_status": "issued", "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [{ "installments": [{ "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-08-09", "calendar_days": 53, "digitable_line": null, "due_date": "2021-08-08", "due_interest": 0, "due_principal": 997.87, "fine_amount": null, "has_interest": true, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-09-08", "calendar_days": 31, "digitable_line": null, "due_date": "2021-09-08", "due_interest": 0, "due_principal": 690.8886500498395, "fine_amount": null, "has_interest": true, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "tax_amount": 0, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 50, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 997.87, "final_disbursement_amount": 100, "issue_amount": 1147.87, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 }], "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "ispb": "00000000", "branch_number": "0001" } } ``` ### Correção de dados para portabilidade e refin: É possível corrigir os dados bancários, número do benefício e nome até que o contrato de portabilidade seja averbado. Tanto os dados do operação de portabilidade quanto do refinanciamento serão ajustados. Para isso basta utilizar a seguinte chamada: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /collateral MÉTODO PATCH Testar no Playground Request Body **Dados Bancários** ```json { "disbursement_bank_account": { "bank_code": "123", "account_digit": "1", "account_branch": "1234", "account_number": "5678", "document_number": "12345678901" } } ``` **Número do Benefício** ```json { "benefit_number": 1234567890 } ``` **Nome** ```json { "name": "Nome do Beneficiário" } ``` **Nome da Mãe** ```json { "mother_name": "Nome da Mãe do Beneficiário" } ``` ### Simulando cenários de sucesso e insucesso na averbação em Sandbox: A simulação de cenários é baseado no primeiro dígito do CPF informado na operação. **11.1.** Para CPFs iniciados com o número 1, será retornado uma resposta assíncrona de sucesso através do Webhook. **11.2.** Para os demais CPFs, será retornado uma resposta assíncrona de erro, baseado no primeiro dígito do CPF digitado, de acordo com a tabela abaixo. **11.3.** Erros com Ação "cancel" receberá um webhook com o resultado final da operação. | Início do cpf | Enumerador | Descrição | Ação | |---------------|------------------------------|-----------------------------------------------------------------------------------|--------| | 2 | invalid_disbursement_account | Invalid disbursemente bank account | cancel | | 3 | operation_not_allowed_IR | Operation not allowed due to operation deadline greatter than benefit termination | cancel | :::caution Atenção Todos os CPFs que não tiverem um cenário mapeado para o primeiro dígito, receberão um webhook com um erro padrão de cenário de teste não mapeado. | Enumerador | Descrição | |---------------|------------------------------------------------------------------| | mock_error | Informed document number is not a valid mock on test environment | ::: --- ## 5 - Envio de documentos Segundo IN 138 do INSS é obrigatório o envio dos dados complementares do contrato. Os documentos devem ser enviados através do [endpoint de upload de documentos.](../upload_de_documentos) e devem seguir a seguinte formatação: | Validações | Valores | |----------------|--------------| | Formato | JPEG | | Tamanho mínimo | 250 x 250 px | | Tamanho máximo | 2 MB | :::caution Atenção Contratos que tiverem documentos vinculados que não respeitam as regras de tamanho mínimo ou máximo serão cancelados permanentemente. ::: Caso as validações não sejam atendidas, no momento que o parceiro seguir com a proposta após receber o saldo devedor, iremos devolver os seguintes erros : **Ver exemplos de erro** **Formato inválido** ```json { "title": "Invalid document format", "description": "The document: document_identification_back should be in JPEG format.", "translation": "O documento: document_identification_back deve estar no formato JPEG.", "code": "SSC000061" } ``` **Tamanho inválido** ```json { "title": "Invalid document size", "description": "The document: document_identification_back should have at least 250x250px.", "translation": "O documento: document_identification_back deve ter no mínimo 250x250px.", "code": "SSC000060" } ``` Após o upload de documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da proposta no tópico anterior dentro do campo *borrower* ou dentro do objeto de *related_parties** correspondente ao representante legal (*"role_type": "issuer_legal_representative"*): ```json { "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41", "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431", "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c" } ``` Ou ainda, após a criação da proposta, podem ser informadas através do seguinte endpoint: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /related_party/ RELATED-PARTY-KEY /attached_document MÉTODO POST Testar no Playground Request Body ```json { "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41", "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431", "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c" } ``` :::info Informação A **related_party_key** é retornada na response da criação de dívida dentro do objeto **borrower** e dentro de cada uma das partes relacionadas dentro de **related_party_list** se for o caso. ::: --- ## 6 - Formalização da Proposta: :::caution Atenção Para propostas que envolvam troco após o refinanciamento, é necessário o valor do troco calculado de acordo com as condições do contrato seja de pelo menos 5% da diferença entre a soma de todas as parcelas do refinanciamento subtraida da soma de todas as parcelas da portabilidade. Caso contrário, a requisição receberá o seguinte erro: STATUS 400 **Response Body** ```json { "title": "Bad Request", "code": "CT000118", "description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.", "translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00." } ``` ::: Para formalização das operações de Portabilidade e/ou Refinanciamento (Troco), deve-se enviar as evidências de assinatura dos contratos gerados na digitação da Proposta. **No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 5. Os campos obrigatórios são os seguintes: _ip_address_ e _signature_datetime_.** **6.1.** Para assinatura da Operação de Portabilidade o Parceiro deve realizar a seguinte chamada: **Request** - MÉTODO POST - STATUS /v2/credit_transfer/proposal/ PROPOSAL-KEY /portability_credit_operation/signature Testar no Playground *Payload:* **payload.json** ```json { "type": "pdf-signature", "biometry_analysis_reference": "SERPRO", "signature_datetime": "2023-12-22T15:01:32.482Z", "signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9", "ip_address": "179.145.48.219", "similarity_score": "0.9750000000000001" } ``` ### Enumeradores _Biometry Analysis Reference_ | Enumerador | Descrição | |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **serpro** | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro) | | **tse** | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE | | **not_found** | Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro. | A conclusão da assinatura será notificada de forma assíncrona: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **body.json** ```json { "webhook_type": "credit_transfer.proposal.credit_operation", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "portability", "credit_operation_key": "\", "document_key": "\", "signed_document_url": "\", "credit_operation_status": "signed" } } ``` **6.2.** Para assinatura da Operação de Refinanciamento (Troco) o Parceiro deve realizar a seguinte chamada: **Request** - MÉTODO POST - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation/signature Testar no Playground *Payload:* **payload.json** ```json { "type": "pdf-signature", "signed_pdf_path": "https://termos-originacao.s3.amazonaws.com/5cd2a7f9", "ip_address": "192.168.0.0", "signature_datetime": "2020-03-20T14:28:23.382748Z", "similarity_score": "0.98", "biometry_analysis_reference": "serpro" } ``` A conclusão da assinatura será notificada de forma assíncrona: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **body.json** ```json { "webhook_type": "credit_transfer.proposal.credit_operation", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "refinancing", "credit_operation_key": "\", "document_key": "\", "signed_document_url": "\", "credit_operation_status": "signed" } } ``` --- --- # Máquinas de Status URL: /documentation/guides/INSS/portability+refinancing/maquinas-de-status Máquinas de Status — Port+Refin :::info Esta página descreve as máquinas de status que cobrem o que acontece **após a formalização da proposta**. Para o fluxo completo de digitação e pré-aprovação, consulte o [Fluxo Completo](./end-to-end). ::: ## Portabilidade — Máquina de Status ![Máquina de estados da proposta de portabilidade](/img/diagrams/inss-port-refin-maquinas-de-status-1.svg) Os estados da Proposta de Portabilidade refletem as etapas envolvidas no processo de portabilidade de crédito dentro do CTC (Central de Transferência de Crédito) da CIP. Segue abaixo a descrição do fluxo e do significado de cada status envolvido em uma Proposta de Portabilidade, desde sua digitação até sua liquidação. **7.1. pending_response:** Status da proposta após realização da digitação. Neste status a proposta foi recebida com sucesso pela QI e enviada para o CTC - CIP. **7.1.1 rejected:** Caso a digitação da proposta seja rejeitada pelo CTC - CIP, será enviado um webhook com o motivo da rejeição: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS rejected **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "rejected", "event_datetime": "2022-11-24T15:42:12", "data": { "error": { "code": "ECTC0023", "reason": "Contrato com portabilidade em andamento" } } } ``` **7.1.1 rejected reasons:** Caso a digitação da proposta seja rejeitada pelo CTC - CIP, será enviado um webhook com o motivo da rejeição: | reason | description | external_code | |------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| | portability_in_progress | Contrato com portabilidade em andamento | ECTC0023 | | portability_finished | Portabilidade já finalizada para o contrato informado | ECTC0028 | | portability_in_expiration_progress | Portabilidade não permitida. Contrato com portabilidade em situação de "Decurso de prazo" por não efetivação da portabilidade | ECTC0085 | | unexpected_error | Erro inesperado | ECTC9999 | | portability_payment_rejected | Pagamento de portabilidade rejeitado. | | | divergent_due_balance | Saldo devedor final deve ser menor que saldo devedor devolvido pela cip. | | **7.2. pending_acceptance:** Status da Proposta após envio/aceite pelo CTC - CIP. A Proposta, neste momento, está aguardando resposta de saldo devedor pelo banco credor original. Neste momento é enviado um webhook com o número da Portabilidade no CTC - CIP: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS pending_acceptance **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "pending_acceptance", "event_datetime": "2022-11-24T15:42:12", "data": { "portability_number": "202211230000246536429", "inclusion_date": "2022-11-24", "due_balance_expected_return_date": "2022-12-01" } } ``` :::info O **"portability_number"** é o Número da Portabilidade dentro do CTC - CIP, e é o número utilizado pela instituição proponente e instituição credora original para localizar a Proposta de Portabilidade. ::: Assim que o banco credor original responder à solicitação de portabilidade, será enviado um webhook com a resposta do valor do saldo devedor no caso da não retenção, e com a informação de "retido", no caso da retenção: **7.2.1. accepted:** Status da Proposta quando o banco credor original retorna o saldo devedor e não retem o crédito. Será enviado um webhook com a informação do saldo devedor. O banco credor original tem até 5 d.u. após a recepção da Proposta de Portabilidade, para envio da resposta com a informação do saldo devedor da operação. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS accepted **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "accepted", "event_datetime": "2022-11-24T15:42:12", "data": { "final_due_balance": 1000, "portability_number": "202211230000246536429", "original_contract": { "origin_contract_number": "5584745", "origin_ispb_number": "60746948", "origin_document_number": "90406718261", "origin_operation_type": "0202", "installment_face_value": 1000, "total_iof": 1, "first_due_date": "2021-05-31", "last_due_date": "2022-05-31", "interest": 1, "cet": 1, "installment_number": 12, "amortization": 1, "final_due_balance": 1000, "final_due_date": "2021-08-31", "contract_date": "2021-04-31" } } } ``` Com a informação do saldo devedor retornado pela instituição credora original, o parceiro tomará a decisão se seguir ou não com a Portabilidade. :::info Horário limite para envio do saldo devedor pela instituição credora original é às 10:00. ::: Após o recebimento do saldo devedor, caso o Parceiro decida seguir com a Proposta Portabilidade, ele deve realizar a seguinte chamada: **Request** - MÉTODO PATCH - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY Testar no Playground *Payload:* **payload.json** ```json { "status":"accepted_by_requester" } ``` :::caution Atenção Para propostas que envolvam troco após o refinanciamento, é necessário que o valor do troco calculado de acordo com as novas condições do contrato após o retorno do saldo devedor seja de pelo menos 5% da diferença entre a soma de todas as parcelas do refinanciamento subtraida da soma de todas as parcelas da portabilidade. Caso contrário, a requisição receberá o seguinte erro: STATUS 400 **Response Body** ```json { "title": "Bad Request", "code": "CT000118", "description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.", "translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00." } ``` ::: O Parceiro pode adicionar dados de novo valor de parcela ou nova taxa nessa chamada, caso queira alterá-los: **Request** - MÉTODO PATCH - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY *Payload:* **payload.json** ```json { "status":"accepted_by_requester", "financial": { "installment_face_value": 100 } } ``` **Request** - MÉTODO PATCH - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY *Payload:* **payload.json** ```json { "status":"accepted_by_requester", "financial": { "monthly_interest_rate": 0.01 } } ``` :::info Campos adicionais opcionais Além dos campos `status` e `financial`, o endpoint de aceite da proposta também aceita os seguintes campos opcionais: - **`borrower.document_identification_type`** (string ou null): Tipo do documento de identificação - **`borrower.document_identification_number`** (string, máx. 16 caracteres): Número do documento de identificação - **`borrower.gender`** (string ou null): Gênero do tomador. Valores aceitos: `"male"`, `"female"` ou `null` - **`credit_agent`** (objeto): Agente de crédito com `name` (string, máx. 100) e `document_number` (string, 11 ou 14 dígitos) ::: :::danger Atenção! Caso o valor da parcela seja maior que valor total disponível (valor da parcela do contrato de origem + margem total disponível do benefício), será retornado o seguinte erro: ```json { "title": "Reservation amount greater than available total balance", "description": "The installment face value: 54.4 is greater than the available total balance (origin installment face value + available total balance):30.4. Available total balance: -20.0.", "translation": "O valor da parcela: 54.4 é maior que o valor total disponível (valor da parcela do contrato de origem + margem total disponível) : 30.4. Margem total diponível: -20.0.", "code": "SSC000059" } ``` Ao receber esta crítica, é possível que uma nova chamada seja feita, alterando o valor da parcela para que ela se ajuste ao valor total disponível. Se o ajuste no valor da parcela não for feito até o horário limite para aceite do saldo devedor, será necessária uma nova digitação de proposta. ::: Caso o Parceiro decida por não prosseguir com a Proposta de Portabilidade, ele deve, **obrigatoriamente** realizar a seguinte chamada para informar a desistência da Portabilidade: **Request** - MÉTODO DELETE - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY Testar no Playground Após o envio do cancelamento da Proposta de Portabilidade ao CTC - CIP, será enviado um webhook de Proposta Cancelada: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS canceled **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_status": "canceled", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12" } ``` :::info O horário limite para aceite do saldo devedor é 16:30. Não é possível retomar uma Proposta com status "canceled". Caso a Proposta esteja com este status, será necessária a realização de uma nova digitação. ::: **7.2.2. retained:** Status da Proposta quando o banco credor original retem o crédito, será enviado o webhook com a informação de retenção. O banco credor original do crédito tem até 2 d.u. após a recepção da Proposta de Portabilidade, para envio da resposta de retenção do crédito. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS retained **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "retained", "event_datetime": "2022-11-24T15:42:12", "data": { "retained_reason": { "reason": "issuer_retention", "description": "Retenção do Cliente" } } } ``` ### Detalhamento de campos no webhook de proposal | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | reason | lista dos motivos de retenção de uma Proposta | [Enumeradores](#retention_reason_enumerator) | **7.3. accepted_by_requester:** Após aprovada pelo parceiro, a Proposta segue o fluxo interno da QI para liquidação. **7.4. settlement_sent:** Após conclusão do fluxo interno da QI para liquidação da Proposta de Portabilidade o recurso para pagamento do saldo devedor é enviado ao credor original disparando o seguinte webhook para o Parceiro: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS settlement_sent **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "settlement_sent", "event_datetime": "2022-11-24T15:42:12", "data": { "receipt": { "amount": 1000, "timestamp": "2022-09-14 11:55:31", "description": "237 0001 1000093 1000093-3 59588111000103 - BCO BRADESCO S.A.", "ted_receipt_document_key": "a34e84a2-1628-4f23-8c11-2b2f4656ced1", "ted_receipt_url": "https://qitech.com.br/", "transaction_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf", "origin": { "account_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf", "bank_code": "329", "branch": "0001", "branch_digit": null, "account_number": "1000361", "account_digit": "3", "type": "checking_account", "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "document": "32402502000135" }, "destination": { "bank_code": "237", "branch": "0001", "branch_digit": null, "account_number": "1000093", "account_digit": "3", "type": "checking_account", "name": "BCO BRADESCO S.A.", "document": "59588111000103", "purpose": "Saída Liquidação de Portabilidade" } } } } ``` Neste momento será iniciada averbação da Operação de Portabilidade na Dataprev. O processo de averbação acontecerá em paralelo aos itens seguintes (itens 7.5., 7.5.1. e 7.5.2.) **7.5. pending_settlement_confirmation:** Após a confirmação do envio dos recursos para pagamento do saldo devedor, é aguardada a confirmação da quitação do contrato por parte da Instituição Credora Original. Nesta etapa o Parceiro receberá o seguinte webhook: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS pending_settlement_confirmation **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "pending_settlement_confirmation", "event_datetime": "2022-11-24T15:42:12" } ``` :::info A confirmação da quitação do contrato é encaminhada pela Instituição Credora Original ao CTC - CIP e posteriormente encaminhado pelo CTC - CIP à QI. O SLA para confirmação da quitação da Portabilidade é de **2 d.u.** contados a partir do envio dos recursos para pagamento do saldo devedor do contrato original. ::: **7.5.1. paid:** Assim que a QI receber do CTC - CIP a confirmação da quitação do Contrato Original, a Proposta constará como paga e a Portabilidade estará finalizada. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS paid **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "paid", "event_datetime": "2022-11-24T15:42:12" } ``` Nesta etapa, caso a averbação da Operação de Portabilidade já esteja concluída, a Operação de Refinanciamento (Troco), poderá ser iniciada (fluxo descrito no item 7). **7.5.1.1.** A notificação sobre a averbação da Operação de Portabilidade será enviada através do seguinte webhook: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.collateral **body.json** ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "portability", "credit_operation_key": "\", "collateral_type": "social_security", "collateral_constituted": true, "collateral_data": { "reservation_method": "portability", } } } ``` data.collateral_data.reservation_method: [portability, new_credit ] **7.5.2. rejected:** Caso o banco credor original rejeite a quitação do contrato, o recurso enviado para quitação do saldo devedor do contrato original será devolvido, e a proposta será finalizada. O parceiro receberá o webhook de **"rejected"**. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS rejected **body.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "\", "proposal_status": "rejected", "event_datetime": "2022-11-24T15:42:12", "data": { "error": { "code": "QCTC0001", "reason": "Pagamento de portabilidade rejeitado." } } } ``` Caso nesta etapa a Operação de Portabilidada já esteja averbada na Dataprev, será realizada a desaverbação da margem. :::info Não é possível retomar uma Proposta com status "**rejected**". É sempre necessário realizar uma nova digitação. ::: --- ## Refinanciamento (Troco) — Máquina de Status ![Máquina de estados da operação de refinanciamento](/img/diagrams/inss-port-refin-maquinas-de-status-2.svg) **8.1** No momento em que a Operação de Portabilidade é paga, o Parceiro pode optar por seguir com a Operação de Refinanciamento (Troco) ou não. #### Enumeradores credit_operation_status | Enumerador | Descrição | |-------------------------------------------|---------------------------------------| | waiting_signature | Operação aguardando assinatura | | signed | Operação assinada | | issued | Operação emitida | | disbursed | Operação desembolsada | | settled | Operação liquidada | | canceled | Operação cancelada | | canceled_permanently | Operação cancelada permanentemente | **8.1.1.** Para prosseguir com o Refinanciamento (Troco), o Parceiro deve realizar a seguinte chamada passando os campos 'Financial' e 'Disbursement Bank Accounts': *Adicionalmente, pode-se passar o campo 'purchaser_document_number' para alterar o cessionário da operação. **Request** - MÉTODO POST - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation/acceptance Testar no Playground **Request Body** ```json { "financial": { "installment_face_value": 379.87, "monthly_interest_rate": 0.0166, "number_of_installments": 84, "limit_days_to_disburse": 7, "disbursement_date": "2024-07-02", "rebates": [ { "rebate_bank_account": { "bank_code": "329", "account_digit": "9", "document_number": "18533555000164", "name": "Teste Ltda", "account_number": "4290002", "branch_number": "0001" }, "amount_type": "percentage", "fee_type": "spread", "amount": 9.5 }, { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "insurance_premium" } ] }, "disbursement_bank_accounts": [ { "document_number": "92093764000197", "branch_number": "0001", "name": "TESTE LTDA", "percentage_receivable": 100, "account_number": "120012", "account_digit": "3", "bank_code": "329" } ], "purchaser_document_number": "28534595027164" } ``` **Response:** **Response** ```json { "credit_operation_key": "\", "contract_number": "00000002", "document_key": "\", "document_url": "\", "credit_operation_status": "issued", "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [{ "installments": [{ "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-08-09", "calendar_days": 53, "digitable_line": null, "due_date": "2021-08-08", "due_interest": 0, "due_principal": 997.87, "fine_amount": null, "has_interest": true, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-09-08", "calendar_days": 31, "digitable_line": null, "due_date": "2021-09-08", "due_interest": 0, "due_principal": 690.8886500498395, "fine_amount": null, "has_interest": true, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "tax_amount": 0, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 50, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 997.87, "final_disbursement_amount": 100, "issue_amount": 1147.87, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 }], "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "ispb": "00000000", "branch_number": "0001" } } ``` **8.1.2.** Caso o Parceiro opte por não prosseguir com a Operação de Refinanciamento (Troco), ele deve realizar a seguinte chamada: **Request** - MÉTODO DELETE - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation **8.2. Averbação do Refinanciamento (Troco):** Assim que o Parceiro optar por prosseguir com a Operação de Refinanciamento, a rotina para averbação da margem consignável terá início. Assim que a averbação da margem consignável do INSS for concluída o parceiro recebera o seguinte webhook: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.collateral **Body** ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "refinancing", "credit_operation_key": "\", "collateral_type": "social_security", "collateral_constituted": true } } ``` **8.3. Desembolo do Refinanciamento (Troco):** Assim que a averbação da margem consignável do INSS for concluída a operação estará pronta para desembolso. No desembolso da Operação de Refinanciamento, a Operação de Portabilidade será quitada e caso exista valor desembolsado remanescente (**7.1.1. "disbursement_options.final_disbursement_amount"**), este valor será liberado para o cliente (Troco) na conta para desembolso da Operação (**"disbursement_bank_account"**). A liberação do troco para o cliente pode ser realizada via PIX ou TED, em qualquer horário do dia (obedecendo horário comercial de 7:00 às 17:00 em dias úteis, no caso da TED). **8.3.1.** Caso o desembolso do troco para o cliente seja bem sucedido, será enviado um webhook com os dados da comprovação do desembolso: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **body.json** ```json { "webhook_type": "credit_transfer.proposal.credit_operation", "proposal_key": "\", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_status": "disbursed", "credit_operation_type": "refinancing", "credit_operation_key": "\", "ted_receipt_list": [{ "fee": 0, "url": "https://qitech.com.br/", "amount": 500, "origin": { "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "type": "payment_account", "branch": "0001", "document": "32402502000135", "bank_code": "329", "account_key": "871059bd-4014-41ad-82b4-28275ff0e67b", "branch_digit": null, "account_digit": "5", "account_branch": "0001", "account_number": "00002" }, "timestamp": "2022-09-28T13:00:47", "description": "DESCRIPTION", "destination": { "name": "Elaine Isadora da Cruz", "type": "checking_account", "bank_code": "033", "branch": "0001", "purpose": "Crédito PIX em Conta", "document_number": "90406718261", "bank_ispb": "90400888", "branch_digit": null, "account_digit": "1", "account_number": "00001" }, "end_to_end_id": null, "transaction_key": "871059bd-4014-41ad-82b4-28275ff0e67b", "origin_transaction_key": null }] } } ``` **8.3.2.** Caso ocorra falha no desembolso, o parceiro receberá o seguinte webhook: **7.3.2.1.** Falha no desembolso via PIX: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **body.json** ```json { "webhook_type": "credit_transfer.proposal.credit_operation", "proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_status": "canceled", "credit_operation_type": "refinancing", "credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333", "pix_refusal": { "reason_enumerator": "invalid_document_number", "reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino." }, "cancel_reason": "pix_refusal" } } ``` **7.3.2.2.** Falha no desembolso via TED: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **body.json** ```json { "webhook": { "data": { "cancel_reason": "Agência ou Conta Destinatária do Crédito Inválida", "credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333", "credit_operation_type": "refinancing", "credit_operation_status": "canceled", "cancel_reason_enumerator": "agencia_conta_invalida" }, "proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999", "webhook_type": "credit_transfer.proposal.credit_operation", "event_datetime": "2023-12-22T10:15:25" } } ``` **8.3.3.** No caso de falha no desembolso da Operação, o desembolso pode ser retentato alterando-se os dados bancários: **Request** - MÉTODO PATCH - ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation Testar no Playground *Payload:* **payload.json** ```json { "disbursement_date": "2022-11-04", "disbursement_bank_account": { "account_branch": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "document_number": "14950479032", "ispb": "17298092", "name": "Maria da Silva" } } ``` --- # Recálculo e Reformalização do Refinanciamento URL: /documentation/guides/INSS/portability+refinancing/reformalization Recálculo e Reformalização do Refinanciamento Enquanto a operação de **refinanciamento ainda não foi averbada na Dataprev**, é possível corrigir seus dados financeiros e bancários. Existem dois endpoints para isso: | Endpoint | Gera nova CCB? | Quando usar | |----------|----------------|-------------| | `PUT …/refinancing_credit_operation` | **Sim** (reassinatura) | Corrigir condições e **emitir uma nova CCB** para reassinatura. | | `PUT …/refinancing_credit_operation/recalculate` | **Não** | Ajustar o **valor da parcela** sem gerar nova CCB. | Ambos aceitam o objeto `collateral_data` para **adicionar, alterar ou remover a carência** (`number_of_grace_periods`) informada pelo requisitante — veja [Carência](#carência). :::info Pré-condição comum A operação de refinanciamento **não pode estar averbada** (constituída na Dataprev). Caso contrário, retornamos [`CT000079`](#errors). ::: --- ## Correção com nova CCB Corrige os dados financeiros e bancários da operação de refinanciamento gerando uma **nova CCB**. Use quando for necessário reemitir o contrato. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation MÉTODO PUT Testar no Playground **Request Body** ```json { "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-06-10", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "monthly_interest_rate": 0.0167, "installment_face_value": 410, "limit_days_to_disburse": 7, "number_of_installments": 84 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" } } ``` A resposta (`200`) retorna o objeto da operação de refinanciamento — mesma estrutura apresentada no [Fluxo Completo](/documentation/guides/INSS/portability+refinancing/end-to-end). :::caution Reassinatura obrigatória A `credit_operation_key`, a `document_key`, a `document_url`, a `related_party_key` e a `borrower.related_party_key` **mudam** após essa ação, sendo necessária a **reassinatura da CCB**. ::: --- ## Recálculo sem nova CCB Recalcula o **valor da parcela** da operação de refinanciamento **sem gerar uma nova CCB**. O novo valor de parcela deve ser **menor** que o original. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation/recalculate MÉTODO PUT Testar no Playground **Request Body** ```json { "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-06-10", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "monthly_interest_rate": 0.0167, "installment_face_value": 410, "limit_days_to_disburse": 7, "number_of_installments": 84 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" } } ``` A resposta (`200`) retorna o objeto da operação de refinanciamento — mesma estrutura apresentada no [Fluxo Completo](/documentation/guides/INSS/portability+refinancing/end-to-end). :::caution Atenção O novo `installment_face_value` precisa ser **menor** que o valor original. A redução do valor de troco para o tomador não pode ultrapassar **30%** (caso contrário, retornamos [`CT000105`](#errors)). ::: --- ## Carência Conforme a IN 204, as operações de INSS podem ter **carência** (`number_of_grace_periods`), informada dentro de `collateral_data` na criação da proposta. Tanto a **correção com nova CCB** quanto o **recálculo** permitem **alterar ou remover** essa carência, enviando o objeto `collateral_data` no corpo da requisição. collateral_data.number_of_grace_periods integer opcional Número de meses de carência (de 0 a 3). Aplica-se à garantia social_security da operação. | Valor enviado | Comportamento | |---------------|---------------| | `1`, `2` ou `3` | **Define/atualiza** a carência da operação. | | `0` | **Remove** a carência previamente informada. | | Campo ausente (sem `collateral_data`) | Mantém a carência atual, sem alteração. | | Fora do intervalo (`< 0` ou `> 3`) | Erro [`CT000090`](#errors). | **Exemplo — removendo a carência no recálculo** ```json { "financial": { "installment_face_value": 380, "number_of_installments": 84, "monthly_interest_rate": 0.0166 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "bank_code": "033", "branch_number": "0001" }, "collateral_data": { "number_of_grace_periods": 0 } } ``` :::info Ao alterar a carência, a **primeira data de vencimento** (`first_due_date`) é recalculada junto à Dataprev a partir do novo número de meses de carência. ::: --- ## Erros {#errors} | Código HTTP | Código QI | Descrição | |-------------|-----------|-----------| | 404 | `CT000002` | Proposta não encontrada. | | 404 | `CT000043` | Operação de refinanciamento não encontrada. | | 400 | `CT000046` | O status da operação de refinanciamento não permite essa operação. | | 400 | `CT000079` | Operação de refinanciamento não pode estar constituída (averbada) para alterar dados. | | 400 | `CT000090` | Número de carências inválido. O intervalo aceito é de 0 a 3. | | 400 | `CT000100` | O valor do desembolso final é inferior ao mínimo permitido. | | 400 | `CT000105` | A redução do valor de troco para o tomador não pode ser maior que 30%. | | 400 | `CT000133` | Prêmio de seguro QI não é permitido para INSS. | --- # Fura-fila (priority request) URL: /documentation/guides/INSS/reservations/priority-request Fura-fila (priority request) Mecanismo para tentar uma **averbação de forma síncrona**, sem esperar a fila assíncrona da Dataprev, usando um **balde de fichas** por requester. Cada chamada consome uma ficha; em caso de sucesso na averbação a ficha pode ser devolvida; em falha, a ficha é perdida até a próxima reposição periódica. :::info Não confunda com reserva prioritária (fixed rate) Este guia trata de **`POST …/priority_request`** e **`GET /social_security/bucket_configuration`** (balde de fichas / fura-fila). É **diferente** da marcação de reserva **`fixed_rate`** em [Reserva prioritária (fixed rate)](/documentation/guides/INSS/reservations/priority-reservation) (`PATCH` / `DELETE` em `/priority_reservation`). ::: ## Contexto A Dataprev limita o throughput (**ordem de 25 requisições por segundo**). Por isso as tentativas de averbação costumam ser processadas em **fila**. O endpoint `priority_request` permite pular essa fila quando há **ficha disponível** no balde. **Resumo do balde:** - Cada requisição **consome** uma ficha. - Averbação **bem-sucedida** → a ficha pode ser **devolvida** ao balde. - Averbação com **erro** → a ficha é **perdida** até a reposição. - Existe **capacidade máxima** e **intervalo de reposição** configurados para o seu requester. - Sem fichas → nova tentativa falha até a próxima reposição. **Exemplo ilustrativo do balde** Configuração de exemplo: **10 fichas** máximas, **30 minutos** entre reposições. **Hora 0:** balde criado na capacidade máxima. **9 min:** uma requisição falha na averbação → perde 1 ficha. **17 min:** uma requisição tem sucesso → número de fichas inalterado. **30 min:** primeira reposição → balde volta ao máximo. **47 min:** dez requisições com sucesso → nenhuma ficha perdida. **1 h:** segunda reposição; se o balde já estiver cheio, nada muda. **1 h 12 min:** cinco falhas → perda de 5 fichas. **1 h 30 min:** terceira reposição → ex.: 6 fichas disponíveis. **1 h 38 min:** seis falhas → balde esgota. **1 h 51 min:** tentativa sem fichas → barrada. **2 h:** quarta reposição → novas tentativas liberadas. Para o passo a passo completo da operação (validação de reserva, webhooks de sucesso, correção de dados), veja o [Fluxo completo — crédito novo e refinanciamento](/documentation/guides/INSS/new-credit-and-refinancing/end-to-end#sistema-de-priorização-de-requisições-fura-fila). --- ## Disparar requisição prioritária Request ENDPOINT /social_security/reservation/external_key/ EXTERNAL_KEY /priority_request MÉTODO POST Path params external_key string obrigatório Chave da operação no fluxo (mesmo conceito de DEBT-KEY nos roteiros INSS ou payroll_card_reservation_key nos fluxos de cartão consignado INSS). **Body:** não há corpo na requisição. Testar no Playground **Python** ```python title="ENDPOINT" POST /social_security/reservation/external_key/YOUR_EXTERNAL_KEY/priority_request ``` **curl** ```bash title="ENDPOINT" curl -X POST \ 'https://api-auth.sandbox.qitech.app/social_security/reservation/external_key/YOUR_EXTERNAL_KEY/priority_request' \ -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \ -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \ -H 'SELECTED-AGENT: YOUR_REQUESTER_KEY' \ -H 'Content-Type: application/json' ``` Response (sucesso) STATUS 200 Atributos max_bucket_capacity integer Capacidade máxima do balde (fichas). bucket_fill_rate_minutes integer Intervalo de reposição, em minutos. available_tokens integer Fichas disponíveis após a operação. status string Status da reserva após a tentativa (ex.: pending_document_submission ). next_refill_at string Próximo instante de reposição do balde (ISO 8601). :::tip Webhook de sucesso Se a averbação for concluída com sucesso, o parceiro recebe o webhook credit_operation.collateral com status de sucesso. Detalhes no [mesmo capítulo do fluxo completo](/documentation/guides/INSS/new-credit-and-refinancing/end-to-end#sucesso-na-averbação). ::: ```json title="RESPONSE BODY" { "max_bucket_capacity": 10, "bucket_fill_rate_minutes": 30, "available_tokens": 7, "status": "pending_document_submission", "next_refill_at": "2025-02-04T20:28:35Z" } ``` --- ## Consultar configuração do balde Permite ver capacidade, fichas disponíveis e próxima reposição **sem** disparar uma requisição prioritária. Request ENDPOINT /social_security/bucket_configuration MÉTODO GET Sem path params nem query obrigatórios. Testar no Playground **Python** ```python title="ENDPOINT" GET /social_security/bucket_configuration ``` **curl** ```bash title="ENDPOINT" curl -X GET \ 'https://api-auth.sandbox.qitech.app/social_security/bucket_configuration' \ -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \ -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \ -H 'SELECTED-AGENT: YOUR_REQUESTER_KEY' \ -H 'Content-Type: application/json' ``` Response STATUS 200 Atributos max_bucket_capacity integer Capacidade máxima do balde. bucket_fill_rate_minutes integer Intervalo de reposição, em minutos. available_tokens integer Fichas disponíveis no momento. next_refill_at string Próxima reposição (ISO 8601). ```json title="RESPONSE BODY" { "max_bucket_capacity": 10, "bucket_fill_rate_minutes": 30, "available_tokens": 7, "next_refill_at": "2025-02-04T20:08:35Z" } ``` --- ## Erros | HTTP | Código | Título (exemplo) | Quando ocorre | |------|--------|------------------|---------------| | 400 / 4xx | SSC000083 | Reservation Failed | Tentativa prioritária executada, mas a averbação falhou (mensagem costuma citar última resposta da Dataprev, fichas restantes e próxima reposição). | | 429 / 4xx | SSC000080 | Rate limit exceeded | Nenhuma ficha disponível; aguardar a próxima reposição do balde. | **Exemplos de corpo de erro (JSON)** ```json { "title": "Reservation Failed", "description": "Last Response: consignable_margin_excceded, Tokens Available: 9, Next Refill At: 2025-02-04T20:18:35Z", "translation": "Ultima resposta: consignable_margin_excceded, Fichas disponiveis: 9, Proxima Recarga: 2025-02-04T20:18:35Z", "extra_fields": {}, "code": "SSC000083" } ``` ```json { "title": "Rate limit exceeded", "description": "Request limit exceeded. No tokens available, next refill in 8 minutes.", "translation": "Limite de solicitacoes excedido. Nenhuma ficha disponivel, proxima recarga em 8 minutos.", "extra_fields": {}, "code": "SSC000080" } ``` --- # Fila prioritária URL: /documentation/guides/INSS/reservations/priority-reservation Fila prioritária (fixed rate) Marca a reserva INSS como `fixed_rate`, respeitando o **limite de reservas prioritárias ativas**. **Quando usar** - **Desbloqueio:** o benefício está em liberação. - **Concorrência por margem:** operações concorridas e críticas (ex.: novo entrante). **Antes de priorizar múltiplas reservas:** `GET /social_security/priority_reservation_configuration` mostra uso atual e limite. ## Status da reserva permitidos Só é possível **definir** ou **remover** prioridade `fixed_rate` quando a reserva está em um destes status: | Status | Descrição resumida | |--------|-------------------| | `pending_reservation` | Reserva pendente | | `in_queue_pending_reservation` | Na fila, aguardando reserva | | `pending_balance_request` | Aguardando consulta de saldo | | `in_queue_pending_balance_request` | Na fila, aguardando consulta de saldo | Fora desses status, a API retorna erro indicando status não permitido. :::tip Limite simultâneo Se o número de reservas já marcadas como prioritárias atingir o máximo configurado, um novo `PATCH` retorna erro de limite excedido. Use o `GET` de configuração para acompanhar o uso atual sem priorizar outra reserva. ::: --- ## Definir prioridade Request ENDPOINT /social_security/reservation/external_key/ EXTERNAL_KEY /priority_reservation MÉTODO PATCH Path params external_key string obrigatório Identificador externo da reserva no seu fluxo (mesmo conceito de DEBT-KEY nos roteiros de crédito consignado INSS). **Python** ```python title="ENDPOINT" PATCH /social_security/reservation/external_key/YOUR_EXTERNAL_KEY/priority_reservation ``` **curl** ```bash title="ENDPOINT" curl -X PATCH \ 'https://api-auth.sandbox.qitech.app/social_security/reservation/external_key/YOUR_EXTERNAL_KEY/priority_reservation' \ -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \ -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \ -H 'SELECTED-AGENT: YOUR_REQUESTER_KEY' \ -H 'Content-Type: application/json' ``` Response STATUS 200 Atributos external_key string Chave externa da reserva. reservation_priority_type string Tipo de prioridade; em sucesso, fixed_rate . current_number_of_priority_reservations integer Quantidade atual de reservas prioritárias do requester após a operação. max_number_of_priority_reservations integer Limite máximo configurado. ```json title="RESPONSE BODY" { "external_key": "550e8400-e29b-41d4-a716-446655440000", "reservation_priority_type": "fixed_rate", "current_number_of_priority_reservations": 1, "max_number_of_priority_reservations": 10 } ``` --- ## Remover prioridade Request ENDPOINT /social_security/reservation/external_key/ EXTERNAL_KEY /priority_reservation MÉTODO DELETE Path params external_key string obrigatório Identificador externo da reserva. Remove a prioridade da reserva (`reservation_priority_type` passa a `null`). Exige que a prioridade atual seja `fixed_rate` (se houver outro tipo, a API retorna erro). Status da reserva deve continuar na lista permitida. **Python** ```python title="ENDPOINT" DELETE /social_security/reservation/external_key/YOUR_EXTERNAL_KEY/priority_reservation ``` **curl** ```bash title="ENDPOINT" curl -X DELETE \ 'https://api-auth.sandbox.qitech.app/social_security/reservation/external_key/YOUR_EXTERNAL_KEY/priority_reservation' \ -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \ -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \ -H 'SELECTED-AGENT: YOUR_REQUESTER_KEY' \ -H 'Content-Type: application/json' ``` Response STATUS 200 Atributos external_key string Chave externa da reserva. reservation_priority_type null Sem prioridade após a remoção. current_number_of_priority_reservations integer Contagem após a remoção. max_number_of_priority_reservations integer Limite máximo configurado. ```json title="RESPONSE BODY" { "external_key": "550e8400-e29b-41d4-a716-446655440000", "reservation_priority_type": null, "current_number_of_priority_reservations": 0, "max_number_of_priority_reservations": 10 } ``` --- ## Consultar limite e uso atual Request ENDPOINT /social_security/priority_reservation_configuration MÉTODO GET Retorna o resumo de quantas reservas prioritárias o requester tem no momento, o máximo permitido e a lista completa das reservas atualmente na fila prioritária. **Python** ```python title="ENDPOINT" GET /social_security/priority_reservation_configuration ``` **curl** ```bash title="ENDPOINT" curl -X GET \ 'https://api-auth.sandbox.qitech.app/social_security/priority_reservation_configuration' \ -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \ -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \ -H 'SELECTED-AGENT: YOUR_REQUESTER_KEY' \ -H 'Content-Type: application/json' ``` Response STATUS 200 Atributos current_number_of_priority_reservations integer Reservas prioritárias ativas no momento. max_number_of_priority_reservations integer Teto configurado para o requester. reservations array of objects Lista das reservas atualmente na fila prioritária, ordenadas por fixed_rate_set_at crescente. Máximo de 100 itens. **Atributos de reservations** credit_operation_key string Chave externa da reserva. contract_number string Número do contrato. status string Status atual da reserva. Valores possíveis: pending_reservation , in_queue_pending_reservation , pending_balance_request , in_queue_pending_balance_request . type string Enumerador do tipo da reserva. fixed_rate_set_at string (ISO 8601) Data e hora em que a reserva foi adicionada à fila prioritária. ```json title="RESPONSE BODY" { "current_number_of_priority_reservations": 2, "max_number_of_priority_reservations": 10, "reservations": [ { "credit_operation_key": "550e8400-e29b-41d4-a716-446655440000", "contract_number": "BYX2000013373", "status": "pending_reservation", "type": "new", "fixed_rate_set_at": "2026-04-13T14:00:00Z" } ] } ``` --- ## Erros ### PATCH — definir prioridade | HTTP | Código | Título (exemplo) | Quando ocorre | |------|--------|------------------|---------------| | 400 | QIT000006 | Priority reservation configuration not set | Requester sem configuração de prioridade de reserva | | 400 | QIT000006 | Reservation status not allowed | Status da reserva fora da lista permitida | | 400 | QIT000006 | Priority reservation limit exceeded | Limite simultâneo atingido | | 404 | SSC000035 | Reservation not Found | Reserva inexistente para requester + `external_key` | | 409 | QIT000008 | Priority reservation already fixed_rate | Já está `fixed_rate` | ### DELETE — remover prioridade | HTTP | Código | Título (exemplo) | Quando ocorre | |------|--------|------------------|---------------| | 400 | QIT000006 | Reservation priority type not fixed_rate | Há prioridade, mas não é `fixed_rate` | | 400 | QIT000006 | Reservation status not allowed | Status não permitido | | 404 | SSC000035 | Reservation not Found | Reserva não encontrada | ### GET — configuração | HTTP | Código | Título (exemplo) | Quando ocorre | |------|--------|------------------|---------------| | 404 | QIT000007 | Priority reservation configuration not found | Sem configuração para o requester | **Exemplos de corpo de erro (JSON)** ```json { "title": "Reservation not Found", "description": "...", "translation": "...", "code": "SSC000035" } ``` ```json { "title": "Priority reservation already fixed_rate", "description": "...", "translation": "...", "code": "QIT000008" } ``` --- # Assinatura em grupo (INSS) URL: /documentation/guides/INSS/signatures/batch-group-signature :::caution Disponibilidade Este fluxo está em implantação. Por ora, ele cobre operações **INSS** (`social_security`) com o certificador **`qi_sign`**. Alinhe com o time de integração da QI Tech a liberação para o seu requester antes de iniciar a integração em produção. ::: O fluxo de **assinatura em grupo** agrupa **várias operações** em **uma única pasta de assinatura** do QI Sign. O beneficiário faz **uma única jornada de assinatura** (prova de vida, documento e OTP) e assina **todas as operações do grupo de uma só vez**, com **um único link**. :::info Fluxo 0. (opcional) Faça upload do [documento de identificação](#documento-de-identificacao-pre-coletado) do beneficiário, para que ele não precise fotografá-lo durante a assinatura 1. Abra o grupo com `POST /document/document_batch_group` e guarde a `document_batch_group_key`. 2. Crie cada operação (`/debt`, `/v2/credit_transfer/proposal`, etc) enviando `document_batch_group_key` na raiz do payload. 3. (Opcional) Consulte o grupo e remova operações antes do envio. 4. Envie o grupo para assinatura com `PUT /document/document_batch_group/{key}/send_to_signature` e obtenha o **link único** do beneficiário. 5. O beneficiário assina todas as operações de uma vez; cada operação evolui individualmente e o grupo é concluído quando todas chegam a um status terminal. ::: :::info Grupo × lote Cada operação (dívida, proposta de portabilidade/refin ou reserva de cartão) continua sendo **um lote** (envelope). O **grupo** é a camada acima dos lotes (pasta), responsável por reunir os envelopes e disparar **uma única assinatura**. Se você ainda utiliza o fluxo de [lote externo](/documentation/guides/INSS/signatures/batch-signature), consulte a [tabela de migração](#migracao) ao final desta página. ::: :::caution Regras do grupo - **Assinante único:** o grupo suporta **apenas um assinante** (o beneficiário). Não é possível informar múltiplos assinantes na pasta. - **Mesma titularidade:** o assinante informado na abertura do grupo deve ser **o mesmo** de todas as operações anexadas. Operação com assinante divergente retorna **erro síncrono** (`DOC000121`). - **Tipos permitidos:** o grupo aceita operações INSS de Crédito Novo, Portabilidade/Refinanciamento e Cartão Consignado, desde que compartilhem o mesmo assinante. - **Limite de operações:** o grupo aceita **no máximo 7 operações** (lotes). A inclusão de uma operação além do limite retorna **erro síncrono** (`DOC000127`). - **Contato obrigatório:** informe `signer_email` e/ou `signer_phone` no assinante. Sem um meio de contato, não é possível gerar o link de assinatura. - **Certificador:** derivado automaticamente da configuração do requester (`qi_sign`); não é enviado na requisição. ::: :::info Convivência com os fluxos atuais (período de transição) O fluxo de grupo é **opcional e aditivo**: ele só é acionado quando `document_batch_group_key` é enviado na criação da operação. Os fluxos existentes — assinatura individual por operação com o certificador configurado para o requester (inclusive certificadores externos, como `client_side`) e o [lote externo](/documentation/guides/INSS/signatures/batch-signature) — **continuam funcionando sem alteração** durante o período de transição. Dentro do grupo, a assinatura é sempre coletada via **QI Sign**, mesmo que o requester utilize outro certificador nos fluxos regulares. ::: --- ## 1. Abrir o grupo ENDPOINT /document/document_batch_group MÉTODO POST Request Body ```json { "batch_group_type": "social_security", "request_control_key": "5ed20003-0610-46d2-88cc-a5d0de640696", "signer": { "signer_document_number": "14471835092", "signer_name": "Nome devedor", "signer_email": "maria.silva@email.com", "signer_phone": { "country_code": "55", "area_code": "11", "number": "999538380" }, "signer_role": "issuer", "signature_method": "whatsapp" }, "personal_document": { "type": "rg", "document_identification_front_key": "3b28a1a6-51c0-4f0e-9b64-2c98d6a3f1e0", "document_identification_back_key": "9d47c2b1-8f3a-4e5d-a1c2-7b6e5d4f3a2b" } } ``` ### Body Params :::info Certificador O certificador (`qi_sign`) é **derivado** da configuração do requester e **não** é enviado na requisição. Requesters cuja configuração não use `qi_sign` recebem `DOC000118`. ::: | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `batch_group_type` | string | Tipo do grupo. Atualmente o único valor é `social_security`. | **[Batch Group Type](#batch-group-type)** | | `request_control_key` | string | Chave de **idempotência** (UUID v4), **obrigatória**. Reenviar o mesmo valor retorna o grupo já existente (evita grupos/pastas duplicados em retentativas). Não reutilize entre grupos distintos. | 36 | | `signer` | object | Dados do beneficiário que assinará todas as operações do grupo. | **[Signer Object](#signer-object)** | | `personal_document` | object | (Opcional) Documento de identificação do beneficiário coletado previamente, para dispensar a foto do documento durante a jornada de assinatura. | **[Documento pré-coletado](#documento-de-identificacao-pre-coletado)** | ### Signer Object | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `signer_document_number` | string | CPF/CNPJ do assinante (apenas dígitos). | 11 a 14 | | `signer_name` | string | Nome do assinante. | 100 | | `signer_email` | string | E-mail para envio do link de assinatura. (opcional) | 255 | | `signer_phone.country_code` | string | Código do país (ex.: `"55"`). (opcional) | 5 | | `signer_phone.area_code` | string | DDD do assinante. (opcional) | 5 | | `signer_phone.number` | string | Número de telefone do assinante. (opcional) | 15 | | `signer_role` | string | Papel do assinante (ex.: `issuer`). **Deve ser igual ao papel do assinante nas operações anexadas**, caso contrário a inclusão retorna `DOC000121`. | 100 | | `signature_method` | string | Canal de envio do link de assinatura. (opcional) | **[Signature Method](#signature-method)** | | `birth_date` | string | Data de nascimento do assinante (`AAAA-MM-DD`). (opcional) | 10 | ### Documento de identificação pré-coletado {#documento-de-identificacao-pre-coletado} Se o seu fluxo já coleta o documento de identificação do beneficiário (RG, CNH etc.) antes da assinatura, envie-o na abertura do grupo pelo objeto **`personal_document`**. As imagens são encaminhadas ao QI Sign junto com a criação da pasta e a etapa de captura do documento chega **pré-atendida** na jornada — o beneficiário não precisa fotografar o documento novamente durante a assinatura. O envio acontece em duas etapas: 1. **Faça o upload dos arquivos previamente** pelo [fluxo de upload de documentos](../../../upload_de_documentos/upload_de_documentos.md) e guarde a `document_key` de cada arquivo (um arquivo por lado do documento, ou um arquivo único no caso de documento digital). 2. **Referencie as chaves** no objeto `personal_document` da abertura do grupo. ```json title="Trecho ilustrativo (raiz do payload de abertura do grupo)" { "personal_document": { "type": "rg", "document_identification_front_key": "3b28a1a6-51c0-4f0e-9b64-2c98d6a3f1e0", "document_identification_back_key": "9d47c2b1-8f3a-4e5d-a1c2-7b6e5d4f3a2b" } } ``` #### Personal Document Object | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `type` | string | Tipo do documento de identificação. | **[Personal Document Type](#personal-document-type)** | | `document_identification_front_key` | string | `document_key` do arquivo com a **frente** do documento. Obrigatório no modo frente e verso (junto com `..._back_key`). | 36 | | `document_identification_back_key` | string | `document_key` do arquivo com o **verso** do documento. Obrigatório no modo frente e verso (junto com `..._front_key`). | 36 | | `document_identification_full_key` | string | `document_key` do arquivo **único** com o documento completo (documento digital). Não pode ser combinado com as chaves de frente/verso. | 36 | :::caution Regras do documento pré-coletado - Envie **frente + verso** (`document_identification_front_key` + `document_identification_back_key`) **ou** o **arquivo único** (`document_identification_full_key`) — nunca os dois modos juntos. - Cada `type` suporta modos específicos — veja **[Personal Document Type](#personal-document-type)**. Combinação inválida retorna `DOC000128`. - Os documentos referenciados devem pertencer ao seu requester e já ter o **arquivo enviado** (upload concluído). Chave inexistente ou de outro requester retorna `DOC000004`; documento sem arquivo retorna `DOC000049`. - O envio é feito **apenas na abertura do grupo** — não é possível adicionar ou trocar o documento depois que o grupo foi criado. Se algum arquivo for rejeitado, a criação do grupo falha por inteiro (nenhum grupo é criado). ::: O objeto `personal_document` enviado é ecoado nas [consultas do grupo](#3-consultar-o-grupo). --- ### Response STATUS 201 Response Body ```json { "document_batch_group_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc", "status": "pending_batches" } ``` | Campo | Tipo | Descrição | |---|---|---| | `document_batch_group_key` | string | Identificador do grupo. Guarde para os próximos passos. | | `status` | string | Status inicial do grupo: `pending_batches`. Veja **[Status do grupo](#status-do-grupo)**. | --- ## 2. Incluir operações no grupo Ao criar cada operação, envie **`document_batch_group_key` na raiz do JSON** (mesmo nível dos demais campos principais do produto). A operação é criada normalmente, mas a sua assinatura fica **vinculada à pasta do grupo** — não é gerado link de assinatura individual. Crédito Novo / Refin POST /debt Portabilidade / Refin POST /v2/credit_transfer/proposal Cartão POST /payroll_card_reservation/social_security | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `document_batch_group_key` | string | A `document_batch_group_key` retornada na abertura do grupo; enviada na raiz do payload de criação da operação. Obrigatório no fluxo com grupo. | 36 | ```json title="Trecho ilustrativo (raiz do payload)" { "document_batch_group_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc" } ``` O restante do body segue o contrato de cada endpoint. Consulte os [roteiros de crédito consignado INSS](/documentation/guides/INSS/intro) conforme o produto. :::info Resposta da operação no fluxo com grupo Como o link de assinatura passa a ser **único e no nível do grupo**, a resposta de criação da operação **não retorna** dados de assinatura individuais (ex.: `signature_information` na proposta de portabilidade/refin). O link é obtido apenas no [envio do grupo para assinatura](#5-enviar-para-assinatura). ::: --- ## 3. Consultar o grupo ENDPOINT /document/document_batch_group/{document_batch_group_key} MÉTODO GET Recomendado antes de enviar para assinatura, para conferir as operações agrupadas e seus status. ### Path Params | Campo | Tipo | Descrição | |---|---|---| | `document_batch_group_key` | string | Chave do grupo. | :::info Consulta por idempotência Também é possível consultar pela `request_control_key`: `GET /document/document_batch_group/request_control_key/{request_control_key}`. ::: ### Exemplo de chamada ``` GET /document/document_batch_group/17f35e19-a039-468f-aaa7-84aa8edec3dc ``` --- ### Response STATUS 200 Response Body ```json { "document_batch_group_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc", "request_control_key": "5ed20003-0610-46d2-88cc-a5d0de640696", "external_key": "c109d589-ae18-4f4f-ad31-2879bf714c71", "group_name": "Assinatura de operações INSS", "batch_group_type": "social_security", "status": "pending_batches", "signature_url": null, "personal_document": { "type": "rg", "document_identification_front_key": "3b28a1a6-51c0-4f0e-9b64-2c98d6a3f1e0", "document_identification_back_key": "9d47c2b1-8f3a-4e5d-a1c2-7b6e5d4f3a2b" }, "batches": [ { "document_batch_key": "5cca1dad-28fe-4f19-8bbb-0edd6f042384", "origin_key": "324caa35-ba10-4590-ae2b-5efef71709c3", "origin_type": "credit_operation", "status": "pending_signature" }, { "document_batch_key": "085e3098-0bdb-4472-a4ae-dafc1bafda53", "origin_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497", "origin_type": "credit_transfer_proposal", "status": "pending_signature" } ] } ``` | Campo | Tipo | Descrição | |---|---|---| | `document_batch_group_key` | string | Identificador do grupo. | | `request_control_key` | string | Chave de idempotência informada na abertura do grupo. | | `external_key` | string | Identificador da pasta no QI Sign. | | `group_name` | string | Nome gerado para o grupo (ex.: `Assinatura de operações INSS`). | | `batch_group_type` | string | Tipo do grupo. Veja **[Batch Group Type](#batch-group-type)**. | | `status` | string | Status do grupo. Veja **[Status do grupo](#status-do-grupo)**. | | `signature_url` | string | Link único de assinatura do beneficiário. Disponível após o envio para assinatura. Com o [preenchimento automático do login](#5-enviar-para-assinatura) habilitado, retorna o link já autenticado. | | `personal_document` | object | [Documento de identificação pré-coletado](#documento-de-identificacao-pre-coletado) informado na abertura do grupo (`null` se não enviado). | | `batches` | array | Operações anexadas ao grupo. **[Batch Object](#batch-object)** | ### Batch Object | Campo | Tipo | Descrição | |---|---|---| | `document_batch_key` | string | Chave do lote (envelope) da operação. | | `origin_key` | string | Chave da operação de origem. Veja **[Origin Type](#origin-type)**. | | `origin_type` | string | Tipo da operação de origem. Veja **[Origin Type](#origin-type)**. | | `status` | string | Status da operação dentro do grupo. Veja **[Status da operação](#status-da-operação)**. | --- ## 4. Remover operação do grupo Desvincula e cancela uma operação específica antes do envio para assinatura (para reagrupar, se necessário). Só é permitido enquanto o grupo está em `pending_batches`. ENDPOINT /document/document_batch_group/{document_batch_group_key}/remove_batch MÉTODO PUT ### Path Params | Campo | Tipo | Descrição | |---|---|---| | `document_batch_group_key` | string | Chave do grupo. | Request Body ```json { "origin_key": "324caa35-ba10-4590-ae2b-5efef71709c3" } ``` ### Body Params | Campo | Tipo | Descrição | |---|---|---| | `origin_key` | string | Chave da operação a remover (a mesma `origin_key` retornada na consulta do grupo). | --- ### Response STATUS 201 Retorna o grupo atualizado, já sem a operação removida em `batches` (mesmo formato da [consulta do grupo](#3-consultar-o-grupo)). Response Body ```json { "document_batch_group_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc", "status": "pending_batches", "signature_url": null, "batches": [ { "document_batch_key": "085e3098-0bdb-4472-a4ae-dafc1bafda53", "origin_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497", "origin_type": "credit_transfer_proposal", "status": "pending_signature" } ] } ``` --- ## 5. Enviar para assinatura Fecha o grupo e dispara a pasta para assinatura no QI Sign. Retorna o **link único** (`signature_url`) que o beneficiário usa para assinar todas as operações de uma só vez. ENDPOINT /document/document_batch_group/{document_batch_group_key}/send_to_signature MÉTODO PUT ### Path Params | Campo | Tipo | Descrição | |---|---|---| | `document_batch_group_key` | string | Chave do grupo. | **Body:** objeto JSON vazio `{}`. :::caution Pré-condições do envio - O grupo precisa estar em `pending_batches`. - Deve haver **ao menos uma** operação anexada (`DOC000120`). - Todas as operações devem ter o **mesmo assinante** do grupo (`DOC000121`). ::: --- ### Response STATUS 201 O grupo passa para `pending_signature` e a `signature_url` é preenchida. Response Body ```json { "document_batch_group_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc", "status": "pending_signature", "signature_url": "https://sign.sandbox.qitech.app/f/17f35e19-a039-468f-aaa7-84aa8edec3dc", "batches": [ { "document_batch_key": "085e3098-0bdb-4472-a4ae-dafc1bafda53", "origin_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497", "origin_type": "credit_transfer_proposal", "status": "pending_signature" } ] } ``` | Campo | Tipo | Descrição | |---|---|---| | `status` | string | Status do grupo após o envio: `pending_signature`. | | `signature_url` | string | Link único de assinatura do beneficiário. | | `batches` | array | Operações do grupo. **[Batch Object](#batch-object)** | :::info Link com preenchimento automático do login Sob demanda, é possível habilitar o **preenchimento automático do login**. Com a opção habilitada, a `signature_url` retornada no envio para assinatura e nas [consultas do grupo](#3-consultar-o-grupo) passa a ser um **link autenticado**: a tela de login da jornada de assinatura já vem preenchida com os dados do beneficiário. ::: --- ## Acompanhamento Após o envio, o beneficiário assina todas as operações com **um único link**. Na jornada de assinatura, o beneficiário pode **aceitar ou recusar cada operação individualmente** — desfechos parciais são normais (ex.: duas operações assinadas e uma recusada no mesmo grupo). Cada operação evolui de forma independente e o grupo é concluído (`completed`) quando **nenhuma** operação permanece em `pending_signature`, independentemente da combinação de desfechos. Acompanhe o desfecho de cada operação pelos webhooks do respectivo produto (abaixo) ou pela [consulta do grupo](#3-consultar-o-grupo). :::info Submissão automática (Portabilidade/Refin) No fluxo com grupo, após a assinatura da proposta de portabilidade/refin a submissão à registradora é feita **automaticamente** — a proposta avança para `pending_response` sem necessidade do `PATCH` manual de submissão. ::: ### Webhook de operação assinada Cada operação assinada segue o **mesmo fluxo de webhooks do produto** (dívida emitida, proposta submetida etc.) — nenhum campo muda em relação ao fluxo sem grupo. Consulte os webhooks de cada produto nos [roteiros INSS](/documentation/guides/INSS/intro). ### Webhook de assinatura recusada Quando o beneficiário **recusa** uma operação do grupo, a operação é **cancelada** no respectivo produto e o parceiro recebe o webhook de mudança de status com o motivo `signature_rejected`: **Crédito Novo / Refin (dívida):** ```json { "key": "324caa35-ba10-4590-ae2b-5efef71709c3", "data": { "cancel_reason": "Operação cancelada porque o assinante recusou a assinatura.", "cancel_reason_enumerator": "signature_rejected" }, "status": "canceled", "webhook_type": "debt", "event_datetime": "2026-07-06 14:30:00" } ``` **Portabilidade / Refin (proposta):** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "2f7e320c-2a35-4e78-bfd7-a298b28a7497", "event_datetime": "2026-07-06T14:30:00", "proposal_status": "canceled", "cancel_reason": "signature_rejected" } ``` | Produto | `webhook_type` | Campo de status | Motivo da recusa | |---|---|---|---| | Crédito Novo / Refin | `debt` | `status: "canceled"` | `data.cancel_reason_enumerator: "signature_rejected"` | | Portabilidade / Refin | `credit_transfer.proposal` | `proposal_status: "canceled"` | `cancel_reason: "signature_rejected"` | Na [consulta do grupo](#3-consultar-o-grupo), a operação recusada aparece com status `sign_rejected`. --- ## Erros | HTTP | Código | Quando ocorre | |---|---|---| | 400 | `DOC000118` | O certificador configurado para o requester não é suportado (apenas `qi_sign`). | | 404 | `DOC000117` | Grupo não encontrado para a chave informada. | | 409 | `DOC000119` | Grupo não está em `pending_batches` e não pode ser modificado. | | 400 | `DOC000120` | Envio para assinatura sem nenhuma operação anexada. | | 400 | `DOC000121` | Assinante de uma operação difere do assinante do grupo. | | 400 | `DOC000122` | `origin_key` não informado na remoção. | | 404 | `DOC000123` | `origin_key` não encontrado entre as operações do grupo. | | 400 | `DOC000127` | O grupo já possui o número máximo de operações (5). | | 400 | `DOC000128` | O `type` do documento pré-coletado não suporta o modo enviado (frente e verso × arquivo único). Veja **[Personal Document Type](#personal-document-type)**. | | 400 | `DOC000129` | A jornada de assinatura configurada para o requester não coleta documento de identificação — o envio de documento pré-coletado não se aplica. | | 400 | `DOC000130` | O `type` do documento pré-coletado não está entre os tipos aceitos pela configuração do requester. | | 404 | `DOC000004` | `document_key` do documento pré-coletado não encontrada (inclui documento pertencente a outro requester). | | 400 | `DOC000049` | Documento pré-coletado sem arquivo — o upload não foi concluído antes da abertura do grupo. | | 400 | `DOC000126` | Configuração do requester incompleta. | | 404 | `DOC000091` | Configuração de certificador não encontrada para o requester. | --- ## Enumeradores ### Batch Group Type | Enumerador | Descrição | |---|---| | `social_security` | Operações de crédito consignado INSS. | ### Signature Method | Enumerador | Descrição | |---|---| | `email` | Link de assinatura enviado por e-mail. | | `sms` | Link de assinatura enviado por SMS. | | `whatsapp` | Link de assinatura enviado por WhatsApp. | ### Personal Document Type Tipos aceitos no [documento de identificação pré-coletado](#documento-de-identificacao-pre-coletado) e os modos de envio suportados por cada um: | Enumerador | Documento | Frente e verso | Arquivo único | |---|---|---|---| | `rg` | Registro Geral (RG) | ✔ | — | | `cnh` | Carteira Nacional de Habilitação | ✔ | ✔ | | `cin` | Carteira de Identidade Nacional | — | ✔ | - **Frente e verso:** envie `document_identification_front_key` + `document_identification_back_key`. - **Arquivo único:** envie apenas `document_identification_full_key` (documento digital, ex.: CNH digital). ### Origin Type | Enumerador | Operação | `origin_key` | |---|---|---| | `credit_operation` | Crédito Novo / Refin (`POST /debt`) | `credit_operation_key` | | `credit_transfer_proposal` | Portabilidade / Refin (`POST /v2/credit_transfer/proposal`) | `proposal_key` | | `payroll_card_reservation` | Cartão Consignado (`POST /payroll_card_reservation/social_security`) | chave da reserva | ### Status do grupo | Status | Descrição | |---|---| | `pending_batches` | Grupo aberto, recebendo operações. Permite incluir/remover operações. | | `pending_signature` | Enviado para assinatura; aguardando o beneficiário assinar. | | `completed` | Todas as operações do grupo chegaram a um status terminal. | | `canceled` | Grupo cancelado. | ### Status da operação | Status | Descrição | |---|---| | `pending_signature` | Operação anexada ao grupo, aguardando assinatura. | | `signed` | Operação assinada com sucesso. | | `sign_rejected` | Beneficiário recusou a assinatura da pasta. | | `canceled` | Operação/pasta cancelada. | --- ## Migração do lote externo para o grupo {#migracao} O fluxo de [lote externo](/documentation/guides/INSS/signatures/batch-signature) (`document_batch_key`) é substituído pelo fluxo de grupo (`document_batch_group_key`). Principais diferenças: - Você **não** cria mais o lote e adiciona documentos manualmente: cada operação (`/debt`, `/v2/credit_transfer/proposal`, cartão) já é um lote, e o **grupo** apenas os reúne. - O link de assinatura passa a ser **único e no nível do grupo**, retornado no envio para assinatura — não há link por operação. | Antigo (lote externo) | Novo (grupo) | |---|---| | `POST /document/document_batch` (`type: social_security_external_batch`) | `POST /document/document_batch_group` | | `document_batch_key` na raiz da operação | `document_batch_group_key` na raiz da operação | | `GET /document/document_batch/{key}` | `GET /document/document_batch_group/{key}` | | `DELETE /document/document_batch/{key}/documents` (limpar tudo) | `PUT /document/document_batch_group/{key}/remove_batch` (remover uma operação) | | `PUT /document/document_batch/{key}/send_to_signature` | `PUT /document/document_batch_group/{key}/send_to_signature` | --- # Manual Consignado Privado - Formalização Externa URL: /documentation/manual_consignado_privado/manual_assinatura_externa :::info Navegação - [Emissão e Formalização](/documentation/manual_consignado_privado/manual_credito_novo) (anterior) - [Averbação e Desembolso](/documentation/manual_consignado_privado/manual_averbacao_desembolso) (próximo) ::: :::caution API em desenvolvimento A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações. ::: Nesta seção, você encontrará as orientações necessárias para utilizar as APIs de formalização de operações originadas no fluxo ativo sem o uso do QIsign, a solução de assinatura eletrônica da QI Tech. Este fluxo é destinado a clientes que optam por utilizar uma solução externa de assinatura eletrônica (como DocuSign, Clicksign, entre outras) para formalizar seus contratos. ## 1 - Envio de documentos É obrigatório o envio dos dados complementares do contrato. Os documentos devem ser enviados através do [endpoint de upload de documentos](../upload_de_documentos) e devem seguir a seguinte formatação: | Validações | Valores | |----------------|--------------| | Formato | JPEG | | Tamanho mínimo | 250 x 250 px | Após o upload dos documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da operação ou após, através do seguinte endpoint: ENDPOINT /debt/ DEBT-KEY /related_party/ RELATED-PARTY-KEY /attached_document MÉTODO POST Testar no Playground Request Body ```json { "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41", "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431", "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c" } ``` :::info Informação A **related_party_key** é retornada na response da criação de dívida dentro do objeto **borrower** ::: ## 2 - Formalização da operação Após o input dos documentos a operação pode seguir para formalização. No caso de assinatura por parte do representante legal, no campo "**data.contract.signers[i]**" serão retornados os dados do representante legal, e o valor do objeto "**data.contract.signers[i].signer_role**" será "**issuer_legal_representative**". **No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 1. Os campos obrigatórios são os seguintes: _ip_address_ e _signature_datetime_.** ### Request ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST Testar no Playground #### **EXEMPLOS DE PAYLOAD** Request Body - PDF Assinado ```json { "path-pdf-signed": "https://storage.googleapis.com/sandbox-doc-api-private/documents/8b740ca1-405d-4507-a7b3-e7de01c4e008/BENJAMINERAPHAELA-NOME_DEVEDOR-CCB-LCM3307596554-20250721184150_signed.pdf", "type": "pdf-signature", "biometry_analysis_reference": "serpro", "similarity_score": "0.96", "ip_address": "192.168.0.0", "signature_datetime": "2025-07-22T14:30:12.729Z" } ``` Request Body - Assinatura Por Evidências ```json { "biometry_analysis_reference": "serpro", "signature_datetime": "2025-07-21T10:38:23.382748Z", "similarity_score": 0.98, "ip_address": "179.104.42.245", "type": "data-signature", "signatures": [ { "authenticity": { "timestamp": "2025-07-21 10:38:23", "ip_address": "179.104.42.245", "session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3" }, "signer": { "name": "Nome devedor", "email": "naotem@gmail.com", "phone": { "country_code": "055", "area_code": "84", "number": "999538380" }, "document_number": "11200770870" }, "authentication_type": "opt-in" } ] } ``` :::caution Atenção O payload de envio da assinatura varia de acordo com o processo de formalização do parceiro e deve ser alinhado com o time de integração da QI Tech. ::: #### Enumeradores _Biometry Analysis Reference_ | Enumerador | Descrição | |---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **serpro** | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro) | | **tse** | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE | | **not_found** | Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro. | --- # Manual Consignado Privado - Acompanhamento da Operação de crédito URL: /documentation/manual_consignado_privado/manual_assinatura_leilao ## 1. Formalização Após vencer o leilão interno, o parceiro deve aguardar o recebimento do webhook de formalização, indicando que o tomador finalizou o fluxo de assinatura do QI Sign. ```json { "key": "", "status": "signed", "signers": [ { "id": "3271efd3-89ba-43aa-b032-af9a459e6096", "images": { "face_image_url": "https://qisign-face-images-bucket-sandbox.s3.amazonaws.com/fad7f924-d210-4ec4-9565-a57662a0a65a.jpeg", "document_back_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/8c7b68ba-07ad-4188-82ae-679833b2843b.jpeg", "document_front_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/f63cd291-5668-4926-be5d-9290aeda3f6e.jpeg", "document_back_template": "cnh_back", "document_front_template": "cnh_front" }, "biometry": { "face_validation": { "score": 80, "provider": "qitech", "available": true }, "fraud_base_flag": false }, "document": { "template": "cnh_front", "face_match_score": 100 }, "liveness": { "result": "live" }, "signed_at": "2025-04-09T19:59:39Z", "ip_address": "182.224.219.198", "signer_data": { "name": "Nome Trabalhador", "email": "exemplo@qitech.com.br", "phone": { "number": "829549234", "area_code": "11", "international_dial_code": "55" }, "address": { "uf": "SP", "city": "Sao Paulo", "number": "123", "street": "Rua tal do sal", "complement": "Ap 23", "postal_code": "00000-000", "neighborhood": "Pinheiros" }, "pix_key": "pix03@pix03.com", "birthdate": "1996-03-13", "document_number": "504.856.400-66", "document_submission_method": "email", "authentication_submission_method": "sms" } } ], "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2025-04-09 20:00:19", "signed_contract_url": "https://storage.googleapis.com/sandbox-doc-api/documents/9b55450e-fca5-44f2-9118-5851ed4bd92e/RESTAURANTEBEBBER-TRABALHADOR_SICQ-CCB-0000195364-2230409195718_signed.pdf" } ``` Em casos de falha na assinatura, o parceiro irá receber um webhook neste modelo. ```json { "key": "e8e28023-fa00-4d12-a410-ede4157957ea", "data": { "cancel_reason": "Validação facial não alcançou a pontuação mínima permitida", "cancel_reason_enumerator": "face_validation_score" }, "status": "canceled", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2025-11-28 17:35:07" } ``` ## 2. Confirmação da proposta Um segundo webhook é enviado informando que a operação está aguardando a chamada de autorização de averbação. WEBHOOK TYPE laas.private_payroll.reservation_status_change **Webhook Body** ```json { "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_status": "pending_requester_authorization", "reservation_type": "new_credit" }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "pending_requester_authorization" } ``` Neste momento o parceiro pode tomar a decisão de seguir com o desembolso da opreração ou cancelar a proposta: ### Autorizar Averbação Para seguir com a averbação, deve ser realizada a chamada: #### Request **PATCH** /private_payroll/reservation/external_key/ EXTERNAL-KEY /authorize Testar no Playground #### Response STATUS **202** (OK) **Response Body** ```json { "reservation_key": "", "document_number": "12345678901", "registration_number": "99999999999-A", "employer_document_number": "12345678901234", "external_key": "abc123def456", "contract_number": "2024001234", "inclusion_date": "2024-03-18", "disbursement_date": "2024-03-20", "contract_data": { "amount": 5000.00, "installments": 12, "interest_rate": 0.018 }, "reservation_data": { "installment_value": 500.00, "margin_value": 450.00 }, "reservation_status": "authorized" } ``` ### Cancelar operação Para não prosseguir com a averbação, é necessário cancelar a operação. Se a operação foi originada via leilão, isto pode ser feito através do endpoint de cancelamento permanente, da mesma forma que é feito no item [6 - Desaverbação](#desaverbacao). Se a operação foi originada no fluxo ativo, o cancelamento deverá ser feito através do endpoint de que consta [neste manual](./manual_averbacao_desembolso.md). :::info Importante O campo `external_key` é o UUID da operação de crédito, o mesmo que `debt_key` e `credit_operation_key`. ::: ## 3 - Averbação ### Sucesso na averbação Em caso de sucesso na averbação o parceiro receberá o seguinte webhook: WEBHOOK TYPE laas.private_payroll.reservation_status_change STATUS reserved **Webhook Body** ```json { "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_status": "reserved", "reservation_type": "new_credit", "warranty" : { "severance_pay_rate":null, "severance_fine":5522.06, "fgts_balance":10000 } }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "reserved" } ``` ### Falha na averbação Caso haja uma falha na averbação, será enviado um webhook com a crítica da DATAPREV. Os possíveis motivos de falha na averbação podem ser consultados na tabela [Motivo de falha na averbação](#fail_reservation_reason). Dependendo do erro de averbação, a QI manterá a proposta em "teimosinha" fazendo novas tentativas de averbação até que a operação seja cancelada manualmente ou por esgotar as opções de desembolso. WEBHOOK TYPE credit_operation.collateral collateral_constituted False **Webhook Body** ```json title="Webhook Body" { "key": "72926c65-35a5-4060-b5ec-af8661d8546a", "data": { "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "monthly_interest_rate_exceeds_active_proposal" } ] }, "last_response_event_datetime": "2025-10-10T19:45:39Z" }, "collateral_type": "private_payroll", "collateral_constituted": false }, "event_time": "2025-10-10 00:07:21", "webhook_type": "credit_operation.collateral" } ``` ## 4 - Desembolso Após o sucesso na averbação, a operação seguirá automaticamente para o desembolso. ### Sucesso no desembolso WEBHOOK TYPE laas.credit_operation.status_change STATUS opened **Webhook Body** ``` { "webhook": { "key": "b0e263d0-3f78-4d40-835d-225321cbc0db", "data": { "installments": [ { "due_date": "2026-04-28", "total_amount": 2723.11, "installment_key": "05d3f492-bb09-4b2f-9d6a-a2d8890fcfe8", "pre_fixed_amount": 2723.11, "installment_number": 1, "principal_amortization_amount": 0.0 }, { "due_date": "2026-05-28", "total_amount": 2723.11, "installment_key": "2c90a77e-2aac-4b18-a092-6435615cc99b", "pre_fixed_amount": 1974.82423911, "installment_number": 2, "principal_amortization_amount": 748.28576089 }, { "due_date": "2026-06-28", "total_amount": 2723.11, "installment_key": "746b1034-c4cf-4388-8a80-9dcea92550c5", "pre_fixed_amount": 1362.47207785, "installment_number": 3, "principal_amortization_amount": 1360.63792215 }, { "due_date": "2026-07-28", "total_amount": 2723.11, "installment_key": "caffce5c-0b8b-419c-bb66-3419ad9d8cf0", "pre_fixed_amount": 1223.14316953, "installment_number": 4, "principal_amortization_amount": 1499.96683047 }, { "due_date": "2026-08-28", "total_amount": 2723.11, "installment_key": "63bf5117-7d44-4a7c-9ac8-a061f769b477", "pre_fixed_amount": 1158.2555271, "installment_number": 5, "principal_amortization_amount": 1564.8544729 }, { "due_date": "2026-09-28", "total_amount": 2723.11, "installment_key": "0c99c88e-b510-432d-ad8b-661a1bb2da1d", "pre_fixed_amount": 1046.54167269, "installment_number": 6, "principal_amortization_amount": 1676.56832731 }, { "due_date": "2026-10-28", "total_amount": 2723.11, "installment_key": "64240d5f-6413-4119-b527-636080a81fb2", "pre_fixed_amount": 895.94579894, "installment_number": 7, "principal_amortization_amount": 1827.16420106 }, { "due_date": "2026-11-28", "total_amount": 2723.11, "installment_key": "0e73e4f3-71f9-429d-8e9c-5ef41702db83", "pre_fixed_amount": 796.41268475, "installment_number": 8, "principal_amortization_amount": 1926.69731525 }, { "due_date": "2026-12-28", "total_amount": 2723.11, "installment_key": "1410ad56-890f-49b3-85e5-b8eb95b54910", "pre_fixed_amount": 636.89650888, "installment_number": 9, "principal_amortization_amount": 2086.21349112 }, { "due_date": "2027-01-28", "total_amount": 2723.11, "installment_key": "08364a82-e805-4446-91ec-df982815a676", "pre_fixed_amount": 509.93381955, "installment_number": 10, "principal_amortization_amount": 2213.17618045 }, { "due_date": "2027-02-28", "total_amount": 2723.11, "installment_key": "fdad3297-a729-4603-8d42-ed30604d93a3", "pre_fixed_amount": 351.93673682, "installment_number": 11, "principal_amortization_amount": 2371.17326318 }, { "due_date": "2027-03-28", "total_amount": 2723.11, "installment_key": "a3d78a2e-01e9-4c04-8cea-3106a52e5b54", "pre_fixed_amount": 164.42776478, "installment_number": 12, "principal_amortization_amount": 2558.68223522 } ], "disbursement_type": "pix", "transaction_receipts": [ { "fee": 0, "url": {url}, "amount": 19316.77, "origin": { "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "type": "payment_account", "branch": "0001", "document": "32402502000135", "bank_code": "329", "account_key": "18bd2ed6-bca7-4cc8-806c-a45a8d9ae804", "branch_digit": null, "account_digit": "7", "account_branch": "0001", "account_number": "8022858", "financial_institution_name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A." }, "timestamp": "2026-02-18T14:23:25", "description": "60701190 5807 20467-1 24182533410 - Mock Person Name", "destination": { "name": "Mock Person Name", "type": "checking_account", "branch": "5807", "purpose": "Crédito PIX em Conta", "document": "12345678909", "bank_ispb": "60701190", "branch_digit": null, "account_digit": "1", "account_number": "20467", "financial_institution_name": "ITAÚ UNIBANCO S.A." }, "end_to_end_id": "E324025022026021814222AHLHi3btjz", "transaction_key": "000531c1-ecb7-47f8-947f-51e467bd58b7", "origin_transaction_key": "4600743f-13e3-47d2-a8c1-2a71c097409a" } ], "requester_identifier_key": "b0e263d0-3f78-4d40-835d-225321cbc0db" }, "status": "opened", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2026-02-18 14:23:24" } } ``` ### Falha no desembolso WEBHOOK TYPE laas.credit_operation.status_change STATUS canceled **Webhook Body** ``` { "key": "", "data": { "cancel_reason": "A conta de destino encontra-se bloqueada.", "cancel_reason_enumerator": "blocked_account" }, "status": "canceled", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2025-10-12 09:54:46" } ``` :::danger FALHA NO DESEMBOLSO Caso haja uma falha no desembolso, é crítico que haja uma atuação na proposta, pois a margem não é desaverbada automaticamente. É necessário que o parceiro tome a decisão de entrar em contato com o tomador para pedir uma atualização dos dados bancários assim sendo possível [reapresentar a o pagamento da dívida](#reapresentacao), ou que o parceiro realize a chamada de [cancelamento permanente](#desaverbacao) da dívida para desaverbar a margem consignável. ::: ## 5 - Reapresentação da pagamento {#reapresentacao} Para retentar o desembolso da dívida, deve ser realizada a chamada a seguir atualizando tanto a data de desembolso quanto os dados bancários (caso a retentativa seja na mesma conta bancária, pode ser enviado somente o parâmetro de data de desembolso). Os possíveis payloads de conta de desembolso constam no página de [exemplos de payload de desembolso](/documentation/emissao_de_divida/emissao/exemplo_payloads_desembolso). Para essa API, foi alterado o nome do payload de disbursement_bank_accounts para disbursement_account. Para reapresentar uma dívida deve-se realizar uma requisição utilizando a auction_proposal_key. ENDPOINT - `/private_payroll_auction/auction_proposal/{auction_proposal_key}/change_disbursement_date` MÉTODO - `PATCH` Testar no Playground ```json { "disbursement_date": "2025-12-12", "disbursement_account": { "document_number": "31233261000185", "name": "Jorge Augusto Salgado Salhani", "pix_key": "2f205c99-3161-4120-badd-854039d12de6", "pix_transfer_type": "key" } } ``` ## 6 - Desavebação {#desaverbacao} Para cancelar permanentemente a operação e desaverbar a margem, deve ser realizada a chamada: #### Request ENDPOINT - `/private_payroll_auction/auction_proposal/{auction_proposal_key}/cancel` MÉTODO - `PATCH` Testar no Playground #### Response STATUS - 202 (Accepted) Response Body: Proposta cancelada ```json { "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea", "status": "cancelled" } ``` :::danger Rotinas Automáticas de Cancelamento permanente Existem duas rotinas automáticas de cancelamento permanente acionadas pela QI Tech: 1. Esgotamento das opções de desembolso. Todas as operações que não forem desembolsadas até a data final de desembolso serão caceladas permanentemente no dia seguinte á data final. Operações originadas via leilão possuem 10 opções de desembolso desde a data do envio da proposta. 2. Operação averbada e não desembolsada depois de 5 dias. Caso uma operação fique averbada e não desembolsada por 5 dias corridos, ocorrerá o cancelamento permantente. Webhooks de cancelamento permanente **Esgotamento das opções de desembolso** ```json { "key": "d7ba5332-3675-12a6-9e07-8afd25ffcfd0", "data": { "cancel_reason": "Operação não desembolsada já passou da última data de desembolso", "cancel_reason_enumerator": "expired_disbursement_date" }, "status": "canceled_permanently", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2026-02-12 00:53:16" } ``` **Operação averbada e não desembolsada depois de 5 dias** ```json { "key": "d7ba5332-3675-12a6-9e07-8afd25ffcfd0", "data": { "cancel_reason": "Operação excedeu o prazo máximo em averbação sem desembolso", "cancel_reason_enumerator": "exceeded_max_days_reserved_not_disbursed" }, "status": "canceled_permanently", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2026-02-12 00:53:16" } ``` ::: Em caso de sucesso na alteração será retornado status 200. STATUS - 200 Caso haja algum erro no formato do payload enviado para a alteração será retornado um erro de schema invalido STATUS - 400 ## 7 - Consulta de averbação Para consultar os dados da averbação e os comprovantes de protocolo de averbação ou desaverbação, pode-se utilizar o endpoint: :::warning Comprovantes de averbação É possível consultar os comprovantes de averbação, desaverbação e suspensão com este método. Os possíveis enumeradores para protocol_type estão disponíveis na tabela [Tipos de protocolo](#protocol_type) ::: #### Request **GET** /private_payroll/reservation/external_key/ [DEBT-KEY] Testar no Playground #### Response STATUS **200** OK **Response Body** ```json { "data": [ { "reservation_key": "310754e1-cef2-4b19-ba04-7b1c0b575276", "document_number": "04142652117", "registration_number": "SECAIXADEA00000000000000006258", "employer_name": null, "admission_date": null, "employer_document_number": "04311093000126", "external_key": "1d900fed-5ed2-4149-8702-f8dab595b590", "contract_number": "179799466", "inclusion_date": "2025-09-30", "disbursement_date": "2025-02-06", "contract_data": { "iof": 227.64, "periods": [ { "amount": 338.22, "due_date": "2025-04-20" }, { "amount": 338.22, "due_date": "2025-05-20" }, { "amount": 338.22, "due_date": "2025-06-20" }, { "amount": 338.22, "due_date": "2025-07-20" }, { "amount": 338.22, "due_date": "2025-08-20" } ], "total_amount": 6680.9, "annual_cet_rate": 0.7176, "contract_number": "179799466", "disbursed_amount": 6090.9, "monthly_cet_rate": 0.0461, "disbursement_date": "2025-02-06", "annual_interest_rate": 0.6163544955, "disbursement_end_date": "2025-02-06", "monthly_interest_rate": 0.0408 }, "reservation_type": "rollover", "reservation_status": "reserved", "protocols": { "reservation": { "receipt_url": "[URL]", "receipt_data": { "contract_number": "XXX0123456789", "protocol_number": "21134056260", "reservation_competence": "2026-03", "installment_value": 468.6, "protocol_type": "reservation", "number_of_installments": 12, "operation_datetime": "30/01/2026 20:21:22" }, "protocol_key": "d32342f-369a-4e12-8634-4dfb494d3038" }, "documents_inclusion": { "receipt_data": { "contract_number": "XXX0123456789", "operation_datetime": "30/01/2026 20:21:29", "number_of_installments": 12, "protocol_number": "21134054053", "installment_value": 468.6, "protocol_type": "documents_inclusion" }, "receipt_url": "[URL]", "protocol_key": "ae018749-7982-4547-92aa-12455e8bafe7" } }, } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 1 } } ``` ## Anexos ### Detalhamento reapresentação de desembolso | Campo | Tipo | Descrição| |-----------------------|---------|----------| | `disbursement_date` | string | Nova data de desembolso no formato YYYY-MM-DD, não obrigatória| | `disbursement_account` | dict | dados da conta de desembolso, não obrigatório| ### Motivo de falha na averbação {#fail_reservation_reason} | Enumerador | Descrição | Ação QI |------------------------------------------ |------------------------------------------------------- |---------- | **monthly_interest_rate_exceeds_active_proposal** | Há uma proposta ativa no app da CTPS do tomador enviada pela QI com taxa inferior à da tentativa de averbação | Teimosinha | **margin_exceeded** | Margem consignável excedida | Teimosinha | **allowed_number_of_contracts_exceeded** | Quantidade máxima de contratos excedida | Cancelamento da operação | **employment_relationship_blocked** | Vínculo bloqueado pelo tomador (é possível desbloquear pelo app da CTPS) | Cancelamento da operação | **warranty_exceeded** | Coberturas disponíveis excedidas | Teimosinha | **invalid_cover_amount** | Valor da cobertura não corresponde ao percentual do valor de emissão esperado | Teimosinha ### Tipos de protocolo {#protocol_type} | Enumerador | Descrição |------------------------------------------ |------------------------------------------------------- | **reservation** | Averbação | **documents_inclusion** | Envio de documentos (processo de enviar os documentos de formalização para DATAPREV) | **suspension** | Suspensão | **deletion** | Exclusão --- # Manual Consignado Privado - Averbação e Desembolso URL: /documentation/manual_consignado_privado/manual_averbacao_desembolso :::info Navegação - [Formalização Externa](/documentation/manual_consignado_privado/manual_assinatura_externa) (anterior) ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1. Confirmação da proposta No fluxo ativo, é possível configurar o ambiente para que a operação siga para as etapas de averbação e desembolso logo após a finalização da formalização da dívida pelo tomador, caso contrário, será enviado um webhook informando que a operação está aguardando uma chamada de autorização para dar continuidade ao fluxo (esta configuração deve ser alinhada com o time de operações). ### Averbação pendente de autorização WEBHOOK TYPE laas.private_payroll.reservation_status_change **Webhook Body** ```json { "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_status": "pending_requester_authorization", "reservation_type": "new_credit" }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "pending_requester_authorization" } ``` Neste momento o parceiro pode tomar a decisão de seguir com o desembolso da opreração ou cancelar a proposta: ### Autorizar Averbação Para seguir com a averbação, deve ser realizada a chamada: #### Request **PATCH** /private_payroll/reservation/external_key/ EXTERNAL-KEY /authorize Testar no Playground #### Response STATUS **200** (OK) **Response Body** ```json { "reservation_key": "", "document_number": "12345678901", "registration_number": "99999999999-A", "employer_document_number": "12345678901234", "external_key": "abc123def456", "contract_number": "2024001234", "inclusion_date": "2024-03-18", "disbursement_date": "2024-03-20", "contract_data": { "amount": 5000.00, "installments": 12, "interest_rate": 0.018 }, "reservation_data": { "installment_value": 500.00, "margin_value": 450.00 }, "reservation_status": "authorized" } ``` ### Cancelar operação Para não prosseguir com a averbação, é necessário cancelar a operação. Se a operação foi originada no fluxo ativo, isto pode ser feito através do endpoint de cancelamento permanente, da mesma forma que é feito no item [5 - Desaverbação](#desaverbação). Se a operação foi originada via leilão, o cancelamento deverá ser feito através do endpoint de cancelamento da proposta, conforme documentação do Leilão. :::info Importante O campo `external_key` é o UUID da operação de crédito, o mesmo que `debt_key` e `credit_operation_key`. ::: ## 2 - Averbação ### Sucesso na averbação Em caso de sucesso na averbação o parceiro receberá o seguinte webhook: WEBHOOK TYPE laas.private_payroll.reservation_status_change STATUS reserved **Webhook Body** ```json { "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_status": "reserved", "reservation_type": "new_credit", "warranty" : { "severance_pay_rate":null, "severance_fine":5522.06, "fgts_balance":10000 }, }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "reserved" } ``` ### Falha na averbação Caso haja uma falha na averbação, será enviado um webhook com a crítica da DATAPREV. Os possíveis motivos de falha na averbação podem ser consultados na tabela [Motivo de falha na averbação](#fail_reservation_reason). Dependendo do erro de averbação, a QI manterá a proposta em "teimosinha" fazendo novas tentativas de averbação até que a operação seja cancelada manualmente ou por esgotar as opções de desembolso. WEBHOOK TYPE credit_operation.collateral collateral_constituted False **Webhook Body** ```json title="Webhook Body" { "key": "72926c65-35a5-4060-b5ec-af8661d8546a", "data": { "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "monthly_interest_rate_exceeds_active_proposal" } ] }, "last_response_event_datetime": "2025-10-10T19:45:39Z" }, "collateral_type": "private_payroll", "collateral_constituted": false }, "event_time": "2025-10-10 00:07:21", "webhook_type": "credit_operation.collateral" } ``` ## 3 - Desembolso Após o sucesso na averbação, a operação seguirá automaticamente para o desembolso. ### Sucesso no desembolso WEBHOOK TYPE debt STATUS disbursed **Webhook Body** ``` { "key": "8351238-1272-46b2-292b-7161a05c5161", "data": { "installments": [ { "due_date": "2026-04-28", "total_amount": 180.75, "installment_key": "6286548-015a-4f26-8fb5-0d23f34554e", "pre_fixed_amount": 180.75, "installment_number": 1, "principal_amortization_amount": 0.0 }, { "due_date": "2026-05-28", "total_amount": 180.75, "installment_key": "b3e719e6-24fc-4ddf-a8b8-ee9012342ba6", "pre_fixed_amount": 180.75, "installment_number": 2, "principal_amortization_amount": 0.0 }, { "due_date": "2026-06-28", "total_amount": 180.75, "installment_key": "3652fb45-4304-4f8e-84ff-1234307042cc", "pre_fixed_amount": 180.75, "installment_number": 3, "principal_amortization_amount": 0.0 }, { "due_date": "2026-07-28", "total_amount": 180.75, "installment_key": "7e2d4334-b963-4a77-1234-4e4fcb1986f8", "pre_fixed_amount": 180.75, "installment_number": 4, "principal_amortization_amount": 0.0 }, { "due_date": "2026-08-28", "total_amount": 180.75, "installment_key": "a1ab6f5b-321b-41a0-a608-0eb54a261014", "pre_fixed_amount": 180.75, "installment_number": 5, "principal_amortization_amount": 0.0 }, { "due_date": "2026-09-28", "total_amount": 180.75, "installment_key": "7d423192-10d4-45c6-8353-7c3be28ee368", "pre_fixed_amount": 180.75, "installment_number": 6, "principal_amortization_amount": 0.0 } ], "ted_receipt_list": [ { "fee": 0, "url": "[URL]", "amount": 2444.15, "origin": { "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "type": "payment_account", "branch": "0001", "document": "32402502000135", "bank_code": "329", "account_key": "65463575-3456-4345-9787-146868523667", "branch_digit": null, "account_digit": "1", "account_branch": "0001", "account_number": "0000025", "financial_institution_name": "QI SCD S.A." }, "timestamp": "2026-01-29T20:03:44", "description": "12431420 0134 71234489-3 99999999999 - Lucas Blau Mattos", "destination": { "name": "Lucas Blau Mattos", "type": "checking_account", "branch": "0001", "purpose": "Crédito PIX em Conta", "document": "99999999999", "bank_ispb": "18236120", "branch_digit": null, "account_digit": "3", "account_number": "71234489", "financial_institution_name": "NU PAGAMENTOS - IP" }, "end_to_end_id": "E32402502202601291954msTASDFEGS", "transaction_key": "e89dc7af-165d-4534-b345-11345625d2c6", "origin_transaction_key": "3415085f-1254-2153-a254-b1254215279e" } ], "requester_identifier_key": "1235cd2f-6345-4025-a334-a1435269fe11" }, "status": "disbursed", "webhook_type": "debt", "event_datetime": "2026-01-29 20:03:45" } ``` ### Falha no desembolso #### TED Em caso de falha no desembolso via TED WEBHOOK TYPE debt STATUS canceled **Webhook Body** ```json { "key": "", "status": "canceled", "webhook_type": "debt", "event_datetime": "2025-03-18 16:41:28", "data": { "ted_refusal": { "transaction_key": "16faabfc-3876-437d-a4f6-aae17a1d68c9", "description": "341 0000 000000-7 12345678900 - NOME DO EMPREGADO", "origin": { "account_key": "a1d2dea5-fa90-4676-a125-da355fdc3ed0", "account_number": "00086", "bank_code": "329", "name": "ACCOUNT TRANSITORY", "type": "payment_account", "document": "32402502000135", "branch_digit": null, "account_digit": "8", "branch": "0001" }, "fee": 0, "reason_enumerator": "agencia_conta_invalida", "timestamp": "2022-11-07T14:36:05", "amount": 483.6, "reason": "Agência ou Conta Destinatária do Crédito Inválida", "destination": { "branch": "0000", "account_number": "000000", "name": "NOME DO EMPREGADO", "purpose": "Crédito em Conta", "type": "checking_account", "branch_digit": null, "document": "12345678900", "bank_code": "341", "account_digit": "7" } }, "cancel_reason": "ted_refusal" } } ``` #### PIX Em caso de falha no desembolso via PIX WEBHOOK TYPE debt STATUS canceled **Webhook Body** ```json { "key": "", "status": "canceled", "webhook_type": "debt", "event_datetime": "2025-03-18 16:41:28", "data": { "cancel_reason": "pix_refusal", "pix_refusal": { "reason_enumerator": "invalid_document_number", "reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino." } } } ``` :::danger FALHA NO DESEMBOLSO Caso haja uma falha no desembolso, é crítico que haja uma atuação na proposta, pois a margem não é desaverbada automaticamente. É necessário que o parceiro tome a decisão de entrar em contato com o tomador para pedir uma atualização dos dados bancários assim sendo possível [reapresentar a o pagamento da dívida](#reapresentacao), ou que o parceiro realize a chamada de [cancelamento permanente](#desaverbacao) da dívida para desaverbar a margem consignável. ::: ## 4 - Reapresentação de pagamento{#reapresentacao} Para retentar o desembolso da dívida, deve ser realizada a chamada a seguir atualizando tanto a data de desembolso quanto os dados bancários (caso a retentativa seja na mesma conta bancária, pode ser enviado somente o parâmetro de data de desembolso). Os possíveis payloads de conta de desembolso constam no página de [exemplos de payload de desembolso](/documentation/emissao_de_divida/emissao/exemplo_payloads_desembolso). #### Request **POST** /debt/ DEBT-KEY /change_disbursement_date Testar no Playground ### Request **Request Body** ```json { "disbursement_date": "2025-03-19", "disbursement_bank_accounts": [ { "branch_number": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "document_number": "", "bank_code": 184, "ispb_number": "17298092", "name": "", "percentage_receivable": 100 } ] } ``` ### Response STATUS **200** OK **Response Body** ```json { "disbursement_date": "2025-03-19", "disbursement_accounts": [ { "account_branch": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "amount_receivable": null, "created_at": "2022-05-24T14:51:46", "digitable_line": null, "disbursement_type": "ted", "document_number": "37197645832", "financial_institutions": { "code_number": 184, "ispb": 17298092, "name": "BCO ITAÚ BBA S.A." }, "financial_institutions_code_number": 184, "is_pix_disbursement": false, "ispb": "17298092", "name": "Márcio e Catarina Gráfica Ltda", "percentage_receivable": 50.0, "pix_key": null, "pix_transfer_key": null, "pix_type": null, "qr_code_key": null, "retry_counter": 0, "retry_vector": null, "transaction_key": null, "webhook_key": null } ] } ``` ## 5 - Desaverbação {#desaverbacao} A desaverbação de um contrato é realizada através da rota de cancelamento permanente. Essa rota coloca um status final no contrato, o qual não é passível de retentativa e dispara a desaverbação da margem averbada. Para realizar o cancelamento definitivo, deve ser utilizado o seguinte endpoint: ### Request **POST** /debt/ DEBT-KEY /cancel_permanently Testar no Playground ### Webhooks WEBHOOK TYPE debt STATUS canceled_permanently **Webhook Body** ```json { "key": "", "status": "canceled_permanently", "webhook_type": "debt", "event_datetime": "2025-03-18 16:41:28", "data": {} } ``` :::danger Rotinas Automáticas de Cancelamento permanente Existem duas rotinas automáticas de cancelamento permanente acionadas pela QI Tech: 1. Esgotamento das opções de desembolso. Todas as operações que não forem desembolsadas até a data final de desembolso serão caceladas permanentemente no dia seguinte á data final. 2. Operação averbada e não desembolsada depois de 5 dias. Caso uma operação fique averbada e não desembolsada por 5 dias corridos, ocorrerá o cancelamento permantente. Webhooks de cancelamento permanente **Esgotamento das opções de desembolso** ```json { "key": "d7ba5332-3675-12a6-9e07-8afd25ffcfd0", "data": { "cancel_reason": "Operação não desembolsada já passou da última data de desembolso", "cancel_reason_enumerator": "expired_disbursement_date" }, "status": "canceled_permanently", "webhook_type": "debt", "event_datetime": "2026-02-12 00:53:16" } ``` **Operação averbada e não desembolsada depois de 5 dias** ```json { "key": "d7ba5332-3675-12a6-9e07-8afd25ffcfd0", "data": { "cancel_reason": "Operação excedeu o prazo máximo em averbação sem desembolso", "cancel_reason_enumerator": "exceeded_max_days_reserved_not_disbursed" }, "status": "canceled_permanently", "webhook_type": "debt", "event_datetime": "2026-02-12 00:53:16" } ``` ::: ## 6 - Consulta de averbação Para consultar os dados da averbação e os comprovantes de protocolo de averbação ou desaverbação, pode-se utilizar o endpoint: :::warning Comprovantes de averbação É possível consultar os comprovantes de averbação, desaverbação e suspensão com este método. Os possíveis enumeradores para protocol_type estão disponíveis na tabela [Tipos de protocolo](#protocol_type) ::: **GET** /private_payroll/reservation/external_key/ [DEBT-KEY] Testar no Playground ### Response STATUS **200** OK **Response Body** ```json { "data": [ { "reservation_key": "310754e1-cef2-4b19-ba04-7b1c0b575276", "document_number": "04142652117", "registration_number": "SECAIXADEA00000000000000006258", "employer_name": null, "admission_date": null, "employer_document_number": "04311093000126", "external_key": "1d900fed-5ed2-4149-8702-f8dab595b590", "contract_number": "179799466", "inclusion_date": "2025-09-30", "disbursement_date": "2025-02-06", "contract_data": { "iof": 227.64, "periods": [ { "amount": 338.22, "due_date": "2025-04-20" }, { "amount": 338.22, "due_date": "2025-05-20" }, { "amount": 338.22, "due_date": "2025-06-20" }, { "amount": 338.22, "due_date": "2025-07-20" }, { "amount": 338.22, "due_date": "2025-08-20" } ], "total_amount": 6680.9, "annual_cet_rate": 0.7176, "contract_number": "179799466", "disbursed_amount": 6090.9, "monthly_cet_rate": 0.0461, "disbursement_date": "2025-02-06", "annual_interest_rate": 0.6163544955, "disbursement_end_date": "2025-02-06", "monthly_interest_rate": 0.0408 }, "reservation_type": "rollover", "reservation_status": "reserved", "protocols": { "reservation": { "receipt_url": "[URL]", "receipt_data": { "contract_number": "XXX0123456789", "protocol_number": "21134056260", "reservation_competence": "2026-03", "installment_value": 468.6, "protocol_type": "reservation", "number_of_installments": 12, "operation_datetime": "30/01/2026 20:21:22" }, "protocol_key": "d32342f-369a-4e12-8634-4dfb494d3038" }, "documents_inclusion": { "receipt_data": { "contract_number": "XXX0123456789", "operation_datetime": "30/01/2026 20:21:29", "number_of_installments": 12, "protocol_number": "21134054053", "installment_value": 468.6, "protocol_type": "documents_inclusion" }, "receipt_url": "[URL]", "protocol_key": "ae018749-7982-4547-92aa-12455e8bafe7" } }, } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 1 } } ``` ## Anexos --- ### Motivo de falha na averbação {#fail_reservation_reason} | Enumerador | Descrição | Ação QI |------------------------------------------ |------------------------------------------------------- |---------- | **monthly_interest_rate_exceeds_active_proposal** | Há uma proposta ativa no app da CTPS do tomador enviada pela QI com taxa inferior à da tentativa de averbação | Teimosinha | **margin_exceeded** | Margem consignável excedida | Teimosinha | **allowed_number_of_contracts_exceeded** | Quantidade máxima de contratos excedida | Cancelamento da operação | **employment_relationship_blocked** | Vínculo bloqueado pelo tomador (é possível desbloquear pelo app da CTPS) | Cancelamento da operação ### Tipos de protocolo {#protocol_type} | Enumerador | Descrição |------------------------------------------ |------------------------------------------------------- | **reservation** | Averbação | **documents_inclusion** | Envio de documentos (processo de enviar os documentos de formalização para DATAPREV) | **suspension** | Suspensão | **deletion** | Exclusão --- # Manual Consignado Privado - Configuração dos Filtros de Recebimento de Propostas de Leilão URL: /documentation/manual_consignado_privado/manual_configuracao_filtros ## Introdução O Fluxo de emissão das operações via leilão se inicia no momento em que um tomador solicita um empréstimo no app da CTPS digital, a QI Tech consulta todas as solicitações realizadas periodicamente e, para cada pedido, abre um leilão interno de propostas de empréstimo notificando os parceiros via webhook. Neste manual estão os endpoints necessários para configurar os filtros de solicitação que possibilitam controlar o público alvo da operação. ## Modificando regras de filtragem ENDPOINT - `/private_payroll_auction/requester_configuration/custom_data` MÉTODO - `PATCH` Testar no Playground Nessa requisição existem dois tipos de campos passiveis de serem alterados; O status do cliente e os filtros do cliente. Em relação ao status do cliente, pode ser alterado entre [ativo e inativo](#status_do_cliente), sinalizando se o cliente deseja ou não receber novas solicitações de leilão. ```json { "status": "active" } ``` O campo [custom_data](#custom_data_params) contêm os filtros de fato. Nele devem ser enviados todos os campos de filtragem como no exemplo abaixo: ```json ``` :::warning cada campo deve ter obrigatoriamente as chaves min e max, com exceção do received_daily_proposals, days_since_employmente e alert_preferences. *OBS: Todos os campos de custom data devem ser enivados, mesmo que não seja necessário mudar todos os valores. Além disso, o envio de todas as chaves min/max é obrigatório, sendo passado 'null' caso não seja necessário utilizar esse filtro*. ::: ### Exemplo de [Body](#custom_data_payload) ```json { "custom_data": { "disbursed_issue_amount": {"min": null, "max": null}, "number_of_installments": {"min": 12, "max": 24}, "consigned_credit_balance": {"min": null, "max": null}, "days_since_employment": {"min": null}, "age": {"min": null, "max": 60}, "received_daily_proposals": {"max": null}, "alert_preferences": { "default": "acknowledge", "leave": "acknowledge", "termination": "ignore" }, "allowed_employer_document_types": [ "cpf", "cnpj" ], "allowed_political_exposures": [ "not_exposed", "level_1", "level_2" ] } } ``` ### Response STATUS - 201 (Accepted) Response Body: Configuração Atualizada ```json { "status": "active", "custom_data": { "disbursed_issue_amount": {"min": 1000, "max": null}, "number_of_installments": {"min": 12, "max": 24}, "consigned_credit_balance": {"min": 200, "max": null}, "days_since_employment": {"min": null}, "age": {"min": null, "max": 60}, "received_daily_proposals": {"max": 1000}, } } ``` ## Adicionando CNPJs de filtragem Para clientes que desejam receber solicitações apenas de funcionários de CNPJs específicos, existe a opção de adicionar esses CNPJs em lote: ENDPOINT - `/private_payroll_auction/requester_configuration/related_employer` MÉTODO - `POST` Testar no Playground :::caution Atenção! A DATAPREV somente opera com a raíz dos CNPJs, portanto para a filtragem a partir do documento do empregador devem ser enviados **apenas os 8 primeiros dígitos do CNPJ**. ::: ### [Body](#employer_payload) ```json { "employer_document_numbers": [ "01234567", "12345678" ] } ``` **A [lista](#employer_payload) pode conter no máximo 100 CNPJs.** ### Response STATUS - 201 Response Body: CNPJs adicionados ```json { "employer_document_numbers": [ "01234567", "12345678" ] } ``` :::info Observação Apenas os CNPJs efetivamente adicionados serão retornados. No caso em que um CNPJ já tenha sido cadastrado, não será retornado na lista da resposta. Caso nenhum CNPJ seja adicionado será retornada uma lista vazia. ::: ## Removendo CNPJs de filtragem ENDPOINT - `/private_payroll_auction/requester_configuration/remove_related_employers` MÉTODO - `POST` Testar no Playground ### [Body](#employer_payload) ```json { "employer_document_numbers": [ "01234567", "12345678" ] } ``` **Os CNPJs devem ser enviado apenas com os 8 primeiros dígitos e a lista pode conter no máximo 100 CNPJs.** ### Response STATUS - 200 Response Body: CNPJ removidos ```json { "employer_document_numbers": ["01234567", "12345678"] } ``` ## Buscando CNPJs de filtragem Para consultar os CNPJs cadastrados como filtros para um solicitante, utilize o endpoint abaixo com suporte a paginação. ### Endpoint ENDPOINT - `/private_payroll_auction/requester_configuration/related_employers` MÉTODO - `GET` Testar no Playground ### Query Params | Campo | Tipo | Descrição | Padrão | |---------------|------|------------------------------------|--------| | `page_number` | int | Número da página atual | 1 | | `page_rows` | int | Quantidade de registros por página | 100 | ### Exemplo de Resposta - 200 ```json { "data": [ { "employer_document_number": "01234567" }, { "employer_document_number": "12345678" } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 2, "total_pages": 3, "total_rows": 6 } } ``` ## Anexos ### Detalhamento do Payload de Alteração de Regras de Filtragem {#custom_data_payload} | Campo | Tipo | Descrição | Obrigatório | |---------------|-------- |---------------------------------------|------------ | | `status` | string | novo status do cliente | Não | | `custom_data` | dict | Novos filtros para o cliente | Não | ### Status do Cliente {#status_do_cliente} | Status | Descrição | |---------- | ------------------------------------------------------------------------- | | active | Cliente deseja receber novas solicitação de proposta no leilão | | inactive | Cliente **Nâo** deseja receber novas solicitações de proposta | ### Parâmetros do Custom Data {#custom_data_params} | Campo | Tipo | Descrição | Obrigatório | |---------------------------- |-------|----------------------------------------------------------------------- |--------------| | `disbursed_issue_amount` | dict | Valor do contrato emitido (mínimo e máximo) | Sim | | `number_of_installments` | dict | Número de parcelas (mínimo e máximo) | Sim | | `consigned_credit_balance` | dict | Saldo de crédito consignado (mínimo e máximo) | Sim | | `days_since_employment` | dict | Dias desde o início do vínculo empregatício (mínimo) | Sim | | `age` | dict | Idade do proponente (mínimo e máximo) | Sim | | `received_daily_proposals` | dict | Número de propostas recebidas por dia (máximo) | Sim | | `alert_preferences` | dict | Filtro de pedidos de empréstimo com algum alerta, para detalhamento consulte [Parâmetros alert_preferences](#alert_preferences)| Sim | ### Parâmetros alert_preferences {#alert_preferences} | Campo | Tipo | Descrição | Obrigatório | Enumeradores | |---------------------------- |------- |----------------------------------------------------------------------- |--------------|------------- | | `default` | string | Comportamento padrão, caso os comportamentos específicos não estejam configurados | Sim | ignore para não receber, acknowledge para receber| | `termination` | string | Filtro de leads com alerta de desligamento | Não | ignore para não receber, acknowledge para receber| | `leave` | string | Filtro de leads com alerta de afastamento | Não | ignore para não receber, acknowledge para receber| ### Detalhamento do Payload de Adição e Remoção de CNPJs de Filtragem {#employer_payload} | Campo | Tipo | Descrição | Obrigatório | |---------------|--------|----------------------------------------|------------ | | `employer_document_number` | array de strings | Lista de raízes de CNPJ (com 8 dígitos cada). Deve conter entre 1 e 100 itens | Sim | --- # Manual Consignado Privado - Consulta de Escriturações URL: /documentation/manual_consignado_privado/manual_consultas_conciliacao A escrituração é o processo obrigatório que o setor de Recursos Humanos (RH) ou Departamento Pessoal (DP) da empresa realiza para registrar no sistema governamental (via eSocial) o desconto da parcela de um empréstimo consignado ativo do colaborador em sua folha de pagamento, em essência, a escrituração é a formalização contábil e fiscal do desconto. Após o pagamento do valor formalizado, o valor é direcionado para a Caixa Econômica Federal, que encaminha para a instituição financeira credora. A escrituração do desconto referente à folha de pagamento da competência deve ser realizada até o dia 15 de cada mês. ## 1 - Consulta de escriturações **GET** /private_payroll_conciliation/registers Testar no Playground ### Query Parameters | Parâmetro | Tipo | Obrigatório | Descrição | Valor Padrão | |-----------------|---------|-------------|-------------------------------------------|--------------| | start_date | date | Sim | Data mínima da escrituração (YYYY-mm-dd) | | | end_date | date | Sim | Data máxima da escrituração (YYYY-mm-dd) | | | page_number | integer | Não | Número da página a ser retornada | 1 | | page_rows | integer | Não | Quantidade de registros por página | 100 | :::info A paginação é baseada em um, portanto a primeira página é a página 1. ::: ### Response STATUS **200** OK ```json { "data": [ { "register_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "1234567890", "credit_operation_key": "123e4567-e89b-12d3-a456-426614174000", "amount": 2405.76, "reference_month": "2024-07", "external_reference_month": "2024-06", "document_number": "29883927061", "employer_document_number": "12345678", "registration_number": "11841", "registered_at": "2025-08-06T03:49:52Z", "register_type":"regular_pay" } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 100, } } ``` :::warning Atributos da escrituração Os atributos 'contract_number', 'employer_document_number' e 'registration_number' não coincidem necessariamente com os dados da operação de crédito, pois são referentes aos dados digitados pelo RH do empregador, para associar a escrituração com a operação de crédito deve ser utilizada a chave "credit_operation_key". ::: ### Response Body A resposta paginada é composta por um array de escriturações (*data*) e um objeto de paginação (*pagination*). #### Lista de atributos Descrição dos itens do array *data*: | Parâmetro | Tipo | Descrição | |----------------------------|---------|----------------------------------------| | register_key | string | Identificacor da escrituração | | contract_number | string | Número do contrato escriturado pelo empregador | | amount | decimal | Valor total da escrituração | | reference_month | string | Mês de vencimento no qual a escrituração se refere | | external_reference_month | string | Mês de competência informada pela DATAPREV | | registered_at | string | Data de escrituração | | document_number | string | CPF do cliente | | employer_document_number | string | CNPJ ou CPF do empregador | | registration_number | string | Matrícula do funcionário | | credit_operation_key | string | Identificador da Operação de crédito | | register_type | string | Tipo de escrituração, consulte os possíveis enumeradores na tabela [Tipos de escrituração](#register_type)| | credit_operation_key | string | Identificador da Operação de crédito | #### Dados de paginação Dados contidos no objeto *pagination*: | Parâmetro | Tipo | Obrigatório | Descrição | |---------------|---------|-------------|------------------------------------| | current_page | integer | Sim | Página atual | | next_page | integer | Sim | Próxima página | | rows_per_page | integer | Sim | Quantidade de registros por página | ### Tipos de escrituração {#register_type} ENUMERADOR register_type | Enumerador | Descrição | |------------------------- |-----------------------------------| |regular_pay |Desconto ordinário | |severance_pay |Desconto de verba rescisória | --- # Manual Consignado Privado - Consultas do Trabalhador URL: /documentation/manual_consignado_privado/manual_consultas_trabalhador :::info Navegação - [Fluxo de Emissão](/documentation/manual_consignado_privado/manual_detalhamento_fluxo_ativo) (anterior) - [Emissão e Formalização](/documentation/manual_consignado_privado/manual_credito_novo) (próximo) ::: No início do fluxo ativo de emissão de uma dívida de consignado privado, é necessário realizar duas consultas principais relacionadas ao trabalhador: 1. Consulta de vínculos empregatícios: realizada informando apenas o CPF do trabalhador. Essa operação retorna a lista de vínculos ativos do trabalhador, juntamente com a elegibilidade de cada um para operações de crédito. 2. Consulta de dados do trabalhador: realizada com base em um vínculo específico, informando o número de documento do empregador e o número de matrícula obtidos na consulta de vínculos. Essa operação retorna informações adicionais detalhadas sobre o vínculo selecionado, incluindo dados pessoais, margem consignável, histórico do vínculo e eventuais alertas. :::caution Atenção Para realizar qualquer uma dessas consultas, é obrigatório enviar um [Termo de autorização](#authorization_term). Esse termo deve ser criado a partir da coleta de evidências de que o tomador forneceu um aceite expresso (opt-in) autorizando a execução das consultas. As evidências — como timestamp, endereço IP e identificador de sessão — devem ser incluídas na requisição para garantir a rastreabilidade e conformidade regulatória do processo. ::: Essas consultas, juntamente com o [Termo de autorização](#authorization_term), são etapas fundamentais para validar a elegibilidade do trabalhador e obter os dados necessários antes da formalização da operação de crédito. :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1 - Consulta dos vínculos empregatícios do trabalhador: A consulta de vínculos empregatícios é uma operação assíncrona. Ao enviar a requisição, a QI Tech processará a consulta em background e retornará o resultado através de um webhook quando finalizada. O webhook será enviado para a URL configurada no seu ambiente. **POST** /private_payroll/employment_relationships_inquiry Testar no Playground ### Request **Caso 1:** O trabalhador é o assinante do [Termo de autorização](#authorization_term). **Request Body** ```json { "document_number": "12345678909", "authorization_term": { "signature": { "signer": { "name": "Nome do tomador", "email": "email_do_tomador@email.com", "phone": { "number": "999999999", "area_code": "11", "country_code": "55" }, "document_number": "12345678909" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2025-03-24T12:19:08Z", "ip_address": "255.255.255.255", "fingerprint": {}, "session_id": "0b73fdb9-1b3b-4f09-9cf2-b775a1ce58d2" } } } } ``` **Caso 2:** O representante legal é o assinante do [Termo de autorização](#authorization_term). **Request Body** ```json { "document_number": "12345678909", "authorization_term": { "legal_representative_document_number": "32165498709", "signature": { "signer": { "name": "Nome do tomador", "email": "email_do_tomador@email.com", "phone": { "number": "999999999", "area_code": "11", "country_code": "55" }, "document_number": "12345678909" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "2025-03-24T12:19:08Z", "ip_address": "255.255.255.255", "fingerprint": {}, "session_id": "0b73fdb9-1b3b-4f09-9cf2-b775a1ce58d2" } } } } ``` :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: ### Response STATUS **202** Accepted **Response Body** ```json { "employment_relationships_inquiry_key": "", "employment_relationships_inquiry_status": "pending_inquiry" } ``` :::info Os possíveis valores para o enumerador **employment_relationships_inquiry_status** estão listados na seção [Status das consultas de vínculos empregatícios](#status-das-consultas). ::: ### Webhooks WEBHOOK TYPE laas.private_payroll.employment_relationships_inquiry_status_change Retorno da consulta dos vínculos empregatícios: STATUS completed **Webhook Body** ```json { "key": "", "status": "completed", "webhook_type": "laas.private_payroll.employment_relationships_inquiry_status_change", "event_datetime": "2025-03-24T15:28:31Z", "data": { "authorization_term": { "status": "authorized", "authorization_term_key": "", "signed_at": "2025-03-24T12:19:08Z", "expiration_date": "2025-04-24" }, "employment_relationships": [ { "eligible": true, "document_number": "47812365409", "registration_number": "99999999999-A", "employer_document_type": "cpf", "employer_document_number": "34848037034" }, { "eligible": false, "document_number": "47812365409", "registration_number": "11111111111-B", "employer_document_type": "cnpj", "employer_document_number": "33296860000173" } ] } } ``` STATUS failed **Webhook Body** ```json { "key": "", "status": "failed", "webhook_type": "laas.private_payroll.employment_relationships_inquiry_status_change", "event_datetime": "2025-03-24T15:28:31Z", "data": { "enumerator": "ineligible_worker_cpf", "description": "CPF not found in database or worker CPF ineligible", "translation": "CPF não encontrado na base ou CPF do trabalhador inelegível" } } ``` :::warning Aviso Para simular uma falha em ambiente de sandbox, realize uma consulta com um CPF iniciado com o dígito 2. ::: --- ## 2 - Consulta de dados do trabalhador: {#consulta-de-dados} A consulta de dados do trabalhador é uma operação assíncrona. Ao enviar a requisição, a QI Tech irá processar a consulta em background e retornará o resultado através de um webhook quando finalizada. O webhook será enviado para a URL configurada no seu ambiente. Existem dois cenários possíveis para realizar a consulta: 1. Utilizando um [Termo de autorização](#authorization_term) previamente enviado na consulta de vínculos empregatícios 2. Enviando um novo [Termo de autorização](#authorization_term) junto com a consulta Em ambos os casos, é necessário informar o número de matrícula do trabalhador obtido na consulta de vínculos empregatícios. **POST** /private_payroll/balance_inquiry Testar no Playground ### Request **Caso 1:** Consulta de dados do trabalhador com o [Termo de autorização](#authorization_term) previamente enviado. **Request Body** ```json { "document_number": "", "registration_number": "", "employer_document_number": "" } ``` **Caso 2:** Consulta de dados do trabalhador com envio do [Termo de autorização](#authorization_term). **Request Body** ```json { "document_number": "", "registration_number": "", "employer_document_number": "", "authorization_term": { "legal_representative_document_number": "", // Caso aplicável "signature": { "signer": { "name": "", "email": "", "phone": { "number": "", "area_code": "", "country_code": "55" }, "document_number": "" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "", "ip_address": "", "fingerprint": {}, "session_id": "" } } } } ``` :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: ### Response STATUS **202** (Accepted) **Response Body** ```json { "balance_inquiry_key": "", "balance_inquiry_status": "pending_inquiry" } ``` :::info Os possíveis valores para o enumerador **balance_inquiry_status** estão listados na seção [Status das consultas de dados do trabalhador](#status-das-consultas). ::: ### Webhooks WEBHOOK TYPE laas.private_payroll.balance_inquiry_status_change Retorno da consulta de dados do trabalhador: STATUS completed **Webhook Body** ```json { "key": "", "status": "completed", "webhook_type": "laas.private_payroll.balance_inquiry_status_change", "event_datetime": "2024-02-21T14:30:25Z", "data": { "document_number": "99999999999", "registration_number": "99999999999-A", "employer_document_number": "99999999999962", "name": "JOÃO SILVA", "gender": "male", "birth_date": "1985-07-20", "worker_category_code": 101, "eligible": true, "available_margin_amount": 5000.00, "base_margin_amount": 4500.00, "total_due_amount": 8207.54, "admission_date": "2020-03-15", "termination_date": null, "termination_reason_code": null, "political_exposition": "not_exposed", "suspended_loans_count": 2, "block_type": "no_block", "blocked_at": null, "employer_name": "EMPRESA XYZ LTDA", "mother_name": "MARIA DA SILVA", "nationality": { "code": 76, "description": "BRASIL" }, "occupation": { "code": 724325, "description": "SOLDADOR ELETRICO" }, "economic_activity": { "code": 2833000, "description": "FABRICACAO DE MAQUINAS E EQUIPAMENTOS PARA A AGRICULTURA E PECUARIA, PECAS E ACESSORIOS, EXCETO PARA IRRIGACAO" }, "ineligibility_reason": "not_informed", "employer_activity_start_date": "2010-05-12", "legacy_loans": [], "alerts": [ { "alert_type": "leave", "reference_date": "2025-02-11", "event_id": 123456, "leave_reason_code": 3, "leave_start_date": "2025-02-11", "leave_end_date": "2025-03-11" }, { "alert_type": "termination", "reference_date": "2025-02-11", "event_id": 789012, "termination_reason_code": 1, "termination_date": "2025-02-11", "notice_period_start_date": "2025-01-11", "notice_period_end_date": "2025-02-11" } ], "warranty":{ "severance_pay_rate":0.15 } } } ``` STATUS failed **Webhook Body** ```json { "key": "", "status": "failed", "webhook_type": "laas.private_payroll.balance_inquiry_status_change", "event_datetime": "2024-02-21T14:30:25Z", "data": { "authorization_term": { "status": "authorized", "signed_at": "2025-08-10T17:42:05Z", "expiration_date": "2025-09-09", "authorization_term_key": "4444cc5b-9c60-473f-8fe4-6c43b855be6d" } } } ``` :::warning Aviso Para simular uma falha em ambiente de sandbox, realize uma consulta com um CPF iniciado com o dígito 2. ::: ## 3 - Consulta de garantias FGTS Para emissão de crédito com garantias em multa e saldo do FGTS, é necessário realizar uma consulta adicional para verificar a disponibilidade destas garantias. :::warning Verbas rescisórias Neste endpoint serão retornados somente os valores de multa rescisória e saldo FGTS disponíveis, o percentual de verbas rescisórias é retornado no endpoint de [consulta de dados do vínculo](#consulta-de-dados). ::: :::danger Autorização no app da CTPS Além do termo de autorização o tomador deve entrar no app da CTPS e autorizar a instituição financeira QI SCD a consultar o seu saldo no FGTS. ::: **POST** /private_payroll/warranty_inquiry ### Request **Caso 1:** O trabalhador é o assinante do [Termo de autorização](#authorization_term). **Request Body** ```json { "document_number": "", "registration_number": "", "employer_document_number": "", "authorization_term": { "signature": { "signer": { "name": "", "email": "", "phone": { "number": "", "area_code": "", "country_code": "55" }, "document_number": "" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "", "ip_address": "", "fingerprint": {}, "session_id": "" } } } } ``` **Caso 2:** O representante legal é o assinante do [Termo de autorização](#authorization_term). **Request Body** ```json { "document_number": "", "registration_number": "", "employer_document_number": "", "authorization_term": { "legal_representative_document_number": "", // Caso aplicável "signature": { "signer": { "name": "", "email": "", "phone": { "number": "", "area_code": "", "country_code": "55" }, "document_number": "" }, "authentication_type": "opt_in", "authenticity": { "timestamp": "", "ip_address": "", "fingerprint": {}, "session_id": "" } } } } ``` :::caution Atenção Nos casos em que houver representante legal, é necessário preencher o campo **"legal_representative_document_number"** com o CPF do representante legal, e os dados do objeto **"signer"** devem ser preenchidos com os dados do mesmo. ::: ### Response STATUS **202** Accepted **Response Body** ```json { "warranty_inquiry_key": "", "warranty_inquiry_status": "pending_inquiry" } ``` :::info Os possíveis valores para o enumerador **warranty_inquiry_status** estão listados na seção [Status das consultas de vínculos empregatícios](#status-das-consultas). ::: ### Webhooks WEBHOOK TYPE laas.private_payroll.warranty_inquiry_status_change Retorno da consulta de garantias FGTS: STATUS completed **Webhook Body** ```json { "key": "", "status": "completed", "webhook_type": "laas.private_payroll.warranty_inquiry_status_change", "event_datetime": "2025-03-24T15:28:31Z", "data": { "severance_fine":1000, "fgts_balance":2000 } } ``` STATUS failed **Webhook Body** ```json { "key": "", "status": "failed", "webhook_type": "laas.private_payroll.warranty_inquiry_status_change", "event_datetime": "2025-03-24T15:28:31Z", "data": { "enumerator": "ineligible_worker_cpf", "description": "CPF not found in database or worker CPF ineligible", "translation": "CPF não encontrado na base ou CPF do trabalhador inelegível" } } ``` ## Anexos --- ### Detalhamento do objeto authorization_term {#authorization_term} | Campo | Obrigatoriedade | Descrição | |-------------------------|-----------------|------------------------------------| |Name |Obrigatório |Nome do tomador | |Email |Opcional |Email do tomador | |Phone |Opcional |Telefone do tomador | |Document_number |Obrigatório |CPF do tomador | |Authentication_type |Obrigatório |Obrigatoriamente "opt-in" | |Timestamp |Obrigatório |Timestamp do aceite do tomador, obrigatoriamente no formato: 2025-08-04T23:45:30Z| |Ip_address |Obrigatório |IP da sessão do usuário, seja em IPv4 (ex: 192.168.0.1) ou IPv6 (ex: 2001:0db8:85a3:0000:0000:8a2e:0370:7334)| |Fingerprint |Obrigatório |Objeto onde podem ser enviadas evidências adicionais que contribuam com a robustez do aceite e que auxiliem na rastreabilidade, apesar de obrigatório, pode ser enviado um objeto nulo| |Session_id |Obrigatório |Chave identificadora interna da sessão do usuário, tamanho mínimo 10 e máximo 50| **Exemplos de campos do objeto fingerprint** ```json { "fingerprint_id": "4c188fc4-2cb4-48cc-9236-7df953570638", "lat": "-15.82891", "long": "-48.12751", "name": "ALBERTO PEREIRA", "device": "Web", "browser": "Chrome", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/037.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/037.36", "browser_version": "120.0.0.0" } ``` ### Detalhamento do webhook de consulta de dados | Campo | Descrição | |------------------------- |------------------------------------| |document_number |Documento do tomador | |registration_number |Número de registro do vínculo empregatício | |employer_document_number |Número de documento do empregador (no caso de CNPJ somente os 8 primeiros dígitos)| |name |Nome do tomador | |gender |Gênero do tomador | |birth_date |Data de nascimento do tomador| |worker_category_code |[Categoria do trabalhador](https://www.gov.br/esocial/pt-br/documentacao-tecnica/manuais/leiautes-esocial-v-1-1-beta/tabelas.html#01) em conformidade com o site do eSocial| |eligible |Eligibilidade do vínculo para emissão de crédito consignado| |available_margin_amount |Margem consignável| |base_margin_amount |Salário| |total_due_amount |Saldo devedor do tomador| |admission_date |Data de admissão| |termination_date |Data de desligamento| |termination_reason_code |[Motivo do desligamento](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#19) em conformidade com o site do eSocial| |political_exposition |Nível de exposição política do tomador, consulte os possíveis enumeradores na tabela [Exposição política](#exposição-política)| |employer_name |Nome do empregador| |mother_name |Nome da mãe do tomador| |nationality.description |Nacionalidade do tomador| |nationality.code |Código da nacionalidade to tomador segundo o padrão numérico da parte 1 da norma ISO 3166| |occupation.description |Ocupação do tomador segundo a Clasificação Brasileira de Ocupações (CBO)| |occupation.code |Código segundo a CBO 2002| |economic_activity.description |Atividade econômica do empregador segundo a Classificação Nacional de Atividades Econômicas (CNAE)| |economic_activity.code |Código segundo a CNAE Subclasses 2.3| |ineligibility_reason |Motivo da inelegibilidade do vínculo| |employer_activity_start_date |Data de início da atividade do empregador| |legacy_loans |Lista de empréstimos ativos informados pelas IFs, para detalhamento dos campos consulte a tabela [Detalhamento do objeto legacy_loans](#legacy_loans)| |alerts |Lista com histórico de afastamentos e avisos de desligamento do vínculo, para detalhamento dos campos consulte a tabela [Detalhamento do objeto alerts](#alerts)| |suspended_loans_count |Quantidade de empréstimos suspensos| |block_type |Tipo de bloqueio do Vínculo empregatício, consulte os possíveis enumeradores na tabela [Bloqueio de Salário](#block)| |blocked_at |Data de bloqueio do Vínculo empregatício| |warranty |Garantias disponíveis| |severance_pay_rate |Percentual de verbas rescisórias disponível para garantia| ### Detalhamento do webhook de consulta de saldo FGTS | Campo | Descrição | |------------------------- |------------------------------------| |severance_fine |Valor de multa rescisória disponível para garantia | |fgts_balance |Valor de saldo do fgts disponível para garantia | ### Exposição política {#exposicao-politica} ENUMERADOR political_exposition | Enumerador | Descrição | | ------------- | ------------------------------------------------------------------------- | | not_exposed | Pessoa não exposta politicamente | | level_1 | Pessoa exposta politicamente nível 1 | | level_2 | Pessoa exposta politicamente nível 2 | | not_informed | Não há informação sobre a exposição política | ### Detalhamento do objeto alerts {#alerts} | Campo | Descrição | |------------------------- |------------------------------------| |alert_type |Tipo de alerta, consulte os possíveis enumeradores na tabela [Tipos de alerta](#alert_type)| |reference_date |Data de referência do evento| |event_id |Identificador do evento| |leave_reason_code |[Motivo do afastamento](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#18) em conformidade com o site do eSocial| |leave_start_date |Data de início do afastamento| |leave_end_date |Data de término do afastamento| |termination_reason_code |[Motivo do desligamento](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#19) em conformidade com o site do eSocial| |termination_date |Data de desligamento do vínculo| |notice_period_start_date |Data de início do período de aviso prévio| |notice_period_end_date |Data de término do período de aviso prévio| ### Tipos de alerta {#alert_type} ENUMERADOR alert_type | Enumerador | Descrição | |------------------------- |-----------------------------------| |leave |Afastamento | |termination |Aviso prévio de desligamento | ### Detalhamento do objeto legacy_loans {#legacy_loans} | Campo | Descrição | |------------------------- |------------------------------------| |loan_amount |Valor desembolsado| |monthly_cet |CET mensal| |monthly_rate |Taxa mensal| |contract_type |Tipo de contrato, consulte os possíveis enumeradores na tabela [Tipos de contrato legado](#contract_type)| |contract_number |Número de contrato| |contract_end_date |Data de término do contrato| |paid_installments |Quantidade de parcelas pagas| |total_installments |Quantidade total de parcelas| |installment_amount |Valor de parcela| |contract_start_date |Data de início do contrato| |outstanding_balance |Saldo devedor| |last_update_timestamp |Data da última atualização| |financial_institution_code |Código da IF que informou o empréstimo| ### Tipos de contrato legado{#contract_type} ENUMERADOR contract_type | Enumerador | Descrição | |------------------------- |-----------------------------------| |unsecured_non_consigned_loan |Empréstimo não consignado sem garantia| |loan_with_payroll_deductions |Empréstimo com descontos em folha de pagamento| ### Status das consultas de vínculos empregatícios e de dados do trabalhador {#status-das-consultas} ENUMERADOR employment_relationships_inquiry_status ENUMERADOR balance_inquiry_status ENUMERADOR warranty_inquiry_status | Status | Descrição | | --------------------- | ----------------------------------------------------------------------------- | | pending_authorization | Os dados de autorização foram enviados e estão pendentes de processamento. | | pending_inquiry | A consulta está autorizada e pendente de ser processada. | | completed | A consulta foi concluída com sucesso. | | failed | A consulta falhou. | ### Bloqueio de Vínculo empregatício {#block} ENUMERADOR block_type | Enumerador | Descrição | | ------------- | ------------------------------------------------------------------------- | | no_block | Vínculo empregatício não bloqueado | | blocked_by_the_worker | Vínculo empregatício pelo colaborador | --- # Manual Consignado Privado - Crédito Novo URL: /documentation/manual_consignado_privado/manual_credito_novo :::info Navegação - [Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador) (anterior) - [Formalização Externa](/documentation/manual_consignado_privado/manual_assinatura_externa) (próximo) ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1 - Simulação da dívida: CRÉDITO NOVO ### Request **POST** /debt_simulation Testar no Playground **Valor de parcela** ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "installment_face_value": 100, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "private_payroll" } ] } ``` **Valor desembolsado** ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "disbursed_amount": 1000, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "private_payroll" } ] } ``` **Simulação com garantia** ```json title='Request Body' { "borrower": { "person_type": "natural", "individual_document_number": "14471835092" }, "financial": { "first_due_date": "2024-12-07", "disbursed_amount": 1000, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "07940839000159", "registration_number": "99999999999-A", "warranted" : true } } ] } ``` :::info Na request acima existem 3 simulações sendo realizadas. A primeira está fixando o valor de parcela ao cliente (varia o valor desembolsado) e a segunda está fixando o valor desembolsado (varia o valor de parcela). A terceira está adicionando as informações do vínculo empregatício para que seja retornada na resposta a composição da cobertura para o fluxo de pagamento considerando as garantias disponíveis retornadas nas últimas consultas deste vínculo. ::: ### Response STATUS **200** (OK) **Response Body** **Simulação sem garantia** ```json { "type": "debt", "key": "", "status": "finished", "event_datetime": "2024-11-05 16:50:00", "data": { "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "interest_payment_month_period": 1, "principal_grace_period": 0, "principal_amortization_month_period": 1, "operation_type": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2024-11-05", "number_of_installments": 4, "requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a", "final_disbursement_amount": 0.0, "disbursement_options": [ { "iof_amount": 3.93, "total_pre_fixed_amount": 17.8715883143, "cet": 0.0257, "annual_cet": 0.355163, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.29 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.29, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-05", "first_due_date": "2024-12-21", "installments": [ { "calendar_days": 34, "workdays": 23.0, "business_due_date": "2024-12-21", "due_date": "2024-12-21", "due_principal": 382.13, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 7.6967422515, "tax_amount": 0.257341482602818, "total_amount": 100, "principal_amortization_amount": 92.3032577485, "installment_number": 1 }, { "calendar_days": 29, "workdays": 19.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 289.8267422515, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 4.9718040699, "tax_amount": 0.4909156601748966, "total_amount": 100, "principal_amortization_amount": 95.0281959301, "installment_number": 2 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 194.7985463214, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.5742034136, "tax_amount": 0.7432500400879712, "total_amount": 100, "principal_amortization_amount": 96.4257965864, "installment_number": 3 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 98.372749735, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.6288385793, "tax_amount": 0.9841050988526828, "total_amount": 100, "principal_amortization_amount": 98.3711614207, "installment_number": 4 } ], "issue_amount": 382.13, "disbursed_issue_amount": 374.91, "assignment_amount": 382.13, "final_disbursement_amount": 374.91, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.77, "total_pre_fixed_amount": 24.2597288075, "cet": 0.0243, "annual_cet": 0.334037, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.25 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.25, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-06", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 62, "workdays": 41.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.74, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.9149280115, "tax_amount": 0.437656505989534, "total_amount": 100, "principal_amortization_amount": 86.0850719885, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6549280115, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.722070128765373, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.969623951, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9601685182659746, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1979530917, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.2239426674782687, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 375.74, "disbursed_issue_amount": 367.72, "assignment_amount": 375.74, "final_disbursement_amount": 367.72, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.74, "total_pre_fixed_amount": 24.0392857898, "cet": 0.0243, "annual_cet": 0.334673, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-07", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 61, "workdays": 40.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.96, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.6944849939, "tax_amount": 0.4317001860605122, "total_amount": 100, "principal_amortization_amount": 86.3055150061, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6544849939, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.714305933832412, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.9691809334, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.952233241255512, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1975100741, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757157, "tax_amount": 1.2158904130882027, "total_amount": 100, "principal_amortization_amount": 98.1982242843, "installment_number": 4 } ], "issue_amount": 375.96, "disbursed_issue_amount": 367.96, "assignment_amount": 375.96, "final_disbursement_amount": 367.96, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.71, "total_pre_fixed_amount": 23.8187134405, "cet": 0.0244, "annual_cet": 0.335196, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-08", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 60, "workdays": 39.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 376.18, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.4739126445, "tax_amount": 0.42570834978906, "total_amount": 100, "principal_amortization_amount": 86.5260873555, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6539126445, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.706541738899451, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.968608584, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9442979642450494, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-21", "due_date": "2025-04-21", "due_principal": 98.1969377247, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.20783815869566, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 376.18, "disbursed_issue_amount": 368.21, "assignment_amount": 376.18, "final_disbursement_amount": 368.21, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } } ] } } ``` **Simulação com garantia** ```json { "type": "debt", "key": "", "status": "finished", "event_datetime": "2024-11-05 16:50:00", "data": { "collaterals": [ { "percentage": 1, "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "07940839000159", "registration_number": "99999999999-A", "warranty":{ "severance_pay_rate":0.15, "severance_fine":1000, "fgts_balance":2000 } } } ], "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "interest_payment_month_period": 1, "principal_grace_period": 0, "principal_amortization_month_period": 1, "operation_type": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2024-11-05", "number_of_installments": 4, "requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a", "final_disbursement_amount": 0.0, "disbursement_options": [ { "iof_amount": 3.93, "total_pre_fixed_amount": 17.8715883143, "cet": 0.0257, "annual_cet": 0.355163, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.29 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.29, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-05", "first_due_date": "2024-12-21", "installments": [ { "calendar_days": 34, "workdays": 23.0, "business_due_date": "2024-12-21", "due_date": "2024-12-21", "due_principal": 382.13, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 7.6967422515, "tax_amount": 0.257341482602818, "total_amount": 100, "principal_amortization_amount": 92.3032577485, "installment_number": 1 }, { "calendar_days": 29, "workdays": 19.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 289.8267422515, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 4.9718040699, "tax_amount": 0.4909156601748966, "total_amount": 100, "principal_amortization_amount": 95.0281959301, "installment_number": 2 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 194.7985463214, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.5742034136, "tax_amount": 0.7432500400879712, "total_amount": 100, "principal_amortization_amount": 96.4257965864, "installment_number": 3 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 98.372749735, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.6288385793, "tax_amount": 0.9841050988526828, "total_amount": 100, "principal_amortization_amount": 98.3711614207, "installment_number": 4 } ], "issue_amount": 382.13, "disbursed_issue_amount": 374.91, "assignment_amount": 382.13, "final_disbursement_amount": 374.91, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.77, "total_pre_fixed_amount": 24.2597288075, "cet": 0.0243, "annual_cet": 0.334037, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.25 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.25, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-06", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 62, "workdays": 41.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.74, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.9149280115, "tax_amount": 0.437656505989534, "total_amount": 100, "principal_amortization_amount": 86.0850719885, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6549280115, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.722070128765373, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.969623951, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9601685182659746, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1979530917, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.2239426674782687, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 375.74, "disbursed_issue_amount": 367.72, "assignment_amount": 375.74, "final_disbursement_amount": 367.72, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.74, "total_pre_fixed_amount": 24.0392857898, "cet": 0.0243, "annual_cet": 0.334673, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-07", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 61, "workdays": 40.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.96, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.6944849939, "tax_amount": 0.4317001860605122, "total_amount": 100, "principal_amortization_amount": 86.3055150061, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6544849939, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.714305933832412, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.9691809334, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.952233241255512, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1975100741, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757157, "tax_amount": 1.2158904130882027, "total_amount": 100, "principal_amortization_amount": 98.1982242843, "installment_number": 4 } ], "issue_amount": 375.96, "disbursed_issue_amount": 367.96, "assignment_amount": 375.96, "final_disbursement_amount": 367.96, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.71, "total_pre_fixed_amount": 23.8187134405, "cet": 0.0244, "annual_cet": 0.335196, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-08", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 60, "workdays": 39.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 376.18, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.4739126445, "tax_amount": 0.42570834978906, "total_amount": 100, "principal_amortization_amount": 86.5260873555, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6539126445, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.706541738899451, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.968608584, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9442979642450494, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-21", "due_date": "2025-04-21", "due_principal": 98.1969377247, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.20783815869566, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 376.18, "disbursed_issue_amount": 368.21, "assignment_amount": 376.18, "final_disbursement_amount": 368.21, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } } ] } } ``` --- ## 2 - Emissão da operação: O campo "registration_number", localizado dentro do objeto "collateral_data", refere-se ao número de matrícula de um vínculo empregatício. O mesmo é retornado na consulta de vínculos empregatícios. CRÉDITO NOVO ### Request **POST** /debt Testar no Playground **Sem representante legal** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "email":"email.devedor@gmail.com", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "political_exposition": "not_exposed", "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2023-09-21", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.0166, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 101.84, "limit_days_to_disburse": 7, "number_of_installments": 10, "principal_grace_period": 0, "rebates": [ // Opcional { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "07940839000159", "registration_number": "99999999999-A" } } ], "additional_data": { "contract": { "contract_number": "TST0000644799" } }, "purchaser_document_number": "32402502000135", "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` **Com representante legal** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "political_exposition": "not_exposed", "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "related_parties": [ { "role_type": "issuer_legal_representative", "person_type": "natural", "name": "REPRESENTANTE EXEMPLO", "email": "representante.exemplo@exemplo.com", "individual_document_number": "79795844067", "birth_date": "1970-04-20", "mother_name": "MÃE DO REPRESENTANTE", "phone": { "country_code": "55", "area_code": "11", "number": "999999999" }, "address": { "street": "RUA EXEMPLO", "number": "123", "complement": "APTO 123", "neighborhood": "BAIRRO EXEMPLO", "postal_code": "12345678", "city": "SÃO PAULO", "state": "SP" } } ], "financial": { "interest_type": "pre_price_days", "first_due_date": "2024-09-21", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 1000, "limit_days_to_disburse": 7, "number_of_installments": 84, "principal_grace_period": 0, "rebates": [ // Opcional { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "07940839000159", "registration_number": "99999999999-A" } } ], "additional_data": { "contract": { "contract_number": "TST0000644715" } }, "purchaser_document_number": "32402502000135", "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` **Com garantia** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "email":"email.devedor@gmail.com", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "political_exposition": "not_exposed", "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2023-09-21", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.0166, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 101.84, "limit_days_to_disburse": 7, "number_of_installments": 10, "principal_grace_period": 0, "rebates": [ // Opcional { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "07940839000159", "registration_number": "99999999999-A", "warranted": true } } ], "additional_data": { "contract": { "contract_number": "TST0000644799" } }, "purchaser_document_number": "32402502000135", "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` ### Response STATUS **201** (Created) **Response Body** ```json title="Response Body" { "webhook_type": "debt", "key": "", "status": "waiting_signature", "event_datetime": "2024-11-07 23:19:22", "data": { "borrower": { "name": "Nome devedor", "document_number": "14471835092", "related_party_key": "28b7fc16-6d1f-467d-9667-62a8c13daea6" }, "contract": { "number": "TST0000644710", "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/a2e9c83a-3666-4def-8b27-e96fabb8705c/NOME_DEVEDOR-CCB-TST0000644710-20241107231916.pdf" ], "signature_information": [ { "signer_name": "Nome devedor", "signer_document_number": "14471835092", "signer_role": "issuer", "signer_email": null, "signer_external_key": null, "signature_url": null } ] }, "requester_identifier_key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00", "iof_charge_method": "financed", "collaterals": [ { "absolute_amount": null, "collateral_constituted": false, "collateral_data": { "registration_number": "99999999999-A", "employer_document_number": "07940839000159" }, "collateral_key": "26c7f4f4-51f3-41fa-b880-9691211136aa", "collateral_type": "private_payroll", "created_at": "2024-11-07T23:19:16.413448", "external_key": null, "percentage": 1, "updated_at": "2024-11-07T23:19:16.413441" } ], "disbursement_options": [ { "disbursement_date": "2024-11-07", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.3, "issue_amount": 909.75, "cet": "2,0100%", "annual_cet": "27,0481%", "base_iof": 16.259002146803677, "additional_iof": 3.45705, "total_iof": 19.72, "total_pre_fixed_amount": 108.6508885851, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 74, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 909.75, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 37.1789024864, "principal_amortization_amount": 64.6610975136, "tax_amount": 0.3923635397125248, "total_amount": 101.84, "workdays": 49.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0889024864, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.753721435360089, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5486660915, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9845001990781314, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2772376046, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.222548377175604, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4632222376, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4797864582180404, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4416948163, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.72770892770474, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7989345071, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.999011328473856, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5716418016, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.274874127227187, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.570357168, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.570318634292211, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3090744135, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8541691195612935, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-08", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.79, "issue_amount": 910.24, "cet": "2,0200%", "annual_cet": "27,0539%", "base_iof": 16.187351160427028, "additional_iof": 3.458912, "total_iof": 19.65, "total_pre_fixed_amount": 108.1583324947, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 73, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 910.24, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.6863463961, "principal_amortization_amount": 65.1536536039, "tax_amount": 0.3900097704729454, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0863463961, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7465431359757072, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5461100012, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9770979419422056, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2746815143, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.21518362791551, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4606661473, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4721586929694939, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.439138726, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7200302213593857, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7963784168, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.991202690472005, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5690857113, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.266920021887232, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5678010777, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.562261209106342, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3065183232, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.845943848326202, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-09", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.28, "issue_amount": 910.73, "cet": "2,0200%", "annual_cet": "27,0599%", "base_iof": 16.115620969325082, "additional_iof": 3.460774, "total_iof": 19.58, "total_pre_fixed_amount": 107.6655097248, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 72, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 910.73, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.1935236262, "principal_amortization_amount": 65.6464763738, "tax_amount": 0.3875767965109152, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0835236262, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7393648365913253, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5432872313, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9696956848062798, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2718587444, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.207818878655416, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4578433774, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4645309277209473, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4363159561, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7123515150140312, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7935556469, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.983394052470154, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5662629414, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2589659165472766, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5649783078, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.554203783920473, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3036955533, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.837718577088265, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-10", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.79, "issue_amount": 911.23, "cet": "2,0200%", "annual_cet": "27,0635%", "base_iof": 16.0438115087348, "additional_iof": 3.462674, "total_iof": 19.51, "total_pre_fixed_amount": 107.1724201311, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 71, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 911.23, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.7004340324, "principal_amortization_amount": 66.1395659676, "tax_amount": 0.3850645530633672, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0904340324, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7321865372069436, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5501976375, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.962293427670354, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2787691506, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.200454129395322, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4647537836, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4569031624724007, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4432263623, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7046728086686769, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.8004660531, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.975585414468303, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5731733476, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2510118112073214, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.571888714, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.546146358734604, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3106059595, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.829493305847507, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-11", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.28, "issue_amount": 911.72, "cet": "2,0200%", "annual_cet": "27,0698%", "base_iof": 15.971922713858204, "additional_iof": 3.464536, "total_iof": 19.44, "total_pre_fixed_amount": 106.6790635687, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 70, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 911.72, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.2070774702, "principal_amortization_amount": 66.6329225298, "tax_amount": 0.382472975321052, "total_amount": 101.84, "workdays": 47.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0870774702, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7250082378225619, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5468410753, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9548911705344282, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2754125884, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.193089380135228, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4613972214, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.449275397223854, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4398698001, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6969941023233224, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7971094909, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.967776776466452, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5698167854, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.243057705867366, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5685321518, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.538088933548735, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3072493973, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141714, "principal_amortization_amount": 100.3081858286, "tax_amount": 2.8212680346152035, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-12", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.77, "issue_amount": 912.21, "cet": "2,0200%", "annual_cet": "27,0762%", "base_iof": 15.899954519820076, "additional_iof": 3.466398, "total_iof": 19.37, "total_pre_fixed_amount": 106.1854398936, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 69, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 912.21, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.7134537949, "principal_amortization_amount": 67.1265462051, "tax_amount": 0.3798019984284558, "total_amount": 101.84, "workdays": 46.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0834537949, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.71782993843818, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5432174, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9474889133985024, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2717889131, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.185724630875134, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4577735461, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4416476319753073, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4362461248, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.689315395977968, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7934858156, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.959968138464601, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5661931101, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2351036005274114, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5649084765, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.530031508362866, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.303625722, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8130427633716497, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-13", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.27, "issue_amount": 912.71, "cet": "2,0200%", "annual_cet": "27,0802%", "base_iof": 15.827906861727051, "additional_iof": 3.468298, "total_iof": 19.3, "total_pre_fixed_amount": 105.691548961, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 68, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 912.71, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.2195628621, "principal_amortization_amount": 67.6204371379, "tax_amount": 0.3770515574809304, "total_amount": 101.84, "workdays": 45.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0895628621, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7106516390537982, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5493264672, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9400866562625766, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2778979803, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.17835988161504, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4638826133, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4340198667267607, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.442355192, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6816366896326136, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7995948828, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.95215950046275, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5723021773, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.227149495187456, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5710175437, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.521974083176997, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3097347892, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141718, "principal_amortization_amount": 100.3081858282, "tax_amount": 2.8048174921281284, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-14", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.57 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.07, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.77, "issue_amount": 913.2, "cet": "2,0200%", "annual_cet": "27,0870%", "base_iof": 15.755779674642707, "additional_iof": 3.47016, "total_iof": 19.23, "total_pre_fixed_amount": 105.1973906257, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 67, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 913.2, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 33.7254045271, "principal_amortization_amount": 68.1145954729, "tax_amount": 0.3742215875281126, "total_amount": 101.84, "workdays": 44.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0854045271, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7034733396694164, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5451681322, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9326843991266508, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2737396453, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.170995132354946, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4597242783, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4263921014782142, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.438196857, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6739579832872593, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7954365478, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.944350862460899, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5681438423, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.219195389847501, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5668592087, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.513916657991128, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3055764542, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.79659222089858, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } } ] } } ``` ### Objeto Installments | Campo | Descrição | |-------|-----------| | additional_costs | Custos adicionais | | business_due_date | Data de vencimento em dia útil | | calendar_days | Dias corridos | | due_date | Data de vencimento | | due_interest | Juros do vencimento | | due_principal | Principal do vencimento | | fine_amount | Multa do vencimento | | has_interest | Indica se o vencimento possui juros | | installment_number | Número da parcela | | installment_status | Status da parcela | | installment_type | Tipo de parcela | | post_fixed_amount | Valor da parcela após juros | | pre_fixed_amount | Valor da parcela antes de juros | | principal_amortization_amount | Valor da amortização do principal da parcela | | tax_amount | Valor dos juros da parcela | | total_amount | Valor total da parcela | | workdays | Dias úteis | ### Objeto Prefixed Interest Rate | Campo | Descrição | |-------|-----------| | monthly_rate | Taxa mensal | | daily_rate | Taxa diária | | annual_rate | Taxa anual | | interest_base | Base de cálculo da taxa de juros | ### Webhooks Caso a operação não seja assinada ou averbada até a última opção de data de desembolso o parceiro receberá um webhook informando a respeito do cancelamento da operação: WEBHOOK TYPE debt STATUS Canceled **Webhook Body** ```json title="Webhook Body" { "key": "", "status": "canceled", "webhook_type": "debt", "event_datetime": "2025-03-18 13:46:31", "data": { "cancel_reason": "", "cancel_reason_enumerator": "" } } ``` ### Objeto Data | Campo | Descrição | |-------|-----------| | cancel_reason | Motivo do cancelamento | | cancel_reason_enumerator | Enumerador do motivo do cancelamento | ## 3 - Coleta de documentos e formalização da operação É obrigatório o envio dos dados complementares do contrato para a formalização da operação. Recomendamos fortemente que a coleta e assinatura dos documentos da operação sejam realizadas por meio do **QI Sign**, nossa plataforma proprietária de assinatura eletrônica com tecnologia de antifraude embarcada. Por ter sido desenvolvida internamente e estar totalmente integrada aos nossos sistemas, o uso do QI Sign garante: - **Automação completa do fluxo de formalização**: a operação segue automaticamente para a próxima etapa após a assinatura. - **Upload automático de documentos**: todos os arquivos assinados são enviados diretamente para o sistema de crédito, sem necessidade de intervenção manual. - **Segurança e rastreabilidade**: o processo é seguro, auditável e em conformidade com os requisitos regulatórios. Essa abordagem reduz erros operacionais, acelera a liberação do crédito e melhora significativamente a experiência do cliente. ### Por que usar o QI Sign? - **Assinatura remota por celular**, com reconhecimento facial em conformidade com a regulação. - **Integração via API RESTful**, facilitando automação de fluxos de assinatura. - **Segurança jurídica**, com diferentes níveis de comprovação de identidade. - **Soluções escaláveis** e sob demanda para corporações que precisam digitalizar seus processos. :::info QI Sign O **QI Sign** é a plataforma de assinatura eletrônica da QI Tech, desenvolvida internamente para atender às exigências regulatórias do mercado de crédito. Com suporte a **biometria facial** e **envio automático de documentos**, garante segurança, agilidade e rastreabilidade durante a formalização. Para mais informações ou para solicitar uma proposta, entre em contato com nosso time comercial: 📧 **comercial@qitech.com.br** 📞 **(11) 2339-4763** ::: ### Formalização Externa Caso a formalização das operações não seja realizada através do QI Sign, o procedimento de formalização deve ser consultado no [manual de formalização externa.](./manual_assinatura_externa.md) ## Webhooks Após a assinatura do contrato, o parceiro receberá um webhook informando a respeito da assinatura do contrato. Com o seguinte body: ```json { "key": "", "status": "signed", "signers": [ { "id": "3271efd3-89ba-43aa-b032-af9a459e6096", "images": { "face_image_url": "https://qisign-face-images-bucket-sandbox.s3.amazonaws.com/fad7f924-d210-4ec4-9565-a57662a0a65a.jpeg", "document_back_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/8c7b68ba-07ad-4188-82ae-679833b2843b.jpeg", "document_front_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/f63cd291-5668-4926-be5d-9290aeda3f6e.jpeg", "document_back_template": "cnh_back", "document_front_template": "cnh_front" }, "biometry": { "face_validation": { "score": 80, "provider": "qitech", "available": true }, "fraud_base_flag": false }, "document": { "template": "cnh_front", "face_match_score": 100 }, "liveness": { "result": "live" }, "signed_at": "2025-04-09T19:59:39Z", "ip_address": "182.224.219.198", "signer_data": { "name": "Nome Trabalhador", "email": "exemplo@qitech.com.br", "phone": { "number": "829549234", "area_code": "11", "international_dial_code": "55" }, "address": { "uf": "SP", "city": "Sao Paulo", "number": "123", "street": "Rua tal do sal", "complement": "Ap 23", "postal_code": "00000-000", "neighborhood": "Pinheiros" }, "pix_key": "pix03@pix03.com", "birthdate": "1996-03-13", "document_number": "504.856.400-66", "document_submission_method": "email", "authentication_submission_method": "sms" } } ], "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2025-04-09 20:00:19", "signed_contract_url": "https://storage.googleapis.com/sandbox-doc-api/documents/9b55450e-fca5-44f2-9118-5851ed4bd92e/RESTAURANTEBEBBER-TRABALHADOR_SICQ-CCB-0000195364-2230409195718_signed.pdf" } ``` ### Objeto Signers | Campo | Descrição | |-------|-----------| | id | ID do signatário | | images | Imagens do signatário | ### Objeto Images | Campo | Descrição | |-------|-----------| | face_image_url | URL da imagem da face do signatário | | document_back_url | URL da imagem do verso do documento do signatário | | document_front_url | URL da imagem do documento do signatário | | document_back_template | Template do verso do documento do signatário | | document_front_template | Template do documento do signatário | ### Objeto Biometry | Campo | Descrição | |-------|-----------| | face_validation | Validação da rosto do signatário (true ou false) | | face_validation.score | Pontuação da rosto do signatário (0 a 100) | | face_validation.available | Disponibilidade da validação da rosto do signatário (true ou false) | | face_validation.provider | Provedor da validação da rosto do signatário (qitech ou external) | | fraud_base_flag | Flag de fraude base (true ou false) | ### Objeto Document | Campo | Descrição | |-------|-----------| | template | Template do documento (cnh_front, cnh_back, rg_front, rg_back) | | face_match_score | Pontuação da rosto do signatário (0 a 100) | ### Objeto Liveness | Campo | Descrição | |-------|-----------| | result | Resultado da liveness (live ou spoof) | ### Objeto Signer Data | Campo | Descrição | |-------|-----------| | name | Nome do signatário | | email | Email do signatário | | phone | Telefone do signatário | ### Objeto Address | Campo | Descrição | |-------|-----------| | uf | Unidade Federativa | | city | Cidade | | number | Número | | street | Rua | | complement | Complemento | | postal_code | CEP | | neighborhood | Bairro | ### Objeto Warranty | Campo | Descrição | |-------|-----------| | severance_pay_rate |float |Percentual de verbas rescisórias disponíveis para garantia| | severance_fine |float |Valor de multa rescisória disponível para garantia| | fgts_balance |float |Valor de saldo do fgts disponível para garantia| ## Enumeradores ### Status da reserva {#status-da-reserva} ENUMERADOR reservation_status | Status | Descrição | | ----------------------------- | ------------------------------------------------------------------------- | | pending_auction | A reserva foi criada e está esperando o início do leilão (receber uma solicitação de proposta). | | pending_reservation | A reserva foi criada e está pendente de averbação. | | pending_documents_submission | A reserva já foi averbada e está pendente de envio de documentos. | | reserved | A reserva foi averbada com sucesso. Fluxo de averbação concluído. | | canceled | Em caso de envio de documentos inválidos, a reserva é cancelada. | | pending_suspension | A reserva está averbada e foi solicitada a suspensão. | | suspended | A reserva foi suspensa com sucesso. | | settled | A reserva foi liquidada com sucesso. | | pending_deletion | A reserva está averbada e foi solicitada a exclusão. | | deleted | A reserva foi excluída com sucesso. | --- # Manual Consignado Privado - Fluxo Ativo de Emissão URL: /documentation/manual_consignado_privado/manual_detalhamento_fluxo_ativo :::info Próximo passo - [Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador) ::: ## Etapas do fluxo ### 1. Consultas do trabalhador Realizar as [consultas do trabalhador](./manual_consultas_trabalhador.md) a fim de verificar a elegibilidade dos vínculos para emissão de crédito consignado e a margem consignável disponível além de outras informações. ### 2. Emissão e formalização da operação Realizar as chamadas de simulação e criação da operação de crédito e orientar o tomador quanto ao fluxo de assinatura da CCB. ### 3. Averbação Acompanhar o retorno da DATAPREV a respeito das tentativas de averbação. ### 4. Desembolso Acompanhar o desembolso da operação e tratar eventuais falhas de desembolso. --- # Manual Consignado Privado - Fluxo de Emissão Via Leilão URL: /documentation/manual_consignado_privado/manual_detalhamento_fluxo_leilao ## Etapas do fluxo ### 1. Configuração dos filtros de pedido de empréstimo Realizar a configuração dos filtros de recebimento de pedidos de empréstimo, a fim de selecionar o público alvo que se deseja atacar. ### 2. Recebimento dos webhooks de pedido de empréstimo e envio de proposta Receber os webhooks filtrados de pedidos de empréstimo, simular as condições desejadas do crédito e envio da proposta para o leilão interno. ### 3. Acompanhamento do status da proposta de leilão interno e da assinatura da operação de crédito Aguardar os webhooks de atualização do leilão interno e de assinatura da operação. ### 4. Autorização da averbação e acompanhamento do desembolso Autorizar a averbação e tratar as possíveis falhas de averbação e desembolso. --- # Manual Consignado Privado - Leilão Interno URL: /documentation/manual_consignado_privado/manual_leilao_interno ## 1. Início de Leilão Após as configurações dos filtros de pedidos de empréstimo, o parceiro irá começar a receber webhooks notificando estas solicitações. WEBHOOK_TYPE laas.private_payroll_auction.new_issuer_proposal_request Webhook Body: Nova solicitação de empréstimo **Solicitação sem garantia** ```json { "status": "ongoing", "event_datetime": "2025-03-20T14:47:43Z", "key": "88b0203d-31ad-48c6-a795-b6d45ab4898a", "webhook_type": "laas.private_payroll_auction.new_issuer_proposal_request", "data": { "issuer_proposal_request_key": "88b0203d-31ad-48c6-a795-b6d45ab4898a", "status": "ongoing", "expiration_datetime": "2025-03-21T11:47:12Z", "inclusion_limit_datetime": "2025-03-20T11:49:43Z", "issuer_proposal_request_data": { "issuer_registration_number": "TESTE123", "birth_date": "1973-03-14", "disbursed_issue_amount": 2100, "admission_date": "2020-03-10", "consigned_credit_balance": 10000, "eligible": true, "employer_document_type": "cnpj", "document_number": "00737823780", "employer_document_number": "29113956000181", "number_of_installments": 10, "political_exposition": "not_exposed", "name": "VALENTINA SANTOS", "alerts": [ { "alert_type": "leave", "description": "Afastamento", "reference_date": "2025-02-11", "event_id": "123456", "leave_reason_code": 3, "leave_start_date": "2025-02-11", "leave_end_date": "2025-03-11" }, { "alert_type": "termination", "description": "Desligamento", "reference_date": "2025-02-11", "event_id": "789012", "termination_reason_code": 1, "termination_date": "2025-02-11", "notice_period_start_date": "2025-01-11", "notice_period_end_date": "2025-02-11" } ], "issuer_proposal_request_type" : "standard", "warranty" : null } } } ``` **Solicitação com garantia** ```json { "status": "ongoing", "event_datetime": "2025-03-20T14:47:43Z", "key": "88b0203d-31ad-48c6-a795-b6d45ab4898a", "webhook_type": "laas.private_payroll_auction.new_issuer_proposal_request", "data": { "issuer_proposal_request_key": "88b0203d-31ad-48c6-a795-b6d45ab4898a", "status": "ongoing", "expiration_datetime": "2025-03-21T11:47:12Z", "inclusion_limit_datetime": "2025-03-20T11:49:43Z", "issuer_proposal_request_data": { "issuer_registration_number": "TESTE123", "birth_date": "1973-03-14", "disbursed_issue_amount": 2100, "admission_date": "2020-03-10", "consigned_credit_balance": 10000, "eligible": true, "employer_document_type": "cnpj", "document_number": "00737823780", "employer_document_number": "29113956000181", "number_of_installments": 10, "political_exposition": "not_exposed", "name": "VALENTINA SANTOS", "alerts": [ { "alert_type": "leave", "description": "Afastamento", "reference_date": "2025-02-11", "event_id": "123456", "leave_reason_code": 3, "leave_start_date": "2025-02-11", "leave_end_date": "2025-03-11" }, { "alert_type": "termination", "description": "Desligamento", "reference_date": "2025-02-11", "event_id": "789012", "termination_reason_code": 1, "termination_date": "2025-02-11", "notice_period_start_date": "2025-01-11", "notice_period_end_date": "2025-02-11" } ], "issuer_proposal_request_type" : "warranted", "warranty" : { "severance_pay_rate":0.15, "severance_fine":20000, "fgts_balance":10000 } } } } ``` Cada pedido de empréstimo passa por duas etapas, o leilão interno e o leilão no app da CTPS. O leilão interno se inicia assim que o webhook é recebido e se encerra no timestamp indicado no campo *inclusion_limit_datetime*, durante este período as propostas de todos os parceiros são recebidas e ranqueadas com base na taxa, assim que o leilão interno se encerra a proposta com as melhores condições é enviada à CTPS do tomador onde as propostas de todas as IFs são apresentadas. Caso nenhuma proposta seja enviada até o fim do leilão interno, a primeira proposta enviada depois do *inclusion_limit_datetime* ganhará automaticamente e será enviada à CTPS. ## 2. Proposta de Crédito ### Request POST - `/private_payroll_auction/issuer_proposal_request/{issuer_proposal_request_key}/auction_proposals` Testar no Playground Request Body: Incluindo AuctionProposal(s) no leilão **Proposta sem garantia** ```json { "standard_proposal":{ "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea", "disbursed_issue_amount": 15000, "monthly_interest_rate": 0.045, "number_of_installments": 48, "purchaser_document_number": "01272247000120", "days_to_expiration": 10, "rebates": [ { "fee_type": "spread", "amount_type": "percentage", "amount": 4.17 } ] } } ``` **Proposta com garantia** ```json { "standard_proposal":{ "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea", "disbursed_issue_amount": 15000, "monthly_interest_rate": 0.045, "number_of_installments": 48, "purchaser_document_number": "01272247000120", "days_to_expiration": 10, "rebates": [ { "fee_type": "spread", "amount_type": "percentage", "amount": 4.17 } ] }, "warranted_proposal":{ "request_control_key" : "4593d8a6-91a1-4195-ba78-b1a864bac247", "disbursed_issue_amount": 15000, "monthly_interest_rate": 0.04, "number_of_installments": 48, "purchaser_document_number": "01272247000120", "days_to_expiration": 10, "rebates": [ { "fee_type": "spread", "amount_type": "percentage", "amount": 4.17 } ] } } ``` ### Response STATUS - 200 (Accepted) Response Body: AuctionProposal(s) incluída(s) com sucesso no leilão **Resultado proposta sem garantia** ```json { "standard_proposal":{ "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea", "issuer_proposal_request_key" : "100e7ed3-4080-4cae-a853-8e12812817ea", "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea", "status": "bid", "proposal_score" : 0.4, "inclusion_date" : "2025-03-18T14:52:07.123456", "rank_position" : null, "proposal_data": { "simulation": { "total_iof": 523.3, "annual_cet": 0.735, "monthly_cet": 0.047, "issue_amount": 15523.3, "annual_interest_rate": 0.6958814328, "monthly_interest_rate": 0.045, "disbursed_issue_amount": 15000, "installment_face_value": 851.33, "number_of_installments" : 48 }, "monthly_interest_rate": 0.045, "disbursed_issue_amount": 15000, "installment_face_value": null, "number_of_installments": 48 }, } } ``` **Resultado proposta com garantia** ```json { "standard_proposal":{ "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea", "issuer_proposal_request_key" : "100e7ed3-4080-4cae-a853-8e12812817ea", "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea", "status": "bid", "proposal_score" : 0.4, "inclusion_date" : "2025-03-18T14:52:07.123456", "rank_position" : null, "proposal_data": { "simulation": { "total_iof": 523.3, "annual_cet": 0.735, "monthly_cet": 0.047, "issue_amount": 15523.3, "annual_interest_rate": 0.6958814328, "monthly_interest_rate": 0.045, "disbursed_issue_amount": 15000, "installment_face_value": 851.33, "number_of_installments" : 48 }, "monthly_interest_rate": 0.045, "disbursed_issue_amount": 15000, "installment_face_value": null, "number_of_installments": 48 }, }, "warranted_proposal":{ "auction_proposal_key": "1fedc1ba-bff5-4149-831a-cfd1f556da63", "issuer_proposal_request_key" : "100e7ed3-4080-4cae-a853-8e12812817ea", "request_control_key" : "4593d8a6-91a1-4195-ba78-b1a864bac247", "status": "bid", "proposal_score" : 0.4, "inclusion_date" : "2025-03-18T14:52:07.123456", "rank_position" : null, "proposal_data": { "simulation": { "total_iof": 522.06, "annual_cet": 0.6364, "monthly_cet": 0.0419, "issue_amount": 15522.06, "annual_interest_rate": 0.6010322186, "monthly_interest_rate": 0.04, "disbursed_issue_amount": 15000, "installment_face_value": 778.76, "number_of_installments" : 48 }, "monthly_interest_rate": 0.04, "disbursed_issue_amount": 15000, "installment_face_value": null, "number_of_installments": 48 } } } ``` STATUS - 400 (Rejected) Response Body: Bad Request **Margem consignável excedida** ```json { "title": "Bad Request", "description": "Calculated installment face value is greater than consigned credit balance", "translation": "Schema Invalido", "extra_fields": {}, "code": "QIT000001" } ``` **Garantias disponíveis excedidas** ```json { "title": "Warranty cap exceeded", "description": "One or more warranty values exceed the allowed caps", "translation": "Um ou mais valores de garantia excedem os limites permitidos", "extra_fields": {}, "code": "PPA000034" } ``` ## 3. Encerramento do Leilão Quando o leilão interno se encerra, um webhook é enviado atualizando o parceiro se o mesmo venceu ou perdeu o leilão, no caso de vitória, a operação de crédito é criada e o link de formalização do QI Sign é enviado ao app da CTPS do tomador, a partir deste momento o acompanhamento da operação deve ser realizado através da chave *credit_operation_key*. :::danger Leilão com garantia! Ao entrar no leilão de um pedido de empréstimo com garantia, são geradas duas propostas e o leilão interno é segregado em dois, um para as propostas com garantia e um para as propostas sem garantia, então dois webhooks são enviados informando a vitória ou derrota em cada um dos leilões. ::: WEBHOOK_TYPE laas.private_payroll_auction.end_of_auction Webhook Body: Resultado do leilão interno **Resultado proposta sem garantia** ```json { "key": "814e7ed3-4080-4cae-a853-8e12812817ea", // esta chave é igual à auction_proposal_key "data": { "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea", "status": "won", "type": "auction", "rank_position": 1, "signature_url": "https://sandbox.sign.qitech.com.br/r/3D1s523", "credit_operation_key": "9e06ca79-3610-4794-8312-9663e0343f6b", "issuer_proposal_request_key": "262d0584-9827-4652-9b27-6a46c9832f38", "proposal_number": "QITECH_6853045512774", "contract_number": "0340932936/VHD", "auction_proposal_type":"standard" }, "status": "won", "event_datetime": "2025-03-20T14:48:43Z", "webhook_type": "laas.private_payroll_auction.end_of_auction" } ``` **Resultado proposta com garantia** ```json { "key": "1fedc1ba-bff5-4149-831a-cfd1f556da63", // esta chave é igual à auction_proposal_key "data": { "auction_proposal_key": "1fedc1ba-bff5-4149-831a-cfd1f556da63", "status": "won", "type": "auction", "rank_position": 1, "signature_url": "https://sandbox.sign.qitech.com.br/r/3D1s523", "credit_operation_key": "9e06ca79-3610-4794-8312-9663e0343f6b", "issuer_proposal_request_key": "262d0584-9827-4652-9b27-6a46c9832f38", "proposal_number": "QITECH_6853045512774", "contract_number": "0340932936/VHD", "auction_proposal_type":"warranted", "warranty" : { "severance_pay_rate":null, "severance_fine":5522.06, "fgts_balance":10000 } }, "status": "won", "event_datetime": "2025-03-20T14:48:43Z", "webhook_type": "laas.private_payroll_auction.end_of_auction" } ``` A chave da operação de crédito será enviada com valor null para as propostas perdedoras. :::info Atenção O link de assinatura não será enviado no ambiente de produção, apenas em sandbox para que seja possível simular a assinatura do tomador. ::: ## Anexos ### Definição do Objeto IssuerProposalRequest | Nome | Tipo | Descrição | | --------------- | ------ | ---------------------------------------------------------------------------------- | | issuer_proposal_request_key | string | Identificador único da **Solicitação de Proposta** | | issuer_proposal_request_data| object | Objeto que descreve os dados da **Solicitação de Proposta** | | status | string | Status da **Solicitação de Proposta** (`ongoing`, `finished`, `expired`)| ### Definição do Objeto IssuerProposalRequestData | Nome | Tipo | Descrição | | --------------- | ------ | ---------------------------------------------------------------------------------- | | name |string | Nome completo do Tomador | | document_number |string | CPF do Tomador | | birth_date |string | Data de nascimento do Tomador no formato `YYYY-MM-DD` | | disbursed_amount |float | Valor de desembolso solicitado pelo tomador | | number_of_installments |integer| Número de parcelas solicitados pelo tomador | | consigned_credit_balance |float | Margem consignável disponível de saldo do tomador | | admission_date |string | Data de admissão do trabalhador no cargo atual no formato `YYYY-MM-DD` | | issuer_registration_code |string | Matricula eSocial do empregado| | employer_document_number |string | CNPJ do empregador | | eligible |boolean| True se elegivel, False se não elegivel| | employer_document_type |string | CNPJ ou CPF| | alerts |objeto |Lista com histórico de afastamentos e avisos de desligamento do vínculo, para detalhamento dos campos consulte a tabela [Detalhamento do objeto alerts](#alerts)| | type |string |Tipo de solicitação, para detalhamento dos campos consulte a tabela [Tipos de solicitação de empréstimo](#request_type)| | severance_pay_rate |float |Percentual de verbas rescisórias disponíveis para garantia| | severance_fine |float |Valor de multa rescisória disponível para garantia| | fgts_balance |float |Valor de saldo do fgts disponível para garantia| ### Detalhamento do objeto alerts {#alerts} | Campo | Descrição | |------------------------- |------------------------------------| |alert_type |Tipo de alerta, consulte os possíveis enumeradores na tabela [Tipos de alerta](#alert_type)| |reference_date |Data de referência do evento| |event_id |Identificador do evento| |leave_reason_code |[Motivo do afastamento](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#18) em conformidade com o site do eSocial| |leave_start_date |Data de início do afastamento| |leave_end_date |Data de término do afastamento| |termination_reason_code |[Motivo do desligamento](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#19) em conformidade com o site do eSocial| |termination_date |Data de desligamento do vínculo| |notice_period_start_date |Data de início do período de aviso prévio| |notice_period_end_date |Data de término do período de aviso prévio| ### Tipos de alerta {#alert_type} ENUMERADOR alert_type | Enumerador | Descrição | |------------------------- |-----------------------------------| |leave |Afastamento | |termination |Aviso prévio de desligamento | ### Tipos de solicitação de empréstimo {#request_type} ENUMERADOR type | Enumerador | Descrição | |------------------------- |-----------------------------------| |warranted |Solicitação com garantia | |standard |Solicitação sem garantia | ### Detalhamento dos Status da solicitação de proposta | Status | Descrição | | ------- | ------------------------------------------------------------------------- | | ongoing | **Solicitação de Proposta** em andamento, o leilão continua ativo. | | finished| **Solicitação de Proposta** finalizada, o leilão foi encerrado e uma **Proposta** enviada foi aceita e incluída. | | expired | **Solicitação de Proposta** expirada, o leilão foi encerrado sem a inclusão de nenhuma **Proposta** em tempo hábil. | ### Detalhamento da Requisição de Proposta de Leilão | Campo | Tipo | Descrição | Obrigatório | |---------------|---------|-----------------------------------------------------------------------------------------------------------------|-------------| | `issuer_proposal_request_key` | string | Chave única de identificação da **IssuerProposalRequest** incluída no formato uuid v4. | Sim | | `auction_proposal_key` | string | Chave única de identificação da **AuctionProposal** incluída no formato uuid v4. | Sim | | `disbursed_issue_amount`| float | Valor de desembolso pretendido pela **Proposta**. | Sim | | `purchaser_document_number` | integer | CNPJ do comprador da dívida | Sim | `monthly_interest_rate` | float | Taxa de juros mensal da **Proposta** no intervalo de 0 a 1 (0% a 100%, respectivamente). | Não | | `installment_face_value`| float | Valor da parcela pretendida pela **Proposta**. | Não | | `number_of_installments`| integer | Número de parcelas da proposta. | Sim | | `days_to_expiration`| integer | Número de dias até que a proposta expire. Caso a chave não seja incluida, a validade da proposta será de 7 dias | Não | | `rebates` | list | Lista de rebates da operação de crédito. Utiliza o mesmo padrão da emissão ativa (/debt) | Não | ### Detalhamento do webhook de finalização de leilão | Campo | Tipo | Descrição | |---------------|---------|-----------------------------------------------------------------------------------------------------------------| | `auction_proposal_key` | string | Chave única de identificação da **AuctionProposal** incluída no formato uuid v4. | | `status` | string | Indicador de vitória ou derrota no leilão interno. | | `type` | string | Enumerador de tipo de proposta de leilão (demais tipos foram deprecados o valor sempre será "auction"). | | `rank_position`| integer | Posição da proposta no leilão interno. | | `signature_url` | string | Link de formalização da dívida, enviado somente em ambiente de sandbox para fins de homologação. | | `credit_operation_key` | string | Identificador único da operação de crédito, caso a proposta não tenha vencido o leilão, é retornado vazio. | | `issuer_proposal_request_key`| string | Identificador único do pedido de empréstimo. | | `proposal_number`| string | Número da proposta QI Tech no app da CTPS. | | `contract_number`| string | Número de contrato da CCB | ### Detalhamento do webhook de finalização de leilão | Campo | Tipo | Descrição | |---------------|---------|-----------------------------------------------------------------------------------------------------------------| | `auction_proposal_key` | string | Chave única de identificação da **AuctionProposal** incluída no formato uuid v4. | | `status` | string | Indicador de vitória ou derrota no leilão interno. | | `type` | string | Enumerador de tipo de proposta de leilão (demais tipos foram deprecados o valor sempre será "auction"). | | `rank_position`| integer | Posição da proposta no leilão interno. | | `signature_url` | string | Link de formalização da dívida, enviado somente em ambiente de sandbox para fins de homologação. | | `credit_operation_key` | string | Identificador único da operação de crédito, caso a proposta não tenha vencido o leilão, é retornado vazio. | | `issuer_proposal_request_key`| string | Identificador único do pedido de empréstimo. | | `proposal_number`| string | Número da proposta QI Tech no app da CTPS. | | `contract_number`| string | Número de contrato da CCB | --- # Manual Consignado Privado - Refinanciamento URL: /documentation/manual_consignado_privado/manual_refinanciamento :::info Este manual é dedicado a documentar o refinanciamento de operações originadas na QI Tech já no crédito do trabalhador, ou de operações legado tombadas para o crédito do trabalhador. ::: :::danger Opções de desembolso Como no crédito novo, as operações de refinanciamento terão suas opções de desembolso limitadas à uma mesma competência, além disso, uma vez averbada a operação de refinanciamento deverá desembolsar na mesma data, caso contrário será cancelada permanentemente e precisará ser reformalizada. ::: :::warning Data de liquidação Para garantir o direito de arrependimento do tomador, as operações refinanciadas somente serão liquidadas 7 dias úteis após a data de desembolso da dívida. ::: :::danger Rotinas Automáticas de Cancelamento permanente Existem duas rotinas automáticas de cancelamento permanente acionadas pela QI Tech: 1. Esgotamento das opções de desembolso. Todas as operações que não forem desembolsadas até a data final de desembolso serão caceladas permanentemente no dia seguinte á data final. 2. Operação averbada e não desembolsada no mesmo dia. Operações de refinanciamento devem ser desembolsadas na mesma data da averbação, caso contrário serão canceladas permanentemente. Webhooks de cancelamento permanente **Esgotamento das opções de desembolso** ```json { "key": "d7ba5332-3675-12a6-9e07-8afd25ffcfd0", "data": { "cancel_reason": "Operação não desembolsada já passou da última data de desembolso", "cancel_reason_enumerator": "expired_disbursement_date" }, "status": "canceled_permanently", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2026-02-12 00:53:16" } ``` **Operação averbada e não desembolsada no mesmo dia** ```json { "key": "d7ba5332-3675-12a6-9e07-8afd25ffcfd0", "data": { "cancel_reason": "Operação excedeu o prazo máximo em averbação sem desembolso", "cancel_reason_enumerator": "exceeded_max_days_reserved_not_disbursed" }, "status": "canceled_permanently", "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2026-02-12 00:53:16" } ``` ::: Para simular e emitir dívidas de refinanciamento, deve-se adicionar ao payload as chaves das dívidas que serão refinanciadas no seguinte formato: REFINANCIAMENTO ```json "refinanced_credit_operations": [ { "operation_key": "c63f3a4c-0cde-4be7-8bb2-00ffc564cddb" } ] ``` ## 1 - Simulação da dívida: ### Request **POST** /debt_simulation Testar no Playground ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "installment_face_value": 100, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "private_payroll" } ], "refinanced_credit_operations": [ { "operation_key": "c63f3a4c-0cde-4be7-8bb2-00ffc564cddb" } ] } ``` ### Response STATUS **200** (OK) **Response Body** ```json { "type": "debt", "key": "", "status": "finished", "event_datetime": "2024-11-05 16:50:00", "data": { "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "interest_payment_month_period": 1, "principal_grace_period": 0, "principal_amortization_month_period": 1, "operation_type": "refinancing", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2024-11-05", "number_of_installments": 4, "requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a", "final_disbursement_amount": 0.0, "disbursement_options": [ { "iof_amount": 3.93, "total_pre_fixed_amount": 17.8715883143, "cet": 0.0257, "annual_cet": 0.355163, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.29 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.29, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-05", "first_due_date": "2024-12-21", "installments": [ { "calendar_days": 34, "workdays": 23.0, "business_due_date": "2024-12-21", "due_date": "2024-12-21", "due_principal": 382.13, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 7.6967422515, "tax_amount": 0.257341482602818, "total_amount": 100, "principal_amortization_amount": 92.3032577485, "installment_number": 1 }, { "calendar_days": 29, "workdays": 19.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 289.8267422515, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 4.9718040699, "tax_amount": 0.4909156601748966, "total_amount": 100, "principal_amortization_amount": 95.0281959301, "installment_number": 2 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 194.7985463214, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.5742034136, "tax_amount": 0.7432500400879712, "total_amount": 100, "principal_amortization_amount": 96.4257965864, "installment_number": 3 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 98.372749735, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.6288385793, "tax_amount": 0.9841050988526828, "total_amount": 100, "principal_amortization_amount": 98.3711614207, "installment_number": 4 } ], "issue_amount": 382.13, "disbursed_issue_amount": 374.91, "assignment_amount": 382.13, "final_disbursement_amount": 374.91, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.77, "total_pre_fixed_amount": 24.2597288075, "cet": 0.0243, "annual_cet": 0.334037, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.25 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.25, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-06", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 62, "workdays": 41.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.74, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.9149280115, "tax_amount": 0.437656505989534, "total_amount": 100, "principal_amortization_amount": 86.0850719885, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6549280115, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.722070128765373, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.969623951, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9601685182659746, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1979530917, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.2239426674782687, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 375.74, "disbursed_issue_amount": 367.72, "assignment_amount": 375.74, "final_disbursement_amount": 367.72, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.74, "total_pre_fixed_amount": 24.0392857898, "cet": 0.0243, "annual_cet": 0.334673, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-07", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 61, "workdays": 40.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.96, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.6944849939, "tax_amount": 0.4317001860605122, "total_amount": 100, "principal_amortization_amount": 86.3055150061, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6544849939, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.714305933832412, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.9691809334, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.952233241255512, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1975100741, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757157, "tax_amount": 1.2158904130882027, "total_amount": 100, "principal_amortization_amount": 98.1982242843, "installment_number": 4 } ], "issue_amount": 375.96, "disbursed_issue_amount": 367.96, "assignment_amount": 375.96, "final_disbursement_amount": 367.96, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.71, "total_pre_fixed_amount": 23.8187134405, "cet": 0.0244, "annual_cet": 0.335196, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-08", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 60, "workdays": 39.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 376.18, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.4739126445, "tax_amount": 0.42570834978906, "total_amount": 100, "principal_amortization_amount": 86.5260873555, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6539126445, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.706541738899451, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.968608584, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9442979642450494, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-21", "due_date": "2025-04-21", "due_principal": 98.1969377247, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.20783815869566, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 376.18, "disbursed_issue_amount": 368.21, "assignment_amount": 376.18, "final_disbursement_amount": 368.21, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "refinanced_credit_operations": [ { "due_balance": 833.55, "due_balance_reference_date": "2025-07-16", "original_deadline": 275, "refinanced_credit_operation_key": "dd65582d-ea63-44ab-8ee8-438b2d7246c7", "refinanced_credit_operation_status": "pending_payment" } ] } ] } } ``` --- ## 2 - Emissão da operação: REFINANCIAMENTO ### Request **POST** /debt Testar no Playground ```json title='Request Body' { "borrower": { "name": "Nome devedor", "email":"email.devedor@gmail.com", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "gender": "female", "political_exposition": "not_exposed", "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "complement": "complemento", "postal_code": "59065720", "neighborhood": "bairro" }, "role_type": "issuer", "birth_date": "1959-07-08", "mother_name": "NOME DA MAE", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "attached_documents_list": [], "individual_document_number": "14471835092", "document_identification_date": "2015-10-02", "document_identification_type": "rg", "document_identification_number": "003709888" }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2023-09-21", "disbursement_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.0166, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "monthly_interest_rate": 0.0166, "installment_face_value": 101.84, "limit_days_to_disburse": 7, "number_of_installments": 10, "principal_grace_period": 0, "rebates": [ // Opcional { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "07940839000159", "registration_number": "99999999999-A" } } ], "additional_data": { "contract": { "contract_number": "TST0000644799" } }, "purchaser_document_number": "32402502000135", "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ], "refinanced_credit_operations": [ { "operation_key": "dd65582d-ea63-44ab-8ee8-438b2d7246c7" } ] } ``` ### Response STATUS **201** (Created) **Response Body** ```json title="Response Body" { "webhook_type": "debt", "key": "", "status": "waiting_signature", "event_datetime": "2024-11-07 23:19:22", "data": { "borrower": { "name": "Nome devedor", "document_number": "14471835092", "related_party_key": "28b7fc16-6d1f-467d-9667-62a8c13daea6" }, "contract": { "number": "TST0000644710", "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/a2e9c83a-3666-4def-8b27-e96fabb8705c/NOME_DEVEDOR-CCB-TST0000644710-20241107231916.pdf" ], "signature_information": [ { "signer_name": "Nome devedor", "signer_document_number": "14471835092", "signer_role": "issuer", "signer_email": null, "signer_external_key": null, "signature_url": null } ] }, "requester_identifier_key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00", "iof_charge_method": "financed", "collaterals": [ { "absolute_amount": null, "collateral_constituted": false, "collateral_data": { "registration_number": "99999999999-A", "employer_document_number": "07940839000159" }, "collateral_key": "26c7f4f4-51f3-41fa-b880-9691211136aa", "collateral_type": "private_payroll", "created_at": "2024-11-07T23:19:16.413448", "external_key": null, "percentage": 1, "updated_at": "2024-11-07T23:19:16.413441" } ], "disbursement_options": [ { "disbursement_date": "2024-11-07", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.3, "issue_amount": 909.75, "cet": "2,0100%", "annual_cet": "27,0481%", "base_iof": 16.259002146803677, "additional_iof": 3.45705, "total_iof": 19.72, "total_pre_fixed_amount": 108.6508885851, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 74, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 909.75, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 37.1789024864, "principal_amortization_amount": 64.6610975136, "tax_amount": 0.3923635397125248, "total_amount": 101.84, "workdays": 49.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0889024864, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.753721435360089, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5486660915, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9845001990781314, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2772376046, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.222548377175604, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4632222376, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4797864582180404, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4416948163, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.72770892770474, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7989345071, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.999011328473856, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5716418016, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.274874127227187, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.570357168, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.570318634292211, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3090744135, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8541691195612935, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-08", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.79, "issue_amount": 910.24, "cet": "2,0200%", "annual_cet": "27,0539%", "base_iof": 16.187351160427028, "additional_iof": 3.458912, "total_iof": 19.65, "total_pre_fixed_amount": 108.1583324947, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 73, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 910.24, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.6863463961, "principal_amortization_amount": 65.1536536039, "tax_amount": 0.3900097704729454, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0863463961, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7465431359757072, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5461100012, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9770979419422056, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2746815143, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.21518362791551, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4606661473, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4721586929694939, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.439138726, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7200302213593857, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7963784168, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.991202690472005, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5690857113, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.266920021887232, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5678010777, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.562261209106342, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3065183232, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.845943848326202, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-09", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.28, "issue_amount": 910.73, "cet": "2,0200%", "annual_cet": "27,0599%", "base_iof": 16.115620969325082, "additional_iof": 3.460774, "total_iof": 19.58, "total_pre_fixed_amount": 107.6655097248, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 72, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 910.73, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.1935236262, "principal_amortization_amount": 65.6464763738, "tax_amount": 0.3875767965109152, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0835236262, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7393648365913253, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5432872313, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9696956848062798, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2718587444, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.207818878655416, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4578433774, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4645309277209473, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4363159561, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7123515150140312, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7935556469, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.983394052470154, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5662629414, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2589659165472766, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5649783078, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.554203783920473, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3036955533, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.837718577088265, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-10", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.79, "issue_amount": 911.23, "cet": "2,0200%", "annual_cet": "27,0635%", "base_iof": 16.0438115087348, "additional_iof": 3.462674, "total_iof": 19.51, "total_pre_fixed_amount": 107.1724201311, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 71, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 911.23, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.7004340324, "principal_amortization_amount": 66.1395659676, "tax_amount": 0.3850645530633672, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0904340324, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7321865372069436, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5501976375, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.962293427670354, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2787691506, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.200454129395322, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4647537836, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4569031624724007, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4432263623, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7046728086686769, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.8004660531, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.975585414468303, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5731733476, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2510118112073214, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.571888714, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.546146358734604, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3106059595, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.829493305847507, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-11", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.28, "issue_amount": 911.72, "cet": "2,0200%", "annual_cet": "27,0698%", "base_iof": 15.971922713858204, "additional_iof": 3.464536, "total_iof": 19.44, "total_pre_fixed_amount": 106.6790635687, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 70, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 911.72, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.2070774702, "principal_amortization_amount": 66.6329225298, "tax_amount": 0.382472975321052, "total_amount": 101.84, "workdays": 47.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0870774702, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7250082378225619, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5468410753, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9548911705344282, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2754125884, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.193089380135228, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4613972214, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.449275397223854, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4398698001, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6969941023233224, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7971094909, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.967776776466452, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5698167854, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.243057705867366, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5685321518, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.538088933548735, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3072493973, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141714, "principal_amortization_amount": 100.3081858286, "tax_amount": 2.8212680346152035, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-12", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.77, "issue_amount": 912.21, "cet": "2,0200%", "annual_cet": "27,0762%", "base_iof": 15.899954519820076, "additional_iof": 3.466398, "total_iof": 19.37, "total_pre_fixed_amount": 106.1854398936, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 69, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 912.21, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.7134537949, "principal_amortization_amount": 67.1265462051, "tax_amount": 0.3798019984284558, "total_amount": 101.84, "workdays": 46.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0834537949, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.71782993843818, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5432174, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9474889133985024, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2717889131, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.185724630875134, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4577735461, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4416476319753073, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4362461248, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.689315395977968, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7934858156, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.959968138464601, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5661931101, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2351036005274114, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5649084765, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.530031508362866, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.303625722, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8130427633716497, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-13", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.27, "issue_amount": 912.71, "cet": "2,0200%", "annual_cet": "27,0802%", "base_iof": 15.827906861727051, "additional_iof": 3.468298, "total_iof": 19.3, "total_pre_fixed_amount": 105.691548961, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 68, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 912.71, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.2195628621, "principal_amortization_amount": 67.6204371379, "tax_amount": 0.3770515574809304, "total_amount": 101.84, "workdays": 45.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0895628621, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7106516390537982, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5493264672, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9400866562625766, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2778979803, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.17835988161504, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4638826133, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4340198667267607, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.442355192, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6816366896326136, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7995948828, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.95215950046275, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5723021773, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.227149495187456, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5710175437, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.521974083176997, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3097347892, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141718, "principal_amortization_amount": 100.3081858282, "tax_amount": 2.8048174921281284, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-14", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.57 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.07, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.77, "issue_amount": 913.2, "cet": "2,0200%", "annual_cet": "27,0870%", "base_iof": 15.755779674642707, "additional_iof": 3.47016, "total_iof": 19.23, "total_pre_fixed_amount": 105.1973906257, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 67, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 913.2, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 33.7254045271, "principal_amortization_amount": 68.1145954729, "tax_amount": 0.3742215875281126, "total_amount": 101.84, "workdays": 44.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0854045271, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7034733396694164, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5451681322, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9326843991266508, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2737396453, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.170995132354946, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4597242783, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4263921014782142, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.438196857, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6739579832872593, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7954365478, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.944350862460899, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5681438423, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.219195389847501, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5668592087, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.513916657991128, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3055764542, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.79659222089858, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } } ] } } ``` ## Anexo ### Campos relevantes | Campo | Descrição | |--------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **issue_amount** | Valor de emissão | | **disbursed_issue_amount** | Valor total desembolsado (troco + quitações) | | **final_disbursement_amount** | Valor do troco | | **refinanced_credit_operations.due_balance** | Saldo devedor da dívida refinanciada | --- # Manual Consignado Privado – Averbação e revínculo URL: /documentation/manual_consignado_privado/manual_vinculos_empregaticios ## 1. Averbação nova contratação ### Máquina de estados de um contrato novo ![Máquina de estados de um contrato novo](/img/diagrams/manual-consignado-privado-manual-vinculos-empregaticios-1.svg) --- ### 1.1 Autorização Após a formalização de uma nova contratação de consignado privado, será criada a entidade reservation que é utilizada para acompanhar as tentativas de averbação do contrato na DATAPREV e a gestão da garantia após a averbação. No fluxo ativo, o ambiente pode ser configurado para que a averbação seja criada em um status pendente de autorização ou pode ser criada na fila de averbação, esta configuração deve ser alinhada com o time de operações. No fluxo de leilão a averbação sempre é criada pendente de autorização. Quando a averbação é criada com o status pending_requester_authorization, é enviado o webhook: webhook_type laas.private_payroll.reservation_status_change reservation_status pending_requester_authorization **Webhook Body** ```json { "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_status": "pending_requester_authorization" }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "pending_requester_authorization" } ``` Para autorizar a averbação, deve ser enviada a seguinte requisição: #### Request **PATCH** /private_payroll/reservation/external_key/ EXTERNAL-KEY /authorize Testar no Playground #### Response sucesso STATUS **200** **Response Body** ```json { "reservation_key": "", "document_number": "12345678901", "registration_number": "99999999999-A", "employer_document_number": "12345678901234", "external_key": "abc123def456", "contract_number": "2024001234", "inclusion_date": "2024-03-18", "disbursement_date": "2024-03-20", "contract_data": { "amount": 5000.00, "installments": 12, "interest_rate": 0.018 }, "reservation_data": { "installment_value": 500.00, "margin_value": 450.00 }, "reservation_status": "authorized" } ``` #### Response falha STATUS **400** **Response Body** **Operação não encontrada** ```json { "title" : "Reservation not found", "code" : "PRP000035", "description" : "The reservation was not found", "translation" : "A reserva não foi encontrada", } ``` **Averbação ainda não está pronta para autorização** ```json { "title" : "Reservation is not ready for authorization", "code" : "PRP000111", "description" : "The reservation is not ready for authorization", "translation" : "A reserva não está pronta para autorização" } ``` **Averbação já está autorizada** ```json { "title" : "Reservation is not pending requester authorization", "code" : "PRP000057", "description" : "The reservation is not pending requester authorization", "translation" : "A reserva não está pendente de autorização do requerente", } ``` ### 1.2 Averbação #### Sucesso na averbação Em caso de sucesso na averbação o parceiro receberá o seguinte webhook: webhook_type credit_operation.collateral collateral_constituted True **Webhook Body** ```json { "webhook": { "key": "", "data": { "collateral_data": {}, "collateral_type": "private_payroll", "collateral_constituted": true }, "event_time": "2025-07-10 02:15:01", "webhook_type": "credit_operation.collateral" } } ``` #### Falha na averbação Caso haja uma falha na averbação, será enviado um webhook com a crítica da DATAPREV. Os possíveis motivos de falha na averbação podem ser consultados na tabela [Motivo de falha na averbação](#fail_reservation_reason). Dependendo do erro de averbação, a QI manterá a proposta em "teimosinha" fazendo novas tentativas de averbação até que a operação seja cancelada manualmente ou por esgotar as opções de desembolso. WEBHOOK TYPE credit_operation.collateral collateral_constituted False **Webhook Body** ```json title="Webhook Body" { "key": "72926c65-35a5-4060-b5ec-af8661d8546a", "data": { "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "monthly_interest_rate_exceeds_active_proposal" } ] }, "last_response_event_datetime": "2025-10-10T19:45:39Z" }, "collateral_type": "private_payroll", "collateral_constituted": false }, "event_time": "2025-10-10 00:07:21", "webhook_type": "credit_operation.collateral" } ``` ## 2. Movimentação de vínculos A DATAPREV fornece um serviço de atualização de vínculos empregatícios que é consultado diariamente pela QI Tech, neste serviço são informados os contratos que foram encerrados por término de vínculo e os novos vínculos empregatícios dos tomadores que possuem contratos ativos. A partir das atualizações de desligamento, são disparados webhooks informando a mudança de status das averbações para o status "terminated": webhook_type laas.private_payroll.reservation_status_change reservation_status terminated **Webhook Body** ```json { "status": "terminated", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_key": "", "document_number": "12345678901", "reservation_status": "terminated", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "new_credit", } } ``` A partir das atualizações de novos vínculos, são disparados webhooks: webhook_type laas.private_payroll.new_employment_relationship status active **Webhook Body** ```json { "status": "active", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.new_employment_relationship", "data": { "document_number": "71742311016", "registration_number": "123456789ABCDEFR", "employer_document_number": "02302554000179", "status": "active", "employment_relationship_data": { "name": "LETYCIA AGUILAR DA SILVA", "eligible": true, "loan_count": 0, "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "admission_date": "2025-04-02", "total_due_amount": 1642.16, "base_margin_amount": 911.67, "political_exposition": "not_exposed", "worker_category_code": 101, "employer_document_type": "CNPJ", "available_margin_amount": 319.08 } } } ``` ## 3. Averbação revínculo ### Máquina de estados de um revínculo ![Máquina de estados de um revínculo](/img/diagrams/manual-consignado-privado-manual-vinculos-empregaticios-2.svg) --- ### 3.1 Autorização Semelhante ao fluxo de contratação de um novo empréstimo, é possível que a integração seja configurada para que todos os revínculos sejam criados pendente de autorização. Caso seja configurada para revincular automaticamente, ainda assim o casos onde o novo vínculo é informado pela DATAPREV com margem parcial, as novas averbações serão criadas no status pendente de autorização. Dependendo do status em que o revínculo foi criado, será enviado um webhook informando a criação da nova averbação e seu status (pending_requester_authorization ou pending_reservation): webhook_type laas.private_payroll.renewed_reservation reservation_status pending_requester_authorization/pending_reservation **Webhook Body** **Revínculo criado aguardando autorização** ```json { "status": "pending_requester_authorization", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.renewed_reservation", "data": { "reservation_key": "", "document_number": "12345678901", "reservation_status": "pending_requester_authorization", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "admission_date": "2025-04-02", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "transferred", } } ``` **Revínculo criado na fila para averbação** ```json { "status": "pending_reservation", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.renewed_reservation", "data": { "reservation_key": "", "document_number": "12345678901", "reservation_status": "pending_reservation", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "admission_date": "2025-04-02", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "transferred", } } ``` ### 3.2 Atualização da margem Para os casos onde o novo vínculo não tem margem consignável suficiente para averbar a parcela cheia do contrato, é obrigatório que seja realizada a autorização da averbação utilizando o mesmo endpoint de autorização da averbação de nova contratação. :::danger Uma vez autorizado o revínculo com margem parcial, não é possível alterar o valor da averbação posteriormente. Os valores que não forem averbados deverão ser cobrados diretamente do tomador. ::: **PATCH** /private_payroll/reservation/external_key/ EXTERNAL-KEY /authorize É possível atualizar o valor da nova averbação através de uma [consulta de dados](./manual_consultas_trabalhador#consulta-de-dados) no novo vínculo, este mecanismo é importante pois é possível que a primeira margem do novo vínculo informada pela DATAPREV seja parcial dependendo do período de contribuição da primeira competência. ### 3.3 Revínculo #### Sucesso Quando a nova reserva é averbada com sucesso, são enviados dois webhooks informando a alteração de status da averbação original para "transferred" e a alteração de status da nova reserva para "reserved". webhook_type laas.private_payroll.reservation_status_change reservation_status transferred **Webhook Body** ```json { "status": "transferred", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_key": "", "document_number": "12345678901", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "new_credit", "reservation_status": "transferred", "termination_date":null, "periods": [], "reason":null } } ``` webhook_type laas.private_payroll.reservation_status_change reservation_status reserved **Webhook Body** ```json { "status": "reserved", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_key": "", "document_number": "12345678901", "reservation_status": "reserved", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "transferred", "termination_date":null, "periods": [ { "amount": 339.06, "due_date": "2026-08-28", "installment_key": "", "installment_number": 1 }, { "amount": 339.06, "due_date": "2026-09-28", "installment_key": "", "installment_number": 2 }, { "amount": 339.06, "due_date": "2026-10-28", "installment_key": "", "installment_number": 3 } ], "reason": null, } } ``` #### Falha Diferente da averbação de crédito novo, caso haja uma falha no revínculo por margem excedida, a averbação irá retornar ao status de pendente de autorização. Nestes casos é possível que a margem consignável disponível para o revínculo tenha flutuado, sendo necessário uma nova nova [consulta de dados](./manual_consultas_trabalhador#consulta-de-dados) para reavaliar a reaverbação. webhook_type laas.private_payroll.reservation_status_change reservation_status pending_requester_authorization **Webhook Body** ```json { "status": "pending_requester_authorization", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_key": "", "document_number": "12345678901", "reservation_status": "pending_requester_authorization", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "transferred", "termination_date":null, "periods": [], "reason": { "enumerator": "margin_exceeded", "description": "Consignable margin exceeded", "translation": "Margem consignável excedida" } } } ``` Caso haja uma falha na averbação porque o vínculo empregatício não está mais disponível para reaverbação, a nova averbação será cancelada e não haverão mais tentativas. webhook_type laas.private_payroll.reservation_status_change reservation_status canceled **Webhook Body** ```json { "status": "pending_requester_authorization", "event_datetime": "2025-03-20T14:47:43Z", "key": "", "webhook_type": "laas.private_payroll.reservation_status_change", "data": { "reservation_key": "", "document_number": "12345678901", "reservation_status": "canceled", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "registration_number": "99999999999-A", "employer_name": "VIPER SERVICOS DO NORDESTE LTDA", "employer_document_number": "12345678901234", "external_key": "123e4567-e89b-12d3-a456-426614174000", "contract_number": "2024001234", "inclusion_date": "2025-04-02", "disbursement_date": "2025-04-05", "reservation_type": "transferred", "termination_date":null, "periods": [], "reason": { "enumerator": "employment_relationship_not_ineligible_due_to_previous_termination", "description": "Employment relationship is not ineligible due to loan closed by previous relationship termination", "translation": "Vínculo não está inelegível por empréstimo encerrado por término de vínculo anterior" }, } } ``` ## Anexos ### Motivo de falha na averbação crédito {#fail_reservation_reason} | Enumerador | Descrição | Ação QI |------------------------------------------ |------------------------------------------------------- |---------- | **monthly_interest_rate_exceeds_active_proposal** | Há uma proposta ativa no app da CTPS do tomador enviada pela QI com taxa inferior à da tentativa de averbação | Teimosinha | **margin_exceeded** | Margem consignável excedida | Teimosinha | **allowed_number_of_contracts_exceeded** | Quantidade máxima de contratos excedida | Cancelamento da operação | **employment_relationship_blocked** | Vínculo bloqueado pelo tomador (é possível desbloquear pelo app da CTPS) | Cancelamento da operação --- # Manual Consignado Privado - Portabilidade: Consultas Prévias URL: /documentation/manual_consignado_privado/portabilidade/consultas :::danger Consulta obrigatória antes da proposta Antes de digitar uma proposta de portabilidade, é **obrigatório** realizar uma **consulta de dados válida do trabalhador**. Sem uma consulta de dados concluída com sucesso, o pedido de averbação da portabilidade (e do refinanciamento) **não é criado**. Sempre faça a consulta antes de digitar a proposta. ::: São duas consultas, ambas assinadas com o **Termo de Autorização**: 1. **Consulta dos vínculos empregatícios** — `POST /private_payroll/employment_relationships_inquiry` 2. **Consulta de dados do trabalhador (saldo e margem consignável)** — `POST /private_payroll/balance_inquiry` :::info Estas consultas são documentadas em detalhe As duas consultas, o Termo de Autorização e os enumeradores de status (`employment_relationships_inquiry_status`, `balance_inquiry_status`) estão detalhados em **[Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador)**. Esta página mostra como elas se encaixam na jornada de portabilidade. A consulta de dados do trabalhador valida a elegibilidade, a margem consignável e os dados da conta de pagamento antes da digitação da proposta. ::: ## Onde a consulta entra no fluxo ``` 1. POST /private_payroll/employment_relationships_inquiry (vínculos + Termo de Autorização) 2. POST /private_payroll/balance_inquiry (margem consignável + Termo de Autorização) 3. POST /v2/credit_transfer/proposal (digitação da proposta de portabilidade) ``` A **consulta de dados do trabalhador (passo 2) deve ter sido concluída com sucesso antes do passo 3**. A proposta de portabilidade só deve ser digitada após a consulta retornar com sucesso — é ela que valida a margem consignável e habilita a averbação da operação. --- # Manual Consignado Privado - Portabilidade: Consultas e Operações Pós-Proposta URL: /documentation/manual_consignado_privado/portabilidade/consultas_pos_proposta ## Consulta de Lista de Participantes do CTC ENDPOINT /v2/credit_transfer/participants MÉTODO GET Testar no Playground **Resposta** **response.json** ```json [ { "name": "", "bank_code": "", "ispb": "" } ] ``` ## Recuperar resposta da última request O last response é uma forma de mapear, de forma simples e objetiva, a resposta da comunicação entre a QI e o empregador, possibilitando saber quando essa requisição foi feita e qual o retorno obtido (através de um enumerador). Os enumeradores estão divididos em duas formas: "errors" e "success". Cada enumerador tem uma descrição detalhada e o código de referência. Podemos conferir abaixo, com mais detalhes, como serão apresentados os dados do last response. ### Casos de sucesso #### Requisição ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /CREDIT-OPERATION-TYPE/collateral MÉTODO GET #### Path Params credit-operation-type | Enumerador | Descrição | |-------------------------------------------|--------------------------------| | refinancing_credit_operation | Operação de refinanciamento | | portability_credit_operation | Operação de portabilidade | #### Resposta Response Body ```json { "collateral_data": { "employer_document_number": "", "registration_number": "", "last_response": { "success": [ { "enumerator": "succesfully_included", "reservation_method": "portability" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z", "status": "reserved" }, "collateral_constituted": true, "collateral_type": "private_payroll" } ``` ### Detalhamento de campos no retorno da request | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código de resposta | [Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador)| | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ### Casos de erro #### Requisição ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /CREDIT-OPERATION-TYPE/collateral MÉTODO GET #### Resposta Response Body ```json { "collateral_constituted": false, "collateral_type": "type", "updated_at": "2023-05-24 19:13:02", "collateral_data": { "employer_document_number": "", "registration_number": "", "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "consignable_margin_exceeded", "reservation_method": "portability" }, { "enumerator": "consignable_margin_exceeded", "reservation_method": "new_credit" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z" } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código de resposta | [Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador) | | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ## Webhook de resposta da última tentativa de averbação Caso a operação não tenha sucesso na averbação na folha do empregador, a mesma ficará em retentativa e será enviado o seguinte webhook, detalhando o motivo da não averbação, o horário desta tentativa e o método de averbação utilizado. Trata-se da reserva de margem (averbação) na folha de pagamento de funcionários de empresas privadas. **Operação de portabilidade** WEBHOOK_TYPE credit_transfer.proposal.collateral ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "portability", "credit_operation_key": "", "collateral_type": "private_payroll", "collateral_constituted": false, "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "consignable_margin_exceeded" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z", "reservation_method": "new_credit" } } } ``` **Operação de refinanciamento** :::info Mesmo webhook da averbação de portabilidade A averbação do Refinanciamento (Troco) usa o **mesmo** `webhook_type` `credit_transfer.proposal.collateral` usado para a averbação da Portabilidade — a diferença está apenas no campo `data.credit_operation_type`, que aqui vem como `"refinancing"`. ::: WEBHOOK_TYPE credit_transfer.proposal.collateral ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "refinancing", "credit_operation_key": "", "collateral_type": "private_payroll", "collateral_constituted": false, "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "consignable_margin_exceeded" } ] }, "last_response_event_datetime": "2023-05-22T19:13:02Z", "reservation_method": "refinancing" } } } ``` ### Detalhamento de campos no webhook de falha | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | enumerator | Retorno mapeado do código de resposta | [Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador) | | reservation_method | Método de averbação da reserva | portability, new_credit, refinancing| ## Dados do contrato de origem Não existe um endpoint separado para "consultar" os dados do contrato de origem (banco credor original) depois da digitação — esses dados chegam automaticamente ao parceiro no webhook de **[`accepted`](/documentation/manual_consignado_privado/portabilidade/maquina_de_status#accepted)**, dentro de `data.original_contract`, assim que a instituição credora original informa o saldo devedor real (`final_due_balance`). O objeto traz, entre outros campos, o número e o ISPB do contrato de origem, a taxa e o CET do contrato original, o número de parcelas e a data da última parcela. :::info Consulta prévia (antes da proposta) A elegibilidade do trabalhador para a portabilidade — vínculo empregatício, contratos existentes na folha do empregador — é apurada nas **[Consultas Prévias](/documentation/manual_consignado_privado/portabilidade/consultas)**, obrigatórias antes da digitação da proposta. ::: ## Diminuir o valor das parcelas Este endpoint permite a redução do valor das parcelas de um contrato de portabilidade de crédito. Esta funcionalidade é especialmente útil em casos onde a margem consignável é excedida devido ao banco de origem desaverbar uma quantia menor do que a esperada. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /portability_credit_operation MÉTODO PUT **Requisição** **request.json** ```json { "installment_face_value": 382.18 } ``` **Resposta sucesso - HTTP 200** **response.json** ```json { "credit_operation_key": "7aa77bca-c724-4c1a-bfae-9b1b7bd81ab2", "contract_number": "0000000007/WO", "document_key": "045a8f35-6170-4112-8d83-29a753d0c78e", "document_url": "http://teste.com", "signed_url": "signed_url_test", "credit_operation_status": "waiting_signature", "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_accounts": [ { "account_digit": "3", "account_branch": "0001", "account_number": "94134", "ispb": "32402502", "name": "Wilker Teste", "document_number": "37197645832" } ], "disbursement_options": [ { "prefixed_interest_rate": { "annual_rate": 3.0, "daily_rate": 0.00385824, "interest_base": "calendar_days", "monthly_rate": 0.12246205 }, "total_iof": 7.03, "external_contract_fee_amount": 0.0, "external_contract_fees": [], "contract_fee_amount": 0.0, "number_of_installments": 3, "contract_fees": [], "disbursed_issue_amount": 1000.0, "issue_amount": 1007.03, "disbursement_date": "2022-08-24", "cet": 12.6, "annual_cet": 315.3944, "installments": [ { "business_due_date": "2022-08-30", "calendar_days": 5, "due_date": "2022-08-29", "due_principal": 1007.03, "installment_number": 1, "pre_fixed_amount": 84.43554587915118, "principal_amortization_amount": 297.73445412084885, "total_amount": 382.17, "workdays": 3 }, { "business_due_date": "2022-09-30", "calendar_days": 31, "due_date": "2022-09-29", "due_principal": 709.2955458791512, "installment_number": 2, "pre_fixed_amount": 47.97894031795043, "principal_amortization_amount": 334.19105968204957, "total_amount": 382.17, "workdays": 22 }, { "business_due_date": "2022-11-01", "calendar_days": 32, "due_date": "2022-10-31", "due_principal": 375.1044861971016, "installment_number": 3, "pre_fixed_amount": 7.055513802898396, "principal_amortization_amount": 375.1044861971016, "total_amount": 382.16, "workdays": 21 } ], "final_disbursement_amount": 997.87 } ], "final_disbursement_amount": 997.87, "collateral_is_constituted": false } ``` ## Incluir Fee na operação de portabilidade rebatido pela QI ao parceiro Para inclusão do fee, é necessário que a operação esteja averbada, desembolsada e que não esteja cedida. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /portability_credit_operation/rebate MÉTODO POST **Requisição** **request.json** ```json { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ``` **Resposta** **response.json** ```json {} ``` ## Recibo do pagamento de portabilidade (STR00047) Após o pagamento da portabilidade, é possível gerar o recibo da transação. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /receipt_str0047 MÉTODO POST **Requisição** **request.json** ```json {} ``` **Resposta** **response.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "receipt_url": "URL DO RECIBO", "receipt_document_key": "CHAVE DO RECIBO" } ``` --- # Manual Consignado Privado - Portabilidade: Enumeradores URL: /documentation/manual_consignado_privado/portabilidade/enumeradores ## Mapeamento de enumeradores Esta página reúne os enumeradores utilizados ao longo do fluxo de Portabilidade de Consignado Privado: `retention_reason`, `proposal_status`, `credit_operation_status` e `politically_exposed`. Os enumeradores relacionados à situação do trabalhador, à margem consignável e a bloqueios na folha de pagamento são apurados nas consultas prévias à proposta e estão detalhados no [Manual de Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador), que documenta `employment_relationships_inquiry_status` e `balance_inquiry_status`. ### Enumeradores Retention Reason {#retention_reason_enumerator} | Enumerador | Descrição | |------------------------------------------|--------------------------------------------------------| | **issuer_retention** | Retenção do Cliente | | **different_from_original** | Condições da proposta divergentes do contrato original | | **issuer_lawsuit** | Cliente com ação judicial | | **insurance_in_progress** | Indenização de seguro em andamento | | **collateral_in_execution** | Garantia em Execução | | **contract_not_found** | Contrato não encontrado | | **invalid_contract_type** | Tipo de contrato inválido | | **portability_in_progress** | Portabilidade em andamento | | **assigned_contract** | Contrato cedido | | **issuer_document_number_invalid** | CPF não é do contrato | | **unrelated_issuer_document_number** | CPF informado não é o do titular | | **assigned_without_co_obligation** | Contrato cedido sem coobrigação | | **fgts_in_use** | FGTS AMORTIZAR em uso | | **fgts_funding** | FGTS funding | | **portability_not_requested** | O cliente não solicitou a portabilidade | | **wrong_original_financial_institution** | IF Credora Original Incorreta | ### Enumeradores proposal_status {#proposal_status_enumerator} Os estados da Proposta de Portabilidade refletem as etapas do processo de portabilidade de crédito dentro do CTC (Central de Transferência de Crédito) da Núclea, desde a digitação até a liquidação. | Enumerador | Descrição | |-----------------------------------|-----------------------------------------------------------------------------------------------------------------| | pending_submission | Proposta criada e aguardando envio | | pending_response | Proposta digitada, recebida com sucesso pela QI e enviada para o CTC | | pending_acceptance | Proposta enviada/aceita pelo CTC, aguardando resposta de saldo devedor pela instituição credora original | | accepted | Instituição credora original retornou o saldo devedor e não reteve o crédito | | retained | Crédito retido pela instituição credora original | | settlement_sent | Liquidação enviada à instituição credora original | | pending_settlement_confirmation | Aguardando confirmação da liquidação | | paid | Proposta liquidada/paga | | rejected | Digitação da proposta rejeitada pelo CTC | | canceled | Proposta cancelada | ### Enumeradores credit_operation_status {#credit_operation_status_enumerator} | Enumerador | Descrição | |-------------------------------------------|---------------------------------------| | waiting_signature | Operação aguardando assinatura | | signed | Operação assinada | | issued | Operação emitida | | disbursed | Operação desembolsada | | settled | Operação liquidada | | canceled | Operação cancelada | | canceled_permanently | Operação cancelada permanentemente | ### Tabela de tipos de politicamente exposto {#politically_exposed_enumerator} | Enumerador | Descrição | |------------|-----------------------------------------------------| | 0 | Pessoa Não Exposta Politicamente | | 1 | Pessoa Exposta Politicamente - Nível 1 | --- ## Situação do trabalhador, margem e bloqueios A elegibilidade do trabalhador, a margem consignável e eventuais bloqueios da folha de pagamento são apurados nas consultas prévias à digitação da proposta. Os enumeradores correspondentes estão detalhados no [Manual de Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador). ### Retorno da averbação A averbação da operação ocorre junto ao empregador/folha de pagamento de funcionários de empresas privadas. As críticas associadas decorrem da consulta de vínculo empregatício e de saldo do trabalhador. ### Situação e status do vínculo empregatício Refletem a situação do vínculo empregatício do trabalhador junto ao empregador/folha de pagamento de funcionários de empresas privadas. Consulte os enumeradores de status de consulta no [Manual de Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador). ### Bloqueios do vínculo empregatício Bloqueios são tratados no contexto do vínculo empregatício do trabalhador. Consulte o detalhamento no [Manual de Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador) e no [Manual de Vínculos Empregatícios](/documentation/manual_consignado_privado/manual_vinculos_empregaticios). --- # Manual Consignado Privado - Portabilidade: Formalização URL: /documentation/manual_consignado_privado/portabilidade/formalizacao A formalização — coleta de documentos e assinatura dos contratos gerados na digitação da proposta — é realizada **integralmente pelo QI Sign**. :::info Formalização via QI Sign A QI Tech coleta os documentos do tomador e captura a assinatura no fluxo do QI Sign. O parceiro **não envia documentos** — nem no payload da proposta, nem por qualquer outro endpoint — e **não submete evidências de assinatura**. ::: O andamento da assinatura de cada operação (portabilidade e refinanciamento) é refletido no `credit_operation_status` (`waiting_signature → issued → ...`) e pode ser acompanhado em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). --- # Manual Consignado Privado - Portabilidade: Acompanhamento da Operação URL: /documentation/manual_consignado_privado/portabilidade/maquina_de_status ## Status da Proposta de Portabilidade Os estados da Proposta de Portabilidade refletem as etapas envolvidas no processo de portabilidade de crédito dentro do CTC (Central de Transferência de Crédito) da Núclea. Segue abaixo a descrição do fluxo e do significado de cada status envolvido em uma Proposta de Portabilidade, desde sua digitação até sua liquidação. ### pending_response Status da proposta após realização da digitação. Neste status a proposta foi recebida com sucesso pela QI e enviada para o CTC. #### rejected Caso a digitação da proposta seja rejeitada pelo CTC, será enviado um webhook com o motivo da rejeição: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS rejected **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "rejected", "event_datetime": "2022-11-24T15:42:12", "data": { "error": { "code": "ECTC0023", "reason": "Contrato com portabilidade em andamento" } } } ``` #### rejected reasons Caso a digitação da proposta seja rejeitada pelo CTC, será enviado um webhook com o motivo da rejeição: | reason | description | external_code | |------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| | portability_in_progress | Contrato com portabilidade em andamento | ECTC0023 | | portability_finished | Portabilidade já finalizada para o contrato informado | ECTC0028 | | portability_in_expiration_progress | Portabilidade não permitida. Contrato com portabilidade em situação de "Decurso de prazo" por não efetivação da portabilidade | ECTC0085 | | unexpected_error | Erro inesperado | ECTC9999 | | portability_payment_rejected | Pagamento de portabilidade rejeitado. | | | divergent_due_balance | Saldo devedor final deve ser menor que saldo devedor devolvido pela Núclea. | | ### pending_acceptance Status da Proposta após envio/aceite pelo CTC. A Proposta, neste momento, está aguardando resposta de saldo devedor pelo banco credor original. Neste momento é enviado um webhook com o número da Portabilidade no CTC: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS pending_acceptance **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "pending_acceptance", "event_datetime": "2022-11-24T15:42:12", "data": { "portability_number": "202211230000246536429", "inclusion_date": "2022-11-24", "due_balance_expected_return_date": "2022-12-01" } } ``` :::info O **“portability_number“** é o Número da Portabilidade dentro do CTC, e é o número utilizado pela instituição proponente e instituição credora original para localizar a Proposta de Portabilidade. ::: Assim que o banco credor original responder à solicitação de portabilidade, será enviado um webhook com a resposta do valor do saldo devedor no caso da não retenção, e com a informação de “retido”, no caso da retenção: #### accepted Status da Proposta quando o banco credor original retorna o saldo devedor e não retem o crédito. Será enviado um webhook com a informação do saldo devedor. O banco credor original tem até 5 d.u. após a recepção da Proposta de Portabilidade, para envio da resposta com a informação do saldo devedor da operação. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS accepted **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "accepted", "event_datetime": "2022-11-24T15:42:12", "data": { "final_due_balance": 1000, "portability_number": "202211230000246536429", "original_contract": { "origin_contract_number": "5584745", "origin_ispb_number": "60746948", "origin_document_number": "90406718261", "origin_operation_type": "0202", "installment_face_value": 1000, "total_iof": 1, "first_due_date": "2021-05-31", "last_due_date": "2022-05-31", "interest": 1, "cet": 1, "installment_number": 12, "amortization": 1, "final_due_balance": 1000, "final_due_date": "2021-08-31", "contract_date": "2021-04-31" } } } ``` Com a informação do saldo devedor retornado pela instituição credora original, o parceiro tomará a decisão se seguir ou não com a Portabilidade. :::info Horário limite para envio do saldo devedor pela instituição credora original é às 10:00. ::: :::info Saldo devedor real diferente do estimado na proposta O `final_due_balance` informado pela instituição credora original é validado contra o saldo devedor estimado enviado na proposta (`origin_contract.last_due_balance`): se o saldo real superar o estimado em mais de **15%**, a proposta é automaticamente rejeitada com o motivo `divergent_due_balance` (ver [rejected reasons](#rejected-reasons)). Dentro dessa tolerância, a proposta segue para `accepted` normalmente — mas as condições financeiras só são recalculadas com base no saldo real no momento do aceite (`PATCH .../accepted_by_requester` abaixo), não antes. ::: Após o recebimento do saldo devedor, caso o Parceiro decida seguir com a Proposta Portabilidade, ele deve realizar a seguinte chamada: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY MÉTODO PATCH Testar no Playground **Requisição** **request.json** ```json { "status": "accepted_by_requester" } ``` :::caution Atenção Para propostas que envolvam troco após o refinanciamento, o troco recalculado de acordo com as novas condições do contrato (após o retorno do saldo devedor) também precisa respeitar o piso mínimo — que é **escalonado pelo número de parcelas em aberto do contrato de origem** (5% para menos de 56 parcelas, 3% para 56 a 71, 2% para 72 ou mais; ver [Simulação](/documentation/manual_consignado_privado/portabilidade/simulacao)) em relação à diferença entre a soma de todas as parcelas do refinanciamento e a soma de todas as parcelas da portabilidade. Caso contrário, a requisição receberá o seguinte erro: STATUS 400 **Response Body** ```json { "code": "CT000118", "title": "Bad Request", "description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.", "translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00." } ``` ::: :::info Recálculo das condições com base no saldo devedor real Essa chamada (`accepted_by_requester`) recalcula a simulação da Portabilidade — e do Refinanciamento/Troco, se houver — usando o saldo devedor **real** (`final_due_balance`), e retorna as condições recalculadas na própria resposta (além dos webhooks de status). Duas garantias protegem o tomador nesse recálculo: - O valor da nova parcela não pode ultrapassar o valor da parcela do contrato de origem. - O valor do Troco recalculado não pode ser reduzido em mais de **10%** em relação ao Troco calculado na digitação/simulação original. ::: O Parceiro pode adicionar dados de novo valor de parcela ou nova taxa nessa chamada, caso queira alterá-los: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY MÉTODO PATCH **Requisição** **request.json** ```json { "status": "accepted_by_requester", "financial": { "installment_face_value": 100 } } ``` ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY MÉTODO PATCH **Requisição** **request.json** ```json { "status": "accepted_by_requester", "financial": { "monthly_interest_rate": 0.01 } } ``` :::info Campos adicionais opcionais Além dos campos `status` e `financial`, o endpoint de aceite da proposta também aceita os seguintes campos opcionais: - **`borrower.document_identification_type`** (string ou null): Tipo do documento de identificação - **`borrower.document_identification_number`** (string, máx. 16 caracteres): Número do documento de identificação - **`borrower.gender`** (string ou null): Gênero do tomador. Valores aceitos: `"male"`, `"female"` ou `null` ::: :::danger Atenção! Caso o valor da parcela seja maior que valor total disponível (valor da parcela do contrato de origem + margem consignável total disponível), será retornado o seguinte erro: ```json { "code": "SSC000059", "title": "Reservation amount greater than available total balance", "description": "The installment face value: 54.4 is greater than the available total balance (origin installment face value + available total balance):30.4. Available total balance: -20.0.", "translation": "O valor da parcela: 54.4 é maior que o valor total disponível (valor da parcela do contrato de origem + margem total disponível) : 30.4. Margem total diponível: -20.0." } ``` Ao receber esta crítica, é possível que uma nova chamada seja feita, alterando o valor da parcela para que ela se ajuste ao valor total disponível. Se o ajuste no valor da parcela não for feito até o horário limite para aceite do saldo devedor, será necessária uma nova digitação de proposta. ::: Caso o Parceiro decida por não prosseguir com a Proposta de Portabilidade, ele deve, **obrigatoriamente** realizar a seguinte chamada para informar a desistência da Portabilidade: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY MÉTODO DELETE Testar no Playground Após o envio do cancelamento da Proposta de Portabilidade ao CTC, será enviado um webhook de Proposta Cancelada: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS canceled **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_status": "canceled", "proposal_key": "", "event_datetime": "2022-11-24T15:42:12" } ``` :::info O comando de pagamento do saldo devedor (envio da liquidação) deve ser enviado até às 16:00. Não é possível retomar uma Proposta com status “canceled”. Caso a Proposta esteja com este status, será necessária a realização de uma nova digitação. ::: #### retained Status da Proposta quando o banco credor original retem o crédito, será enviado o webhook com a informação de retenção. O banco credor original do crédito tem até 5 d.u. após a recepção da Proposta de Portabilidade, para envio da resposta de retenção do crédito — o mesmo prazo aplicável ao envio do saldo devedor (ver [`accepted`](#accepted)). **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS retained **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "retained", "event_datetime": "2022-11-24T15:42:12", "data": { "retained_reason": { "reason": "issuer_retention", "description": "Retenção do Cliente" } } } ``` ### Detalhamento de campos no webhook de proposal | Campo | Descrição | Valores | |---------------------------|-------------------------------------|----------------------------------| | reason | lista dos motivos de retenção de uma Proposta | [Enumeradores](/documentation/manual_consignado_privado/portabilidade/enumeradores#retention_reason_enumerator) | ### accepted_by_requester Após aprovada pelo parceiro, a Proposta segue o fluxo interno da QI para liquidação. ### settlement_sent Após conclusão do fluxo interno da QI para liquidação da Proposta de Portabilidade o recurso para pagamento do saldo devedor é enviado ao credor original disparando o seguinte webhook para o Parceiro: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS settlement_sent **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "settlement_sent", "event_datetime": "2022-11-24T15:42:12", "data": { "receipt": { "amount": 1000, "timestamp": "2022-09-14 11:55:31", "description": "237 0001 1000093 1000093-3 59588111000103 - BCO BRADESCO S.A.", "ted_receipt_document_key": "a34e84a2-1628-4f23-8c11-2b2f4656ced1", "ted_receipt_url": "https://qitech.com.br/", "transaction_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf", "origin": { "account_key": "ed3e84a2-1628-4f23-8c11-2b2f4656cedf", "bank_code": "329", "branch": "0001", "branch_digit": null, "account_number": "1000361", "account_digit": "3", "type": "checking_account", "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "document": "32402502000135" }, "destination": { "bank_code": "237", "branch": "0001", "branch_digit": null, "account_number": "1000093", "account_digit": "3", "type": "checking_account", "name": "BCO BRADESCO S.A.", "document": "59588111000103", "purpose": "Saída Liquidação de Portabilidade" } } } } ``` Neste momento será iniciada averbação da Operação de Portabilidade na folha do empregador. O processo de averbação acontecerá em paralelo aos itens seguintes (itens 7.5., 7.5.1. e 7.5.2.) ### pending_settlement_confirmation Após a confirmação do envio dos recursos para pagamento do saldo devedor, é aguardada a confirmação da quitação do contrato por parte da Instituição Credora Original. Nesta etapa o Parceiro receberá o seguinte webhook: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS pending_settlement_confirmation **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "pending_settlement_confirmation", "event_datetime": "2022-11-24T15:42:12" } ``` :::info A confirmação da quitação do contrato é encaminhada pela Instituição Credora Original ao CTC e posteriormente encaminhado pelo CTC à QI. O SLA para confirmação da quitação da Portabilidade é de **2 d.u.** contados a partir do envio dos recursos para pagamento do saldo devedor do contrato original. ::: #### paid Assim que a QI receber do CTC a confirmação da quitação do Contrato Original, a Proposta constará como paga e a Portabilidade estará finalizada. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS paid **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "paid", "event_datetime": "2022-11-24T15:42:12" } ``` Nesta etapa, caso a averbação da Operação de Portabilidade já esteja concluída, a Operação de Refinanciamento (Troco), poderá ser iniciada (fluxo descrito no item 7). A notificação sobre a averbação da Operação de Portabilidade será enviada através do seguinte webhook: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.collateral **webhook.json** ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "portability", "credit_operation_key": "", "collateral_type": "private_payroll", "collateral_constituted": true, "collateral_data": { "reservation_method": "portability" } } } ``` data.collateral_data.reservation_method: [portability, new_credit ] #### rejected Caso o banco credor original rejeite a quitação do contrato, o recurso enviado para quitação do saldo devedor do contrato original será devolvido, e a proposta será finalizada. O parceiro receberá o webhook de **“rejected”**. **Webhook** - WEBHOOK_TYPE credit_transfer.proposal - STATUS rejected **webhook.json** ```json { "webhook_type": "credit_transfer.proposal", "proposal_key": "", "proposal_status": "rejected", "event_datetime": "2022-11-24T15:42:12", "data": { "error": { "code": "QCTC0001", "reason": "Pagamento de portabilidade rejeitado." } } } ``` Caso nesta etapa a Operação de Portabilidada já esteja averbada na folha do empregador, será realizada a desaverbação da margem. :::info Não é possível retomar uma Proposta com status “**rejected**”. É sempre necessário realizar uma nova digitação. ::: --- ## Status da Operação de Refinanciamento (Troco) No momento em que a Operação de Portabilidade é paga, o Parceiro pode optar por seguir com a Operação de Refinanciamento (Troco) ou não. #### Enumeradores credit_operation_status | Enumerador | Descrição | |-------------------------------------------|---------------------------------------| | waiting_signature | Operação aguardando assinatura | | signed | Operação assinada | | issued | Operação emitida | | disbursed | Operação desembolsada | | settled | Operação liquidada | | canceled | Operação cancelada | | canceled_permanently | Operação cancelada permanentemente | Para prosseguir com o Refinanciamento (Troco), o Parceiro deve realizar a seguinte chamada passando os campos 'Financial' e 'Disbursement Bank Accounts': *Adicionalmente, pode-se passar o campo 'purchaser_document_number' para alterar o cessionário da operação. ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation/acceptance MÉTODO POST Testar no Playground **Requisição** **request.json** ```json { "financial": { "installment_face_value": 379.87, "monthly_interest_rate": 0.0166, "number_of_installments": 84, "limit_days_to_disburse": 7, "disbursement_date": "2024-07-02", "rebates": [ { "rebate_bank_account": { "bank_code": "329", "account_digit": "9", "document_number": "18533555000164", "name": "Teste Ltda", "account_number": "4290002", "branch_number": "0001" }, "amount_type": "percentage", "fee_type": "spread", "amount": 9.5 }, { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "insurance_premium" } ] }, "disbursement_bank_accounts": [ { "document_number": "92093764000197", "branch_number": "0001", "name": "TESTE LTDA", "percentage_receivable": 100, "account_number": "120012", "account_digit": "3", "bank_code": "329" } ], "purchaser_document_number": "28534595027164" } ``` **Resposta** **response.json** ```json { "credit_operation_key": "", "contract_number": "00000002", "document_key": "", "document_url": "", "credit_operation_status": "issued", "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [ { "installments": [ { "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-08-09", "calendar_days": 53, "digitable_line": null, "due_date": "2021-08-08", "due_interest": 0, "due_principal": 997.87, "fine_amount": null, "has_interest": true, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "additional_costs": [], "bank_slip_key": null, "business_due_date": "2021-09-08", "calendar_days": 31, "digitable_line": null, "due_date": "2021-09-08", "due_interest": 0, "due_principal": 690.8886500498395, "fine_amount": null, "has_interest": true, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "installment_status": "created", "installment_type": "principal", "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "tax_amount": 0, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 50, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 997.87, "final_disbursement_amount": 100, "issue_amount": 1147.87, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 } ], "disbursement_bank_account": { "account_digit": "1", "account_number": "00001", "ispb": "00000000", "branch_number": "0001" } } ``` Caso o Parceiro opte por não prosseguir com a Operação de Refinanciamento (Troco), ele deve realizar a seguinte chamada: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation MÉTODO DELETE ### Averbação do Refinanciamento (Troco) Assim que o Parceiro optar por prosseguir com a Operação de Refinanciamento, a rotina para averbação da margem consignável terá início. Assim que a averbação da margem consignável na folha do empregador for concluída o parceiro recebera o seguinte webhook: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.collateral **webhook.json** ```json { "webhook_type": "credit_transfer.proposal.collateral", "proposal_key": "", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_type": "refinancing", "credit_operation_key": "", "collateral_type": "private_payroll", "collateral_constituted": true } } ``` ### Desembolso do Refinanciamento (Troco) Assim que a averbação da margem consignável na folha do empregador for concluída a operação estará pronta para desembolso. No desembolso da Operação de Refinanciamento, a Operação de Portabilidade será quitada e caso exista valor desembolsado remanescente (**7.1.1. “disbursement_options.final_disbursement_amount”**), este valor será liberado para o cliente (Troco) na conta para desembolso da Operação (**“disbursement_bank_account“**). A liberação do troco para o cliente pode ser realizada via PIX ou TED, em qualquer horário do dia (obedecendo horário comercial de 7:00 às 17:00 em dias úteis, no caso da TED). Caso o desembolso do troco para o cliente seja bem sucedido, será enviado um webhook com os dados da comprovação do desembolso: **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **webhook.json** ```json { "webhook_type": "credit_transfer.proposal.credit_operation", "proposal_key": "", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_status": "disbursed", "credit_operation_type": "refinancing", "credit_operation_key": "", "ted_receipt_list": [ { "fee": 0, "url": "https://qitech.com.br/", "amount": 500, "origin": { "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "type": "payment_account", "branch": "0001", "document": "32402502000135", "bank_code": "329", "account_key": "871059bd-4014-41ad-82b4-28275ff0e67b", "branch_digit": null, "account_digit": "5", "account_branch": "0001", "account_number": "00002" }, "timestamp": "2022-09-28T13:00:47", "description": "DESCRIPTION", "destination": { "name": "Elaine Isadora da Cruz", "type": "checking_account", "bank_code": "033", "branch": "0001", "purpose": "Crédito PIX em Conta", "document_number": "90406718261", "bank_ispb": "90400888", "branch_digit": null, "account_digit": "1", "account_number": "00001" }, "end_to_end_id": null, "transaction_key": "871059bd-4014-41ad-82b4-28275ff0e67b", "origin_transaction_key": null } ] } } ``` Caso ocorra falha no desembolso, o parceiro receberá o seguinte webhook: #### Falha no desembolso via PIX **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **webhook.json** ```json { "webhook_type": "credit_transfer.proposal.credit_operation", "proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999", "event_datetime": "2022-11-24T15:42:12", "data": { "credit_operation_status": "canceled", "credit_operation_type": "refinancing", "credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333", "pix_refusal": { "reason_enumerator": "invalid_document_number", "reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino." }, "cancel_reason": "pix_refusal" } } ``` #### Falha no desembolso via TED **Webhook** - WEBHOOK_TYPE credit_transfer.proposal.credit_operation **webhook.json** ```json { "webhook": { "data": { "cancel_reason": "Agência ou Conta Destinatária do Crédito Inválida", "credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333", "credit_operation_type": "refinancing", "credit_operation_status": "canceled", "cancel_reason_enumerator": "agencia_conta_invalida" }, "proposal_key": "60fbbfe2-eb52-4825-9ed5-f169a58b9999", "webhook_type": "credit_transfer.proposal.credit_operation", "event_datetime": "2023-12-22T10:15:25" } } ``` No caso de falha no desembolso da Operação, o desembolso pode ser retentato alterando-se os dados bancários: ENDPOINT /v2/credit_transfer/proposal/ PROPOSAL-KEY /refinancing_credit_operation MÉTODO PATCH Testar no Playground **Requisição** **request.json** ```json { "disbursement_date": "2022-11-04", "disbursement_bank_account": { "account_branch": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "document_number": "14950479032", "ispb": "17298092", "name": "Maria da Silva" } } ``` --- # Manual Consignado Privado - Portabilidade: Mocks e Sandbox URL: /documentation/manual_consignado_privado/portabilidade/mocks_sandbox :::danger Aviso Importante! Não utilize dados pessoais reais (CPF, CNPJ etc.) em ambiente sandbox. ::: ## Simulação de Cenários ### Portabilidade #### 1. Solicitação do Saldo Devedor Após a assinatura da operação de portabilidade, caso o cliente tenha configuração de envio manual, a proposta será criada com status "pending_submission" e somente após a chamada da rota a seguir, a solicitação do saldo devedor será feita. Caso a configuração seja de envio automático a proposta será criada com status "pending_response", ou seja, já está aguardando o retorno do saldo e não é necessário chamar esta rota. **Requisição** ENDPOINT /v2/credit_transfer/proposal/PROPOSAL-KEY MÉTODO PATCH **request.json** ```json { "status": "pending_response" } ``` #### 2. Aprovação pelo CTC A proposta deve estar em status "pending_response". **Requisição** ENDPOINT /mock/credit_transfer/ctc MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "proposal_creation_accepted" } ``` #### 3. Rejeição pelo CTC A proposta deve estar em status "pending_response". **Requisição** ENDPOINT /mock/credit_transfer/ctc MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "proposal_creation_refused" } ``` #### 4. Envio de saldo devedor pelo banco de origem A chamada de aprovação pelo CTC (**2**) deve ser enviada antes. A proposta deve estar em status "pending_acceptance". Após esta rota, receberá o webhook informando o saldo devedor atual da dívida e caso queira seguir com a operação deve chamar a rota apresentada no fluxo de aceite da proposta. **Requisição** ENDPOINT /mock/credit_transfer/ctc MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "proposal_approval", "due_balance": 9000, // Opcional, se não informado será enviado o valor usado na criação da proposta "installment_face_value": 300, // Opcional, se não informado será enviado o valor usado na criação da proposta "installment_number": 40, // Opcional, se não informado será enviado o valor usado na criação da proposta "opened_installment_number": 35, // Opcional, se não informado será enviado igual ao installment_number "overdue_installment_number": 5 // Opcional, se não informado será enviado 0 } ``` #### 5. Retenção pelo banco de origem A chamada de aprovação pelo CTC (**2**) deve ser enviada antes. A proposta deve estar em status "pending_acceptance" **Requisição** ENDPOINT /mock/credit_transfer/ctc MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "proposal_retention" } ``` #### 6. Devolução do pagamento pelo banco de origem Só pode ser enviado depois que a proposta for aceita e a operação de portabilidade desembolsada. Proposta deve estar em status "settlement_sent", "pending_settlement_confirmation" ou "paid". **Requisição** ENDPOINT /mock/credit_transfer/str MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "payment_rejected" } ``` #### 7. Confirmação de pagamento pelo CTC Proposta deve ter sido aceita e a operação de portabilidade desembolsada. Status deve ser "settlement_sent". **Requisição** ENDPOINT /mock/credit_transfer/ctc MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "settlement_confirmation" } ``` #### 8. Confirmação de pagamento pelo banco de origem Deve ser chamado após a confirmação de pagamento pelo CTC (**7**). Proposta deve estar em status "pending_settlement_confirmation". **Requisição** ENDPOINT /mock/credit_transfer/ctc MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "payment_confirmation" } ``` #### 9. Averbação de garantia Proposta deve estar em status "pending_settlement_confirmation" ou "paid", após **7** ou **8**. **Requisição** ENDPOINT /mock/credit_transfer/collateral MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "credit_operation_type": "portability", "collateral_constituted": true } ``` ### Refinanciamento #### 10. Averbação de garantia Proposta deve estar em status "paid" ou "pending_settlement_confirmation" com garantia de portabilidade averbada e o refinanciamento deve ter sido aceito. **Requisição** ENDPOINT /mock/credit_transfer/collateral MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "credit_operation_type": "refinancing", "collateral_constituted": true } ``` #### 11. Falha na averbação de garantia Proposta deve estar em status "paid" ou "pending_settlement_confirmation" com garantia de portabilidade averbada e o refinanciamento deve ter sido aceito. **Requisição** ENDPOINT /mock/credit_transfer/collateral MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "credit_operation_type": "refinancing", "collateral_constituted": false } ``` #### 12. Falha no desembolso Operação de refinanciamento deve ter sido desembolsada. **Requisição** ENDPOINT /mock/credit_transfer/disbursement MÉTODO POST **request.json** ```json { "proposal_key": "CHAVE DA PROPOSTA", "event_type": "disbursement_failed" } ``` --- # Manual Consignado Privado - Portabilidade: Digitação da Proposta URL: /documentation/manual_consignado_privado/portabilidade/proposta A digitação da proposta cria a operação de **portabilidade** e, opcionalmente, a operação de **refinanciamento** (Troco) na mesma requisição, por meio do endpoint `POST /v2/credit_transfer/proposal`. ENDPOINT /v2/credit_transfer/proposal MÉTODO POST Testar no Playground :::caution Atenção Para que os pedidos de averbação, tanto da portabilidade quanto do refinanciamento, sejam criados com sucesso, é preciso que uma **consulta de dados válida do trabalhador** tenha sido feita **previamente**. Siga os passos de [Consultas Prévias](/documentation/manual_consignado_privado/portabilidade/consultas). ::: ## Estrutura da requisição A requisição é composta por alguns campos no nível raiz e pelos objetos da operação. A estrutura geral é a seguinte — cada objeto é detalhado nas seções abaixo: ```json title='Estrutura geral' { "proposal_type": "private_company", "purchaser_document_number": "32402502000135", "borrower": , "related_parties": [ /* representante legal, quando houver */ ], "collaterals": [ /* garantia: folha de pagamento */ ], "portability_credit_operation": , "refinancing_credit_operation": , "origin_contract": , "additional_data": {} } ``` | Campo (raiz) | Tipo | Obrigatório | Descrição | |---|---|---|---| | `proposal_type` | string | ✅ | `"private_company"` para Consignado Privado. | | `purchaser_document_number` | string | ✅ | CNPJ do comprador da operação. | | `additional_data` | object | — | Dados complementares da operação. | :::info Portabilidade sem refinanciamento Para uma **portabilidade pura**, sem liberação de Troco, omita o objeto `refinancing_credit_operation`, mantendo `portability_credit_operation` e `origin_contract`. ::: ### `borrower` — dados do tomador Dados cadastrais do tomador do crédito. Ver objeto compartilhado [Borrower](/documentation/objetos_compartilhados/borrower). Os documentos do tomador **não são enviados na proposta** — a formalização é feita via QI Sign. Ver [Formalização](/documentation/manual_consignado_privado/portabilidade/formalizacao). ```json { "person_type": "natural", "name": "Marilene da Silva", "mother_name": "Maria Mariane", "birth_date": "1990-05-06", "profession": "Desenvolvedora", "nationality": "Brasileira", "marital_status": "single", "is_pep": false, "individual_document_number": "20676928013", "document_identification_number": "381803326", // obrigatório "document_identification_type": "rg", // obrigatório — rg | cnh | cin "document_identification_date": "2019-01-28", "email": "marilene@email.com", "phone": { "country_code": "055", "area_code": "11", "number": "912828135" }, "address": { "street": "Passagem Mariana", "state": "PA", "city": "Ananindeua", "neighborhood": "Águas Lindas", "number": "660", "postal_code": "67118003", "complement": "complemento" } } ``` :::danger Documento de identificação obrigatório (a partir de 03/08/2026) A Núclea passará a exigir o documento de identificação do tomador no registro da portabilidade a partir de **06/08/2026**. Por isso, a partir de **segunda-feira, 03/08/2026**, `borrower.document_identification_type` e `borrower.document_identification_number` passam a ser **obrigatórios** na digitação da proposta — propostas sem esses campos retornam erro. Quando `document_identification_type` for `cin`, o `document_identification_number` **pode** ser igual ao `individual_document_number` (CPF), já que a CIN usa o número do CPF. Para os demais tipos (`rg`, `cnh`), enviar o CPF em `document_identification_number` retorna erro. ::: | Campo (`borrower`) | Tipo | Obrigatório | Descrição | |---|---|---|---| | `person_type` | string | ✅ | `natural`. | | `individual_document_number` | string | ✅ | CPF do tomador (11 dígitos, sem pontuação). | | `document_identification_type` | string | ✅ | Tipo do documento de identificação. Valores: `rg`, `cnh`, `cin`. | | `document_identification_number` | string (máx. 16) | ✅ | Número do documento informado em `document_identification_type`. Igual ao CPF **somente** quando o tipo for `cin`. | | `document_identification_date` | string | — | Data de emissão do documento (`YYYY-MM-DD`). | ### `related_parties` — representante legal (opcional) Envie esta lista **apenas** quando a operação tem representante legal. Cada item deve conter os dados cadastrais do representante e o campo `role_type` com o valor `issuer_legal_representative`. ```json [ { "name": "Nome Representante Legal", "email": "email@email.com.br", "birth_date": "2000-12-12", "is_pep": false, "mother_name": "maria", "phone": { "number": "991294043", "area_code": "11", "country_code": "055" }, "address": { "street": "Avenida das Castanheiras", "state": "SP", "city": "Brasília", "neighborhood": "bairro", "number": "12", "postal_code": "71900100", "complement": "" }, "role_type": "issuer_legal_representative", "person_type": "natural", "individual_document_number": "45102538004", "document_identification_type": "rg", "document_identification_number": "123456789" } ] ``` ### `collaterals` — garantia (folha de pagamento) A garantia é a folha de pagamento de funcionários de empresas privadas. O `collateral_data` carrega o CNPJ do empregador e a matrícula do trabalhador. ```json [ { "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "", "registration_number": "" } } ] ``` ### `portability_credit_operation` — operação portada Operação que assume (porta) o contrato de origem. Informe sempre `number_of_installments` e **uma** entre `monthly_interest_rate` ou `installment_face_value`. ```json { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 }, "contract_number": "300523588PF" } ``` ### `refinancing_credit_operation` — Troco (opcional) Operação que quita a portabilidade e libera o Troco na conta do trabalhador. Como o refinanciamento **não tem data de desembolso fixa**, a mudança na data de desembolso altera os valores da operação — por isso é necessário fixar **a taxa** (`monthly_interest_rate`) **ou** o **valor liberado** ao cliente (`disbursed_amount`). A única diferença entre as duas formas está no objeto `financial`; `disbursement_bank_account` (conta de destino do Troco) e `contract_number` são iguais nos dois casos. **Fixando a taxa** ```json { "financial": { "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "000059923", "ispb": "341", "bank_code": "341", "branch_number": "0155" }, "contract_number": "200523588PK" } ``` **Fixando o valor liberado** ```json { "financial": { "disbursed_amount": 1000, "installment_face_value": 100, "number_of_installments": 10 }, "disbursement_bank_account": { "account_digit": "1", "account_number": "000059923", "ispb": "341", "bank_code": "341", "branch_number": "0155" }, "contract_number": "200523588PK" } ``` ### `origin_contract` — contrato de origem Identifica a dívida na instituição credora original. ```json { "ispb": "60746948", "contract_number": "558472", "last_due_balance": 997.87 } ``` :::info ISPB do credor original O `origin_contract.ispb` é o **ISPB** da instituição credora original (a base do CNPJ da instituição). A lista completa de ISPBs das instituições participantes da CTC pode ser obtida pelo endpoint de [consulta de participantes do CTC](/documentation/manual_consignado_privado/portabilidade/consultas_pos_proposta). ::: ### Campos das operações | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `collaterals[].collateral_type` | string | ✅ | `"private_payroll"`. | | `collaterals[].collateral_data.employer_document_number` | string | ✅ | CNPJ do empregador. | | `collaterals[].collateral_data.registration_number` | string | ✅ | Matrícula do trabalhador na folha do empregador. | | `portability_credit_operation.financial.number_of_installments` | integer | ✅ | Número de parcelas. | | `portability_credit_operation.financial.monthly_interest_rate` / `installment_face_value` | number | ✅ | Enviar **uma** das duas. | | `portability_credit_operation.contract_number` | string | ✅ | Número do contrato de portabilidade gerado. | | `refinancing_credit_operation.financial` | object | ⚠️ | Necessário quando há Troco. Fixar `monthly_interest_rate` (taxa) **ou** `disbursed_amount` (valor liberado). | | `refinancing_credit_operation.disbursement_bank_account` | object | ⚠️ | Conta de destino do Troco. | | `origin_contract.ispb` | string | ✅ | ISPB do credor original (base do CNPJ). | | `origin_contract.contract_number` | string | ✅ | Número do contrato na instituição de origem. | | `origin_contract.last_due_balance` | number | ✅ | Saldo devedor do contrato de origem. | ## Response A criação da proposta retorna a `proposal_key` e, dentro de `borrower` e de cada item de `related_parties`, a `related_party_key` (identificador de cada parte na proposta). **Response Body (resumido)** ```json { "proposal_key": "", "status": "pending_submission", "borrower": { "name": "Marilene da Silva", "individual_document_number": "20676928013", "role_type": "issuer", "related_party_key": "511d7186-3c17-4f35-8887-c4aefaf270be" }, "collaterals": [ { "collateral_type": "private_payroll", "collateral_data": { "employer_document_number": "", "registration_number": "" } } ], "portability_credit_operation": { "contract_number": "300523588PF" }, "refinancing_credit_operation": { "contract_number": "200523588PK" }, "origin_contract": { "ispb": "60746948", "contract_number": "558472", "last_due_balance": 997.87 } } ``` :::info Recuperar dados de uma proposta Em casos de timeout ou operação duplicada, é possível recuperar os dados de uma proposta enviando a `requester_control_key` no lugar da `proposal_key`. Ver [Consultas e Operações Pós-Proposta](/documentation/manual_consignado_privado/portabilidade/consultas_pos_proposta). ::: ## Correção de dados Após a digitação, dados da proposta podem ser corrigidos antes do avanço do fluxo — para a operação de refinanciamento, para a portabilidade, ou para ambas. Dependendo do dado alterado, pode ser necessária uma **nova assinatura da CCB**. As transições e o endpoint de atualização (`PATCH /v2/credit_transfer/proposal/{PROPOSAL-KEY}`) estão detalhados em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). --- # Manual Consignado Privado - Portabilidade: Simulação URL: /documentation/manual_consignado_privado/portabilidade/simulacao A simulação retorna as condições financeiras da operação — cronograma de parcelas, CET e o valor do Troco — **antes da digitação da proposta** e sem precisar coletar os dados cadastrais do cliente. Use-a para validar taxas, número de parcelas e o Troco com o trabalhador. ENDPOINT /v2/credit_transfer/proposal_simulation MÉTODO POST Testar no Playground :::caution Troco mínimo escalonado pelo número de parcelas em aberto Em propostas com Troco, o valor do Troco precisa corresponder a um percentual mínimo da diferença entre a soma das parcelas do refinanciamento e a soma das parcelas da portabilidade. Esse percentual mínimo **diminui conforme o número de parcelas em aberto do contrato de origem** (`origin_contract`): | Parcelas em aberto do contrato de origem | Troco mínimo | |---|---| | Menos de 56 | **5%** | | De 56 a 71 | **3%** | | 72 ou mais | **2%** | Caso o Troco calculado fique abaixo do piso aplicável, a requisição retorna o erro **400**: STATUS 400 **Response Body** ```json { "code": "CT000118", "title": "Bad Request", "description": "The final disbursement amount is less than 5% of the sum of refinancing installment minus the sum of portability installment. The minimum final disbursement amount allowed is 500.00. Calculated final disbursement amount: 400.00.", "translation": "O valor do troco é menor que 5% da soma do valor das parcelas do refinanciamento menos o valor soma das parcelas da portabilidade. O valor mínimo do troco permitido é de 500.00. Valor calculado do troco: 400.00." } ``` ::: ## Portabilidade com Refinanciamento Simula a portabilidade e o refinanciamento (Troco) na mesma requisição, retornando as condições das duas operações. ### Requisição O corpo contém apenas os dados mínimos da simulação. Assim como na [Digitação da Proposta](/documentation/manual_consignado_privado/portabilidade/proposta), a diferença entre os dois modos está em como o refinanciamento é fixado — pela **taxa** (`monthly_interest_rate`) ou pelo **valor liberado** ao cliente (`disbursed_amount`): **Fixando a taxa** ```json { "borrower": { "person_type": "natural" }, "collaterals": [ { "collateral_type": "private_payroll" } ], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "number_of_installments": 10 } }, "refinancing_credit_operation": { "financial": { "days_to_accrual": 0, "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 } }, "origin_contract": { "last_due_balance": 997.87 } } ``` **Fixando o valor liberado** ```json { "borrower": { "person_type": "natural" }, "collaterals": [ { "collateral_type": "private_payroll" } ], "portability_credit_operation": { "financial": { "installment_face_value": 100, "number_of_installments": 10 } }, "refinancing_credit_operation": { "financial": { "days_to_accrual": 0, "disbursed_amount": 1000, "installment_face_value": 100, "number_of_installments": 10 } }, "origin_contract": { "last_due_balance": 997.87 } } ``` ### Resposta A resposta retorna **6 campos** no nível raiz: três identificadores da proposta e três objetos com os detalhes do tomador e das operações. ```json title='Estrutura da resposta' { "proposal_key": "...", /* chave única da proposta */ "proposal_number": "...", /* número da proposta */ "proposal_status": "pending_submission", /* status atual da proposta */ "borrower": , "portability_credit_operation": , "refinancing_credit_operation": } ``` | Campo | Tipo | Descrição | |---|---|---| | `proposal_key` | string | Chave única da proposta. | | `proposal_number` | string | Número da proposta. | | `proposal_status` | string | Status atual da proposta (ex.: `pending_submission`). | | `borrower` | object | Dados do tomador, incluindo a `related_party_key` usada no envio de documentos. | | `portability_credit_operation` | object | Condições da operação de portabilidade: `disbursement_options` com o cronograma de `installments`, as taxas (`cet`, `annual_cet`, `prefixed_interest_rate`) e o `issue_amount`. | | `refinancing_credit_operation` | object | Condições do refinanciamento (Troco). O valor do Troco aparece em `final_disbursement_amount`. | Exemplo completo da resposta: **response.json** ```json { "proposal_key": "28a925f6-570e-4724-9132-3bd42f267c4f", "proposal_number": "17032788499215403", "proposal_status": "pending_submission", "borrower": { "individual_document_number": "98765432100", "related_party_key": "fa55dca3-3147-45d2-bb8d-941f2d7191da", "role_type": "issuer" }, "portability_credit_operation": { "credit_operation_key": "a66675e6-bdc2-4468-8420-2889d5cec0a8", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.173044, "cet": 0.0134, "contract_fee_amount": 0.0, "contract_fees": [ { "amount": 0.5, "amount_type": "percentage", "fee_amount": 0.0, "fee_type": "tac" } ], "disbursed_issue_amount": 997.87, "disbursement_date": "2023-12-22", "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": "spread", "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": "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": "insurance_premium", "irrf_amount": 0, "net_fee_amount": 0.0, "pis_amount": 0, "tax_amount": 0.0 } ], "installments": [ { "business_due_date": "2024-02-22", "calendar_days": 62, "due_date": "2024-02-22", "due_principal": 997.87, "installment_number": 1, "pre_fixed_amount": 27.413791524708554, "principal_amortization_amount": 81.34620847529145, "total_amount": 108.76, "workdays": 40 }, { "business_due_date": "2024-03-22", "calendar_days": 29, "due_date": "2024-03-22", "due_principal": 916.5237915247086, "installment_number": 2, "pre_fixed_amount": 11.692366920719124, "principal_amortization_amount": 97.06763307928088, "total_amount": 108.76, "workdays": 21 }, { "business_due_date": "2024-04-22", "calendar_days": 31, "due_date": "2024-04-22", "due_principal": 819.4561584454277, "installment_number": 3, "pre_fixed_amount": 11.179911547915339, "principal_amortization_amount": 97.58008845208467, "total_amount": 108.76, "workdays": 20 }, { "business_due_date": "2024-05-22", "calendar_days": 30, "due_date": "2024-05-22", "due_principal": 721.876069993343, "installment_number": 4, "pre_fixed_amount": 9.5288330736045, "principal_amortization_amount": 99.2311669263955, "total_amount": 108.76, "workdays": 21 }, { "business_due_date": "2024-06-24", "calendar_days": 33, "due_date": "2024-06-24", "due_principal": 622.6449030669476, "installment_number": 5, "pre_fixed_amount": 9.046812945831448, "principal_amortization_amount": 99.71318705416856, "total_amount": 108.76, "workdays": 22 }, { "business_due_date": "2024-07-22", "calendar_days": 28, "due_date": "2024-07-22", "due_principal": 522.9317160127789, "installment_number": 6, "pre_fixed_amount": 6.439743824282488, "principal_amortization_amount": 102.32025617571752, "total_amount": 108.76, "workdays": 20 }, { "business_due_date": "2024-08-22", "calendar_days": 31, "due_date": "2024-08-22", "due_principal": 420.61145983706143, "installment_number": 7, "pre_fixed_amount": 5.738438681013405, "principal_amortization_amount": 103.0215613189866, "total_amount": 108.76, "workdays": 23 }, { "business_due_date": "2024-09-23", "calendar_days": 32, "due_date": "2024-09-23", "due_principal": 317.58989851807485, "installment_number": 8, "pre_fixed_amount": 4.473657660291388, "principal_amortization_amount": 104.28634233970861, "total_amount": 108.76, "workdays": 22 }, { "business_due_date": "2024-10-22", "calendar_days": 29, "due_date": "2024-10-22", "due_principal": 213.30355617836625, "installment_number": 9, "pre_fixed_amount": 2.721176981322744, "principal_amortization_amount": 106.03882301867725, "total_amount": 108.76, "workdays": 21 }, { "business_due_date": "2024-11-22", "calendar_days": 31, "due_date": "2024-11-22", "due_principal": 107.26473315968899, "installment_number": 10, "pre_fixed_amount": 1.4934220715493307, "principal_amortization_amount": 107.26657792845067, "total_amount": 108.76, "workdays": 22 } ], "issue_amount": 997.87, "number_of_installments": 10, "prefixed_interest_rate": { "annual_rate": 0.17042118, "daily_rate": 0.00043722, "interest_base": "calendar_days", "monthly_rate": 0.0132 }, "total_iof": 0.0 } ], "final_disbursement_amount": 0.0 }, "refinancing_credit_operation": { "credit_operation_key": "aaf9abe0-2b8a-4688-8e09-413e1bd5285e", "credit_operation_status": "waiting_signature", "disbursement_accounts": [], "disbursement_options": [ { "annual_cet": 0.172031, "cet": 0.0133, "contract_fee_amount": -0.4, "contract_fees": [ { "amount": 0.5, "amount_type": "percentage", "fee_amount": -0.4, "fee_type": "tac" } ], "disbursed_issue_amount": 918.04, "disbursement_date": "2023-12-22", "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": "spread", "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": "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": "insurance_premium", "irrf_amount": 0, "net_fee_amount": 0.0, "pis_amount": 0, "tax_amount": 0.0 } ], "installments": [ { "business_due_date": "2024-02-22", "calendar_days": 62, "due_date": "2024-02-22", "due_principal": 917.64, "installment_number": 1, "pre_fixed_amount": 25.2095730147, "principal_amortization_amount": 74.7904269853, "total_amount": 100.0, "workdays": 40 }, { "business_due_date": "2024-03-22", "calendar_days": 29, "due_date": "2024-03-22", "due_principal": 842.8495730147, "installment_number": 2, "pre_fixed_amount": 10.7524369787, "principal_amortization_amount": 89.2475630213, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-04-22", "calendar_days": 31, "due_date": "2024-04-22", "due_principal": 753.6020099934, "installment_number": 3, "pre_fixed_amount": 10.2814172859, "principal_amortization_amount": 89.7185827141, "total_amount": 100.0, "workdays": 20 }, { "business_due_date": "2024-05-22", "calendar_days": 30, "due_date": "2024-05-22", "due_principal": 663.8834272793, "installment_number": 4, "pre_fixed_amount": 8.7632941742, "principal_amortization_amount": 91.2367058258, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-06-24", "calendar_days": 31, "due_date": "2024-06-22", "due_principal": 572.6467214535, "installment_number": 5, "pre_fixed_amount": 7.8126464787, "principal_amortization_amount": 92.1873535213, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-07-22", "calendar_days": 30, "due_date": "2024-07-22", "due_principal": 480.4593679322, "installment_number": 6, "pre_fixed_amount": 6.3420966342, "principal_amortization_amount": 93.6579033658, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-08-22", "calendar_days": 31, "due_date": "2024-08-22", "due_principal": 386.8014645664, "installment_number": 7, "pre_fixed_amount": 5.2771618926, "principal_amortization_amount": 94.7228381074, "total_amount": 100.0, "workdays": 23 }, { "business_due_date": "2024-09-23", "calendar_days": 31, "due_date": "2024-09-22", "due_principal": 292.078626459, "installment_number": 8, "pre_fixed_amount": 3.9848593609, "principal_amortization_amount": 96.0151406391, "total_amount": 100.0, "workdays": 21 }, { "business_due_date": "2024-10-22", "calendar_days": 30, "due_date": "2024-10-22", "due_principal": 196.0634858199, "installment_number": 9, "pre_fixed_amount": 2.5880710578, "principal_amortization_amount": 97.4119289422, "total_amount": 100.0, "workdays": 22 }, { "business_due_date": "2024-11-22", "calendar_days": 31, "due_date": "2024-11-22", "due_principal": 98.6515568777, "installment_number": 10, "pre_fixed_amount": 1.3459361963, "principal_amortization_amount": 98.6540638037, "total_amount": 100.0, "workdays": 22 } ], "issue_amount": 917.64, "number_of_installments": 10, "prefixed_interest_rate": { "annual_rate": 0.17042118, "daily_rate": 0.00043722, "interest_base": "calendar_days", "monthly_rate": 0.0132 }, "total_iof": 0.0 } ], "final_disbursement_amount": -79.83 } } ``` ## Portabilidade pura Para simular uma portabilidade sem liberação de Troco, envie apenas `portability_credit_operation` — sem o objeto `refinancing_credit_operation`. **Requisição** **request.json** ```json { "borrower": { "person_type": "natural" }, "collaterals": [ { "collateral_type": "private_payroll" } ], "portability_credit_operation": { "financial": { "monthly_interest_rate": 0.0132, "installment_face_value": 100, "number_of_installments": 10 } }, "origin_contract": { "last_due_balance": 997.87 } } ``` **Resposta** **response.json** ```json { "portability_credit_operation": { "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 }, "disbursement_options": [ { "installments": [ { "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-08-09", "calendar_days": 53, "due_date": "2021-08-08", "due_principal": 997.87, "installment_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036", "installment_number": 1, "pre_fixed_amount": 54.84865004983954, "principal_amortization_amount": 306.98134995016045, "total_amount": 361.83, "workdays": 37 }, { "bank_slip_key": null, "digitable_line": null, "business_due_date": "2021-09-08", "calendar_days": 31, "due_date": "2021-09-08", "due_principal": 690.89, "installment_key": "e8406cdb-844c-4e6d-9620-3635fab9d8d1", "installment_number": 2, "pre_fixed_amount": 21.964874249804833, "principal_amortization_amount": 339.86512575019515, "total_amount": 361.83, "workdays": 22 } ], "prefixed_interest_rate": { "annual_rate": 0.44556431, "daily_rate": 0.00564312, "monthly_rate": 0.0556431, "interest_base": "calendar_days_365" }, "iof_amount": 0, "external_contract_fee_amount": 0, "external_contract_fees": [], "contract_fee_amount": 0, "contract_fees": [], "number_of_installments": 2, "disbursed_issue_amount": 1000, "issue_amount": 1000, "disbursement_date": "2021-05-31", "cet": 1.212, "annual_cet": 32.122 } ] } } ``` --- # Manual Consignado Privado - Portabilidade + Refinanciamento URL: /documentation/manual_consignado_privado/portabilidade/visao_geral Este manual documenta o fluxo de **portabilidade de crédito consignado privado**: a compra de uma dívida consignada originada em outra instituição, com a opção de, ao final, liberar mais crédito ao trabalhador (o **Troco**) por meio de uma operação de refinanciamento. A proposta de portabilidade é digitada no endpoint `POST /v2/credit_transfer/proposal` e processada junto à **CTC** (Central de Transferência de Crédito, operada pela Núclea). A garantia da operação é a folha de pagamento de funcionários de empresas privadas (`collateral_type: "private_payroll"`), averbada junto ao empregador. Além do passo a passo de integração, esta página descreve o **fluxo de negócio** por trás da portabilidade — como funciona a comunicação com a instituição credora original através da CTC, os prazos e retornos possíveis, e o que fazer quando o saldo devedor real diverge do saldo estimado no início do fluxo. Use-a como referência para desenhar a esteira de emissão do seu produto. ## Quando usar Use a portabilidade quando o trabalhador já possui um contrato de consignado privado em **outra instituição** e deseja transferir essa dívida para a sua operação. Dois cenários: - **Portabilidade pura** — assume a dívida de origem nas novas condições, sem liberar caixa adicional. - **Portabilidade + Refinanciamento (com Troco)** — assume a dívida de origem e, na mesma proposta, refinancia a operação liberando um valor adicional (Troco) ao trabalhador. A proposta de portabilidade e a de refinanciamento são geradas na **mesma requisição**. ## Composição da operação Uma proposta de portabilidade é montada com até três blocos, além dos dados cadastrais do tomador: | Bloco | Campo no payload | Papel | |---|---|---| | **Garantia** | `collaterals[].collateral_type: "private_payroll"` | Folha de pagamento de funcionários de empresas privadas (averbação junto ao empregador). `collateral_data` carrega `employer_document_number` e `registration_number`. | | **Portabilidade** | `portability_credit_operation` | Operação que assume (porta) o contrato de origem. Informa `number_of_installments` e **uma** entre `monthly_interest_rate` ou `installment_face_value`. | | **Refinanciamento (Troco)** | `refinancing_credit_operation` | Opcional. Quita a operação de portabilidade e libera o Troco na conta do trabalhador. Carrega `disbursement_bank_account`. | | **Contrato de origem** | `origin_contract` | Identifica a dívida na instituição credora original: `ispb`, `contract_number`, `last_due_balance`. | ## Como funciona a portabilidade na CTC/Núclea A portabilidade não é uma transação direta entre a QI Tech e o banco onde o trabalhador tem a dívida hoje — toda a comunicação passa por uma câmara centralizadora, e envolve prazos e decisões de terceiros que o parceiro precisa entender para desenhar sua esteira corretamente. ### Os papéis envolvidos | Papel | Quem é | |---|---| | **Instituição Proponente** | A QI Tech, atuando em nome do parceiro — é quem está "comprando" a dívida do trabalhador. | | **Instituição Credora Original** (o "banco atacado") | A instituição onde o contrato consignado hoje existe. Pode ser qualquer participante da CTC (bancos digitais que atuam fortemente em consignado privado, como o Nubank, são um exemplo comum, mas o fluxo é o mesmo para qualquer credora original). | | **CTC (Central de Transferência de Crédito)** | Câmara centralizadora operada pela Núclea, regulamentada pela Resolução BCB nº 4.292/2013. Nenhuma comunicação ocorre diretamente entre Proponente e Credora Original — tudo passa pela CTC, que também atribui um Número Único de Portabilidade a cada solicitação. | | **Empregador** | Mantém a folha de pagamento onde a margem consignável do trabalhador é averbada (reservada) e desaverbada (liberada) a cada operação. | ### 1. Simulação com base nos dados informados pelo próprio trabalhador No início do fluxo, o parceiro **não tem acesso aos dados oficiais do contrato na instituição credora original** — só o próprio trabalhador pode informá-los. Por isso, tanto a [Simulação](/documentation/manual_consignado_privado/portabilidade/simulacao) quanto a [Digitação da Proposta](/documentation/manual_consignado_privado/portabilidade/proposta) são montadas com um **saldo devedor estimado** (`origin_contract.last_due_balance`) e os dados de identificação do contrato de origem (`ispb`, `contract_number`) fornecidos pelo trabalhador — não com o saldo contábil real, que só existe dentro da credora original. É nessa simulação que as condições da operação de portabilidade — e, se houver, do Refinanciamento (Troco) — são calculadas e apresentadas ao trabalhador antes de qualquer envio à CTC. ### 2. O envio da solicitação ("ataque") à instituição credora original A digitação da proposta (`POST /v2/credit_transfer/proposal`) só monta e registra a operação — o "ataque" à instituição credora original **só é enviado depois que o tomador assina a proposta** na [Formalização](/documentation/manual_consignado_privado/portabilidade/formalizacao). É esse envio, pós-assinatura, que a CTC repassa à instituição credora original identificada em `origin_contract`, e é ele que dá início à contagem dos prazos de resposta descritos a seguir. Ver os status `pending_response` / `pending_acceptance` em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). ### 3. Prazos de resposta da instituição credora original Os prazos de resposta são definidos pela regulamentação da CTC/Núclea, não por configuração da QI Tech — a credora original tem **até 5 dias úteis**, após a recepção do ataque, tanto para decidir se retém o cliente (recusar a portabilidade) quanto para responder informando o saldo devedor — é o mesmo prazo para as duas decisões, não um sendo subconjunto do outro. Dentro do dia em que a resposta é dada, há ainda dois horários-limite: - A instituição credora original deve liberar/informar o saldo devedor **até às 10:00**. - A QI Tech deve enviar o comando de pagamento (liquidação do saldo devedor) **até às 16:00** do mesmo dia. Se a credora original não responder dentro do prazo de 5 dias úteis, a solicitação entra em **decurso de prazo** — isso **não cancela automaticamente** a portabilidade, ela continua válida e pode ser respondida a qualquer momento. Se o parceiro (ou o trabalhador) decidir desistir nesse meio tempo, é necessário cancelar explicitamente a proposta. Ver o detalhamento de status em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). ### 4. Os retornos possíveis da instituição credora original | Retorno | O que significa | |---|---| | **Retenção** (`retained`) | A credora original decide manter o cliente e informa o motivo (ver [Enumeradores](/documentation/manual_consignado_privado/portabilidade/enumeradores#retention_reason_enumerator)). O contrato retido continua disponível para uma nova tentativa de portabilidade no futuro — inclusive pela própria QI Tech, com uma oferta diferente. | | **Aceite com saldo devedor** (`accepted`) | A credora original não reteve o cliente e informa o saldo devedor contábil **real** do contrato (`final_due_balance`), junto com os dados completos do contrato original (taxa, CET, parcelas, datas). | ### 5. Quando o saldo devedor real diverge do saldo estimado Este é o ponto mais importante para quem desenha uma esteira de portabilidade: a proposta é montada com uma **estimativa**, mas quem decide o valor real a ser pago é a instituição credora original — e os dois valores raramente coincidem exatamente. - Se o saldo devedor real superar o estimado em **mais de 15%**, a proposta é **automaticamente rejeitada** pela QI Tech, com o motivo `divergent_due_balance` — evitando prosseguir com uma operação montada sobre uma premissa muito distante da realidade. - Dentro dessa margem de 15%, a proposta segue para `accepted`, e cabe ao parceiro decidir se quer continuar. Essa decisão é formalizada pela chamada de aceite (`accepted_by_requester` — ver [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status)), que **recalcula as condições financeiras da operação (e do Troco, se houver) com base no saldo devedor real**, com duas garantias comerciais: - A parcela recalculada nunca pode ficar **maior** que a parcela do contrato de origem. - O Troco recalculado não pode **cair mais de 10%** em relação ao Troco originalmente calculado na simulação/digitação — preservando, dentro de uma margem, a oferta feita ao trabalhador no início do fluxo. Se as novas condições não forem aceitáveis, o parceiro deve cancelar a proposta explicitamente; não é possível retomar uma proposta cancelada ou rejeitada — é sempre necessária uma nova digitação. ### 6. Pagamento do saldo devedor e averbação da margem: dois processos em paralelo Uma vez aceita, a QI Tech envia o pagamento do saldo devedor à instituição credora original (liquidação) — e, **em paralelo**, inicia a averbação da nova operação de portabilidade na folha do empregador. São dois processos independentes, cada um com seu próprio acompanhamento (status da proposta vs. webhook de averbação): o envio do pagamento **não espera** a confirmação da averbação da margem. Ao desenhar sua esteira, não assuma que "pagamento enviado" já significa "margem garantida" — acompanhe os dois eventos separadamente em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). ### 7. A liberação da margem pelo banco atacado e a averbação da nova operação Para que a averbação da nova operação seja aceita, o registro central de consignado privado precisa refletir que a margem do trabalhador — antes reservada pela instituição credora original — já está livre. Isso normalmente é consequência do próprio andamento da portabilidade (quitação do contrato original), mas pode não estar refletido no registro no exato momento em que a QI tenta averbar a nova operação. Por isso, falhas transitórias na averbação (por exemplo, margem ainda aparecendo como comprometida, ou taxa da nova proposta em conflito com uma proposta ativa do trabalhador) não cancelam a operação de imediato: a QI tenta novamente de forma automática ("teimosinha") até que a averbação seja aceita ou até que um motivo terminal exija o cancelamento manual. Os motivos de falha e o comportamento de retentativa estão detalhados em [Averbação e Desembolso](/documentation/manual_consignado_privado/manual_averbacao_desembolso#fail_reservation_reason); o webhook de confirmação (sucesso ou falha) da averbação da portabilidade está documentado em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). ### 8. Da portabilidade paga ao início do Refinanciamento (Troco) A operação de Refinanciamento (Troco), quando existe, só pode ser aceita **depois que a garantia da operação de Portabilidade estiver averbada** — a tentativa de prosseguir com o Troco antes disso é bloqueada. Ao desenhar a esteira, aguarde o webhook de averbação da Portabilidade antes de disparar a aceitação do Refinanciamento. Uma vez aceito, o Troco segue seu próprio ciclo de averbação e desembolso, detalhado em [Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status). ## Fluxo (passo a passo) 1. **[Consultas prévias](/documentation/manual_consignado_privado/portabilidade/consultas)** — consulta dos vínculos empregatícios e dos dados do trabalhador (margem consignável), com o Termo de Autorização. **Pré-requisito obrigatório** para a averbação. 2. **[Simulação](/documentation/manual_consignado_privado/portabilidade/simulacao)** — simula as condições financeiras e o Troco, a partir do saldo devedor estimado informado pelo trabalhador, antes (ou em vez) de digitar a proposta. 3. **[Digitação da proposta](/documentation/manual_consignado_privado/portabilidade/proposta)** — `POST /v2/credit_transfer/proposal` com a garantia `private_payroll`, a operação de portabilidade e, opcionalmente, a de refinanciamento. 4. **[Formalização](/documentation/manual_consignado_privado/portabilidade/formalizacao)** — assinatura das operações via QI Sign. A QI Tech coleta os documentos e captura a assinatura; o parceiro não envia documentos. É **só após a assinatura** que o "ataque" é enviado à instituição credora original através da CTC. 5. **[Acompanhamento da Operação](/documentation/manual_consignado_privado/portabilidade/maquina_de_status)** — acompanhamento da proposta na CTC (`pending_response → pending_acceptance → accepted → accepted_by_requester → settlement_sent → paid`), incluindo o recálculo por divergência de saldo devedor e a averbação da margem, e da operação de refinanciamento/Troco (`issued → disbursed`). 6. **[Consultas e operações pós-proposta](/documentation/manual_consignado_privado/portabilidade/consultas_pos_proposta)** — lista de participantes da CTC, recuperação da última resposta de averbação, redução de parcelas, fee e recibo de pagamento. 7. **[Mocks e Sandbox](/documentation/manual_consignado_privado/portabilidade/mocks_sandbox)** — simulação de cenários (aprovação, rejeição, saldo) em ambiente de testes. Referência transversal: **[Enumeradores](/documentation/manual_consignado_privado/portabilidade/enumeradores)**. ## Pré-requisito: consultas do trabalhador Antes da digitação, é obrigatório realizar uma **consulta de dados válida** do trabalhador (consulta dos vínculos empregatícios + consulta de saldo/margem), assinada com o **Termo de Autorização**. Essas consultas estão documentadas em **[Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador)**; a página [Consultas prévias](/documentation/manual_consignado_privado/portabilidade/consultas) explica como elas se encaixam no fluxo de portabilidade. ## Glossário | Termo | Significado | |---|---| | **CTC** | Central de Transferência de Crédito, operada pela Núclea — câmara que intermedia toda a comunicação da portabilidade entre a Instituição Proponente e a Instituição Credora Original. | | **Instituição Proponente** | Quem propõe a portabilidade — a QI Tech, atuando em nome do parceiro. | | **Instituição Credora Original / "banco atacado"** | Instituição onde o contrato consignado hoje existe. | | **"Ataque"** | Termo de mercado para o envio da solicitação de portabilidade, pela CTC, à instituição credora original. | | **Saldo devedor estimado** | Valor informado pelo trabalhador na proposta (`origin_contract.last_due_balance`), usado para simular e digitar a operação antes de qualquer confirmação da credora original. | | **Saldo devedor real** | Valor contábil oficial do contrato de origem, informado pela credora original na resposta de aceite (`final_due_balance`). Pode divergir do saldo estimado — ver [seção 5](#5-quando-o-saldo-devedor-real-diverge-do-saldo-estimado). | | **Retenção** | Decisão da credora original de não liberar o cliente para a portabilidade, com motivo obrigatório. | | **Troco** | Valor adicional liberado ao trabalhador quando a portabilidade vem acompanhada de refinanciamento (`refinancing_credit_operation`). | | **`origin_contract`** | Dados do contrato na instituição credora original (`ispb`, `contract_number`, `last_due_balance`). | | **Averbação** | Reserva da margem consignável na folha de pagamento do empregador, garantindo o desconto das parcelas. | | **"Teimosinha"** | Retentativa automática de averbação feita pela QI Tech quando a tentativa falha por um motivo não terminal (ex.: margem ainda não liberada pela credora original). | | **`private_payroll`** | `collateral_type` da garantia de folha de pagamento de funcionários de empresas privadas; `collateral_data` = `employer_document_number` + `registration_number`. | | **`proposal_type`** | Tipo da proposta; para Consignado Privado, `"private_company"`. | --- # Assinatura em Lote URL: /documentation/manual_exercito/assinatura-em-lote Agrupa **várias operações do consignado militar** em **um único envelope** de assinatura do QI Sign. Você abre o lote, cria as operações referenciando o `document_batch_key`, confere (opcionalmente limpa) e dispara o envio para assinatura. Fluxo recomendado para [compra de dívida](./04-portabilidade-refin.md) — onde N duplas `debt_purchase` + `refinancing` + 1 refin/refin consolidador podem ser assinadas num único envelope (militar assina uma vez só). :::caution Regras do lote **Mesma titularidade:** todas as operações do lote devem ser do **CPF** (ou do **mesmo representante legal**) do militar. Incluir CPF "A" e CPF "B" no mesmo lote gera **erro síncrono** no `POST /debt`. **Tipos permitidos:** o lote do Exército aceita apenas `POST /debt` com `collateral_type: military_payroll`. ::: ## 1. Abrir o lote ENDPOINT /document/document_batch MÉTODO POST **Request Body** ```json { "type": "military_payroll_external_batch", "certifier_type": "qi_sign", "batch_name": "Lote EB compra-divida - 5ed20003-0610-46d2-88cc-a5d0de640696", "request_control_key": "5ed20003-0610-46d2-88cc-a5d0de640696" } ``` ### Campos chave | Campo | Tipo | Descrição | |---|---|---| | `type` | string | Fixo: **`military_payroll_external_batch`** | | `certifier_type` | string | Fixo: **`qi_sign`** | | `batch_name` | string | Nome identificador do lote (**máximo 100 caracteres**) | | `request_control_key` | string (UUIDv4) | **Idempotência** — não reutilize entre lotes | **Response Body** ```json { "document_batch_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc" } ``` Guarde o `document_batch_key` retornado — ele é referenciado em todas as próximas chamadas. ## 2. Incluir operações no lote Ao criar cada operação militar, envie **`document_batch_key` na raiz** do payload do `POST /debt` (mesmo nível dos demais campos principais). ENDPOINT /debt MÉTODO POST ```json { "document_batch_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc", "borrower": { "...": "demais campos do borrower" }, "financial": { "...": "demais campos financeiros" }, "operation_type": "refinancing", "collaterals": [ { "collateral_type": "military_payroll", "collateral_data": { "reservation_type": "refinancing", "registration_code": "146254221", "token": "12345678" } } ], "modality": { "code": "0202" }, "refinanced_credit_operations": [ { "...": "operation_key + contrato externo (ver Portabilidade + Refin)" } ] } ``` O restante do body segue o contrato do `POST /debt`. Consulte os roteiros da [Margem Livre](./03-margem-livre.md) ou [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) conforme a modalidade. :::tip Compra de dívida cabe num lote só Pra [compra de dívida](./04-portabilidade-refin.md) (`debt_purchase` + `refinancing` port-enrustido), todas as duplas Op A + Op B + o refin/refin consolidador podem entrar no mesmo lote. ::: ## 3. Consultar documentos do lote Recomendado **antes de fechar o lote** para conferir os documentos agrupados. ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY MÉTODO GET **Response Body** ```json { "document_batch_key": "1eee4ec2-05f5-45ef-aa64-38bb3d9de02f", "documents": [ { "document_key": "5cca1dad-28fe-4f19-8bbb-0edd6f042384", "document_type": "ccb_pre_price_days" }, { "document_key": "c109d589-ae18-4f4f-ad31-2879bf714c71", "document_type": "ccb_pre_price_days" } ] } ``` ## 4. Limpar documentos do lote (opcional) Remove **todos os documentos** vinculados ao lote — útil pra reagrupar do zero se identificar inconsistência antes do envio. ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY/documents MÉTODO DELETE Body vazio. Response: HTTP 200. ## 5. Enviar para assinatura Fecha o lote e dispara os documentos pro QI Sign. **Antes desse PUT, os documentos não vão pro militar.** É o gatilho final. ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY/send_to_signature MÉTODO PUT Body: `{}`. Response: HTTP 200. ## Erros comuns | HTTP | Código | Endpoint | Quando ocorre | |---|---|---|---| | 404 | `DOC000007` | `GET /document/document_batch/DOCUMENT_BATCH_KEY` | `document_batch_key` inexistente | | 409 | `DOC000103` | `POST /document/document_batch` | `request_control_key` duplicado (idempotência violada) | **Exemplo — DOC000103 (idempotência)** ```json { "code": "DOC000103", "title": "Bad Request", "description": "request_control_key already exists", "translation": "Chave de controle da request já existe.", "http_status": 409 } ``` :::info Conflito de titularidade Validação de **mesmo CPF/representante** no lote retorna erro no `POST /debt` (não no endpoint do lote). O corpo de erro segue o catálogo do `/debt`. ::: --- # Cancelamento, Desaverbação e Reversal URL: /documentation/manual_exercito/cancelamento Cancelar uma operação militar tem dois eixos independentes: 1. **Cancelamento da CCB** — estado da operação no LaaS, e eventual estorno do dinheiro desembolsado. 2. **Desaverbação no Zetra** — liberação da margem em folha de pagamento. Os dois acontecem de forma assíncrona e nem sempre simultâneos. Cancelar a operação NÃO libera a margem instantaneamente; pagar de volta o dinheiro desembolsado também é um passo separado. ## 1. Pré-desembolso — Cancelamento Imediato Antes do desembolso (operação em `waiting_signature`, `signature_finished` ou `waiting_disbursement`): ```http PATCH /debt/{DEBT_KEY}/cancel ``` Sem body. Resposta imediata: operação vai pra `canceled`. Não há reversal financeiro (dinheiro nem saiu). Webhook: `debt` com `status: canceled` + `cancel_reason_enumerator` indicando o motivo (`manual`, `waiting_signature`, `not_collateral_constituted`, etc.). A QI dispara em seguida a desaverbação no Zetra (ver seção 4). ## 2. Pós-desembolso — Janela de Desistência (7 dias úteis) **A janela legal de desistência é de 7 dias úteis** após o desembolso. Dentro dela: ```http PATCH /debt/{DEBT_KEY}/cancel ``` A response **NÃO é instantânea como o pré-desembolso** — retorna um **PIX QR Code** que o borrower deve pagar pra devolver o dinheiro desembolsado. O parceiro repassa o QR pro cliente. | Campo na response | Significado | |---|---| | `cancel_qr_code.qr_code_url` / `digitable_line` | PIX copia-e-cola ou QR pra pagamento | | `cancel_qr_code.amount` | Valor a devolver (igual ao desembolsado) | | `cancel_qr_code.expiration` | Prazo pro pagamento (15 dias úteis após desembolso) | Quando o borrower paga o PIX: 1. QI confirma o pagamento. 2. Dispara o **reversal financeiro automático** — desfaz o desembolso, devolve pro fundo. 3. Webhook `reversal` chega: ```json { "webhook_type": "reversal", "credit_operation_key": "", "contract_number": "<...>", "reversal": { "status": "pending_fund", "amount": 2026.93, "amount_to_send": 2026.93, "is_total": true, "is_operation_canceled": true, "reversal_key": "", "date": "2026-09-06" } } ``` 4. QI dispara a desaverbação no Zetra. 5. Operação vai pra `canceled`. > [!warning] Prazo de pagamento do QR > O QR tem validade de **15 dias úteis após o desembolso** (não após emissão do QR). Se o borrower não pagar dentro desse prazo, o cancelamento expira e a operação volta a ser ativa — vira inadimplência normal (cobrança de parcelas segue o curso). Restrições pós-desembolso: - Operação precisa estar em status `open` (sem parcelas pagas). - Pagamento parcial de qualquer parcela bloqueia o cancelamento. - Não há cancelamento parcial — só total. ## 3. Cancelamento Permanente ```http PATCH /debt/{DEBT_KEY}/cancel/permanent ``` Marca como `canceled_permanently` — não há volta. Útil pra: - Cliente desistiu e não vai pagar o QR (vira inadimplência → permanent depois) - Operação que ficou pendente além do prazo (auto-cancel já faz isso em 7 dias, mas pode forçar) Sem reversal automático — usar apenas se o dinheiro já foi resolvido por fora ou nunca saiu. ## 4. Desaverbação no Zetra Independente do cancelamento financeiro, a desaverbação é processada pelo Zetra de forma assíncrona: ![Fluxo de cancelamento Exército](/img/diagrams/exercito-cancelamento.svg) | Status no `credit_operation.collateral` | Significado | |---|---| | `waiting_confirmation` | Zetra ainda processando a desaverbação | | `successfully_deleted` | Margem liberada | | `communication_error` | Zetra indisponível (cod 241) — QI retenta automaticamente | > [!warning] > **Não considere a margem liberada até `successfully_deleted` chegar.** Emitir nova operação no mesmo militar antes da desaverbação confirmada retorna `consignable_margin_exceeded`. Pra consultar o estado: ```http GET /debt/{DEBT_KEY}/collateral ``` Retorna `last_response` + `reservation_status` atual. ## 5. Auto-cancelamento (7 dias) Operações em status `canceled` (não-permanente) por mais de **7 dias** são automaticamente convertidas em `canceled_permanently` pelo sistema. Aplica-se a: - Operação cuja averbação foi recusada (`consent_refused`) - Operação cuja averbação expirou (`consent_expired`) - Operação pendente de assinatura além do prazo - Operação com cancelamento solicitado mas QR não pago dentro de 15 dias úteis Não precisa fazer nada — o sistema cancela e desaverba sozinho. ## Resumo dos Endpoints | Endpoint | Quando usar | Reversal automático? | |---|---|---| | `PATCH /debt/{KEY}/cancel` (pré-desembolso) | Antes do desembolso | Não aplica (dinheiro não saiu) | | `PATCH /debt/{KEY}/cancel` (pós-desembolso) | Dentro de 7 dias úteis após desembolso | Sim — após borrower pagar o PIX QR retornado | | `PATCH /debt/{KEY}/cancel/permanent` | Cancelamento definitivo (sem volta) | Não — uso administrativo | ## Cancel reasons no webhook `debt` (`status: canceled`) Os principais `cancel_reason_enumerator` que aparecem: | Enumerador | Significado | |---|---| | `manual` | Cancelado via API ou portal | | `waiting_signature` | Não assinou no prazo | | `not_collateral_constituted` | Averbação falhou | | `is_portability` | Portabilidade falhou | | `pix_max_retry` | Muitas falhas no desembolso PIX | | `lack_of_resource` | Sem recurso pra desembolsar | | `kyc_not_accepted` | KYC reprovado | → [Lista completa de enumeradores em Mapa de Status](./08-mapa-de-status.md) --- # Consulta de Margem Consignável URL: /documentation/manual_exercito/consulta-margem Endpoint que consulta a margem disponível do militar no Zetra (eConsig). É o **primeiro passo operacional** depois do upload da autorização — sem o `balance_key` desse passo, não dá pra simular nem emitir. ## Pré-requisitos 1. **Upload do consentimento** feito (`POST /upload` → `document_key`). → [Upload de Documentos](../upload_de_documentos/) 2. **Token Zetra** do militar em mãos (senha do sistema militar). ## Endpoint ```http POST /military_payroll/balance ``` | Campo | Tipo | Descrição | |---|---|---| | `document_number` | string | CPF do militar — 11 dígitos, sem `.` e sem `-`, zero-padded | | `registration_code` | string | Matrícula do militar | | `authorization_document_key` | uuid | `document_key` retornado no upload | | `token` | string | Token de autenticação Zetra (senha) | Resposta síncrona: ```json { "balance_key": "81da8afb-e1b2-4215-8093-c4b5feab8a9f", "status": "pending_search" } ``` ## Webhook de resultado Tipo: `military_payroll.balance.status_change` Campos no payload de **sucesso**: - `balance` — margem disponível (Decimal) - `allowed_installment_numbers` — array de prazos válidos (ex: `[24, 36, 48]`) - `military_unit` — unidade do militar - `military_branch` — força (string longa, dezenas de valores possíveis: `AMAN`, `Sistema de Retribuição do Exterior`, etc.) - `category` — `ATIVO`, `INATIVO`, `PENSIONISTA` - `name`, `document_number`, `registration_code`, `birth_date`, `grant_date` ## Enumeradores de falha | Enumerador | Zetra code | Significado | Ação | |---|---|---|---| | `invalid_registration_code` | 210 | Matrícula inválida ou inexistente | Verificar matrícula | | `military_not_found` | 293 | Militar não encontrado pelo CPF+matrícula | Verificar dados | | `military_blocked` | 352 | Militar com bloqueio em folha | Não há ação imediata | | `communication_error` | 241 | Zetra indisponível | QI retenta automaticamente | ## Sandbox A sandbox militar **conecta na Zetra real de homologação** (`central_homologa.econsig.com.br`) — não há whitelist local de CPFs no `military-payroll-api`. Os dados de teste (CPFs, matrículas, tokens) são fornecidos pela Zetra. Solicite ao time de Integrações QI Tech a lista de servidores fictícios disponíveis. CPFs fora dessa lista retornam `military_not_found` (Zetra 293) ou `invalid_registration_code` (Zetra 210). → [Mocks (Sandbox) — detalhes completos](./09-mocks-sandbox.md) ## Próximo passo Após o webhook `succeeded` com `balance` retornado, escolha a modalidade: - [Margem Livre](./03-margem-livre.md) — crédito novo com margem disponível - [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) — refin de operação QI ou compra de dívida externa --- # Conta Interna para Desembolso URL: /documentation/manual_exercito/conta-interna-desembolso Em **compra de dívida**, **portabilidade** e **refinanciamento** do consignado militar (Exército), o desembolso da operação **não vai direto para a conta externa do tomador**: ele cai numa conta interna **em nome do tomador** (aberta pelo parceiro via `POST /account`). É a partir dessa conta que a QI executa as ações pós-desembolso — **quitação do contrato externo**, **repasse de troco**, **conciliação**. :::tip Por que conta interna? Concentrar o desembolso numa conta operacional dá controle do fluxo: a QI consegue orquestrar quitação externa + averbação + repasse de troco sem depender de SLA de banco terceiro no meio do processo. ::: ## Quando usar conta interna vs externa | Cenário | `disbursement_bank_account` | |---|---| | [Margem Livre](./03-margem-livre.md) (crédito novo direto) | Conta **externa** do tomador | | [Refinanciamento puro](./04-portabilidade-refin.md) (renegocia CO QI ativa) | Conta **interna** em nome do tomador | | [Portabilidade](./04-portabilidade-refin.md) (com ou sem troco) | Conta **interna** em nome do tomador | | [Compra de dívida](./04-portabilidade-refin.md) (`debt_purchase` + `refinancing` port-enrustido) | Conta **interna** em nome do tomador **nas duas operações da dupla** | | Refin/refin consolidador (opcional, fecha várias port/refins) | Conta **interna** em nome do tomador | ## 1. Abrir a conta interna em nome do tomador ENDPOINT /account MÉTODO POST A conta é aberta pelo **parceiro** (autenticado com seus `client_integration_key`), com o `owner_document_number` apontando para o **CPF do militar tomador**. Reutilize a conta existente — uma por tomador (não abrir nova a cada operação). **Request Body** ```json { "owner_document_number": "", "owner_person_key": "", "requester_key": "", "webhook_enabled": true } ``` :::info Pré-requisito O militar precisa estar **onboarded** previamente (ter `person_key`) — o parceiro envia esse `person_key` no `owner_person_key`. Caso contrário, o `/account` falha com `ACC000xxx` por validation. ::: **Response Body** ```json { "account_key": "1167955-...", "account_branch": "0001", "account_number": "1167955", "account_digit": "1", "owner_document_number": "", "owner_name": "", "bank_code": "329", "account_status": "active", "webhook_enabled": true } ``` :::tip Idempotência por tomador Se já existe conta ativa para esse `owner_document_number` no parceiro, evite chamar `POST /account` de novo — consulte `GET /accounts?owner_document_number= ` antes e reaproveite o `account_key` retornado. ::: ## 2. Usar a conta no `/debt` Use os dados retornados em `disbursement_bank_account` no payload do `POST /debt`. **A mesma conta vai nas DUAS operações da dupla `debt_purchase` + `refinancing`** (e no `refinancing` consolidador, se houver). ```json { "disbursement_bank_account": { "name": "", "bank_code": "329", "account_type": "checking_account", "account_branch": "0001", "account_number": "1167955", "account_digit": "1", "document_number": "", "transfer_method": "ted" } } ``` | Campo | Valor (conta interna QI Tech) | |---|---| | `bank_code` | `"329"` (QI Tech S.A. — SCD) | | `account_branch` | `"0001"` | | `account_number` / `account_digit` | retornados no `POST /account` | | `document_number` | **CPF do militar** (mesmo do `owner_document_number`) | | `transfer_method` | `"ted"` (recomendado para `payment_type_id: 10`) | Exemplo completo: ver [Portabilidade + Refinanciamento — Compra de dívida](./04-portabilidade-refin.md). ## 3. Ações pós-desembolso A QI dispara as ações abaixo automaticamente conforme os webhooks confirmam cada etapa. ### 3.1 Conferir saldo ENDPOINT /account/ACCOUNT_KEY/balance MÉTODO GET ### 3.2 Quitação do contrato externo (port) Disparada pela QI ao receber `credit_operation.collateral` (`reservation_status: deleted`) na operação antiga: saldo da conta interna é enviado ao banco origem via **PIX** ou **TED** para liquidar o contrato externo. ### 3.3 Repasse de troco pro tomador (se houver) Se `final_disbursement_amount > 0` na simulação, o saldo residual é transferido da conta interna para a **conta externa do militar** (informada no onboarding ou no payload da operação). ### 3.4 Conciliação ENDPOINT /account/ACCOUNT_KEY/statement MÉTODO GET Query params `from_date` e `to_date` no formato `YYYY-MM-DD`. ### 3.5 Webhooks relevantes | Webhook | Quando dispara | |---|---| | `account.balance_change` | Crédito recebido na conta interna (desembolso da CO) | | `pix_transfer.status_change` | Quitação externa OU repasse de troco confirmados | | `ted.status_change` | Quitação externa OU repasse via TED confirmados | ## Referências - [Conta de pagamento — fluxo completo](/documentation/contas/abertura_de_conta/fluxo_de_abertura_de_conta) — referência do `POST /account` em detalhes - [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) — usa essa conta em compra de dívida (`debt_purchase` + `refinancing`) - [Webhooks](./07-webhooks.md) — eventos assíncronos da operação --- # Modelos de Formalização URL: /documentation/manual_exercito/formalizacao A QI Tech suporta **5 modelos** de formalização da operação militar — escolha conforme a infraestrutura do parceiro (se já tem signature provider, se quer usar QI Sign, se vai usar biometria). Adicionalmente, pra agrupar várias operações num único envelope (recomendado em [compra de dívida](./04-portabilidade-refin.md)), use [Assinatura em Lote](./11-assinatura-em-lote.md). :::tip Várias operações no mesmo envelope Em compra de dívida com N duplas `debt_purchase` + `refinancing` (+ refin/refin consolidador), use [Assinatura em Lote](./11-assinatura-em-lote.md) (`POST /document/document_batch` com `type: military_payroll_external_batch`) — o militar assina tudo de uma vez só. ::: ## Modelos disponíveis | Modelo | Quando usar | |---|---| | **QI Sign automático** (default) | Não precisa configurar nada — QI envia link de assinatura por email/SMS pro borrower | | **QI Sign em lote** | Várias operações num único envelope; ver [Assinatura em Lote](./11-assinatura-em-lote.md) | | **PDF assinado externamente** | Parceiro tem signature provider próprio; faz upload do PDF assinado | | **Data-signature: opt-in** | Borrower clica "concordo" em um portal do parceiro; parceiro envia evidência | | **Data-signature: zip** | Parceiro envia zip com evidências (logs, IPs, timestamps) | | **Data-signature: selfie** | Biometria via CaaS (face match + liveness) | ## QI Sign Automático Não requer chamada adicional após `/debt`. QI envia URL de assinatura pro borrower (email/SMS). Quando o borrower assina, webhook `debt` fires com `status: signature_finished` e a esteira segue. Pré-requisito: o RequesterConfiguration tem `default_signature_method` apontando pra QI Sign. ## PDF assinado externamente ```http POST /debt/{DEBT_KEY}/signed ``` ```json { "signed_document_key": "" } ``` Pré-requisito: fazer upload do PDF assinado via `POST /upload` antes de chamar `/signed`. ## Data-signature: opt-in ```json { "data_signature": { "type": "opt_in", "evidence": { "ip_address": "200.123.45.67", "user_agent": "Mozilla/5.0 ...", "timestamp": "2026-05-17T14:30:00Z" } } } ``` ## Data-signature: zip Parceiro empacota evidências em `.zip` e envia via upload. O `signed_document_key` aponta pro zip. ## Data-signature: selfie Requer integração com CaaS (face recognition + liveness). O `signed_document_key` aponta pra um `image_key` retornado pelo CaaS. ## Webhook após formalização `debt` com `status: signature_finished` → indica que QI aceitou a formalização. Em seguida, a averbação é confirmada (se `reservation_method: issuing`) e o desembolso entra na fila. ## Próximo passo Após o `signature_finished`, a operação segue automaticamente: averbação confirmada (se `issuing`) → desembolso PIX/TED → webhook `debt` (`disbursed`). Para acompanhar via webhooks: [Webhooks](./07-webhooks.md). Para cancelar a qualquer momento: [Cancelamento](./06-cancelamento.md). --- # Consignado do Exército — Introdução URL: /documentation/manual_exercito/introducao API para originação de **CCB consignado** para militares do Exército Brasileiro (ativos, inativos e pensionistas). A reserva de margem é feita via **Zetra (eConsig)** e o ciclo todo — consulta de margem, emissão, averbação, desembolso e cancelamento — passa por essa plataforma. | Item | Valor | |---|---| | Autoridade pagadora | Exército Brasileiro / **Zetra (eConsig)** | | Tipo de garantia (`collateral_type`) | `military_payroll` | | Modelo de reserva | Averbação (assíncrona, consentida via documento de autorização) | | Funcionamento | **24h por dia, todos os dias, inclusive feriados** | | Modalidades suportadas | [Margem Livre (Crédito Novo)](./03-margem-livre.md) e [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) | | Token | **Obrigatório** na consulta de margem (senha do sistema militar) | | Instrumento | CCB (via `POST /debt`) | :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## Fluxo End-to-End Em **margem livre** o desembolso vai direto pra conta externa do militar. Em **refinanciamento, portabilidade e compra de dívida** o desembolso vai pra uma **conta interna em nome do militar** (aberta pelo parceiro via `POST /account`) — daí a QI quita o contrato externo, repassa o troco e faz a conciliação. Ver [Conta Interna para Desembolso](./10-conta-interna-desembolso.md). ![Fluxo end-to-end Exército](/img/diagrams/exercito-introducao.svg) ## Modalidades A operação se divide em quatro modalidades, escolhidas no `operation_type` e `collateral_data`: | Modalidade | `operation_type` / `reservation_type` | Quando usar | Doc | |---|---|---|---| | **Margem Livre** (Crédito Novo) | `operation_type: structured_operation` / `reservation_type: new_credit` | Militar com margem disponível; sem dívida externa nem refin de operação ativa | [→ Margem Livre](./03-margem-livre.md) | | **Refinanciamento** | `operation_type: refinancing` / `reservation_type: refinancing` + `operation_key` | Renegociar operação QI ativa (prazo/taxa), eventualmente liberando troco | [→ Port + Refin](./04-portabilidade-refin.md) | | **Portabilidade** (com ou sem troco) | `operation_type: refinancing` / `reservation_type: refinancing` + `original_contract_number` | Trazer dívida de outro banco; pode incluir troco | [→ Port + Refin](./04-portabilidade-refin.md) | | **Compra de dívida** (port enrustida) | `operation_type: debt_purchase` + `operation_type: refinancing` (dupla) | Trazer N dívidas externas; QI emite uma dupla `debt_purchase` + `refinancing` por contrato externo, com desembolso em [conta interna em nome do militar](./10-conta-interna-desembolso.md) | [→ Port + Refin](./04-portabilidade-refin.md) | ## Pré-requisitos Antes de qualquer requisição (Consulta, Emissão, etc): 1. Upload do consentimento do militar via `POST /upload` → retorna `document_key`. Ver [Upload de Documentos](../upload_de_documentos/). 2. Conhecer o **token** (senha do sistema militar Zetra) do borrower — é obrigatório no payload de `POST /military_payroll/balance`. ## Referência por área - [Consulta de Margem](./02-consulta-margem.md) — endpoint `/military_payroll/balance` + token Zetra - [Margem Livre](./03-margem-livre.md) — Simulação + Emissão para `new_credit` - [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) — Simulação + Emissão para `refinancing` + payloads de compra de dívida (`debt_purchase` + `refinancing` port-enrustido) - [Formalização](./05-formalizacao.md) — 5 modelos: QI Sign, PDF, opt-in, zip, selfie - [Conta Interna para Desembolso](./10-conta-interna-desembolso.md) — POST `/account` em nome do militar + uso em compra de dívida + ações pós-desembolso - [Assinatura em Lote](./11-assinatura-em-lote.md) — agrupar várias operações num único envelope QI Sign (`POST /document/document_batch`) - [Cancelamento, Desaverbação e Reversal](./06-cancelamento.md) — pré + pós-desembolso + reversal automático - [Webhooks](./07-webhooks.md) — todos os eventos assíncronos + payloads - [Mapa de Status](./08-mapa-de-status.md) — enumeradores consolidados - [Mocks (Sandbox)](./09-mocks-sandbox.md) — dados de teste e cenários end-to-end --- # Mapa de Status URL: /documentation/manual_exercito/mapa-de-status Referência consolidada de todos os enumeradores que podem aparecer nas respostas síncronas e webhooks do produto consignado militar. ## Consulta de Margem (`military_payroll.balance.status_change`) | Status | Significado | |---|---| | `pending_search` | Resposta síncrona — consulta enfileirada no Zetra | | `succeeded` | Webhook — margem retornada com sucesso | | `failed` | Webhook — falha (ver `failure_reason`) | ### Failure reasons | Enumerador | Zetra code | Significado | |---|---|---| | `invalid_registration_code` | 210 | Matrícula inválida | | `military_not_found` | 293 | CPF/matrícula sem registro | | `military_blocked` | 352 | Militar com bloqueio em folha | | `communication_error` | 241 | Zetra indisponível | | `invalid_document_number` | — | CPF malformado | ## Averbação / Desaverbação (`credit_operation.collateral`) | Enumerador | `reservation_status` | Significado | |---|---|---| | `successfully_accepted` | `pending_confirmation` | Zetra aceitou a requisição, aguardando confirmação | | `successfully_reserved` | `reserved` | Margem reservada com sucesso | | `successfully_deleted` | `deleted` | Margem desaverbada com sucesso | | `waiting_confirmation` | — | Aguardando Zetra | | `communication_error` | — | Erro de comunicação (cod 241) | | `consignable_margin_exceeded` | — | Margem insuficiente (cod 359) | | `consent_refused` | — | Militar recusou o consentimento | | `consent_expired` | — | Janela de consentimento expirou | | `expired_portability` | — | Janela de port expirou | | `origin_contract_not_found` | — | Contrato origem (port/refin) não existe | | `waiting_for_origin_contract_closure` | — | Aguardando quitação externa | ## Operação (`debt`) | Status | Significado | |---|---| | `waiting_signature` | Aguardando assinatura | | `signature_finished` | Assinatura concluída | | `waiting_disbursement` | Aguardando desembolso | | `disbursed` | Desembolsado | | `canceled` | Cancelada (não-permanente, ainda recuperável) | | `canceled_permanently` | Cancelada definitivamente | | `settled` | Liquidada (todas as parcelas pagas) | ### Cancel reasons (`cancel_reason_enumerator`) | Enumerador | Significado | |---|---| | `manual` | Cancelado via API ou portal | | `waiting_signature` | Não assinou no prazo | | `not_collateral_constituted` | Averbação falhou | | `is_portability` | Portabilidade falhou | | `pix_max_retry` | Muitas falhas no desembolso PIX | | `lack_of_resource` | Sem recurso pra desembolsar | | `kyc_not_accepted` | KYC reprovado | | `agencia_conta_invalida` | Erro em dados bancários | | `invalid_account` | Conta inválida | | `rejected_payment` | Pagamento recusado pelo banco destino | | `disbursing_error` | Erro genérico no desembolso | | `entry_not_paid` | Entrada não paga (refin com troco negativo) | | `bank_slip_paid` | Boleto já foi pago | | `unsupported_transaction` | Tipo de conta não suporta a transação | ## Reversal (cancelamento pós-desembolso) | Status | Significado | |---|---| | `pending_fund` | Reversal iniciado, aguardando devolução pro fundo | | `completed` | Reversal completo | | `failed` | Reversal falhou (raro — investigação manual) | ## Parcelas (`installment.status_change`) | Status | Significado | |---|---| | `opened` | Aberta, ainda não venceu | | `waiting_payment` | Aberta, na data de vencimento | | `paid` | Paga em dia | | `paid_early` | Paga antes do vencimento | | `paid_partial` | Paga parcialmente | | `paid_overdue` | Paga após o vencimento | | `paid_partial_overdue` | Paga parcialmente após o vencimento | | `overdue` | Em atraso | | `canceled` | Cancelada | ## Recuperar último estado Pra consultar o estado atual de uma operação a qualquer momento: ```http GET /debt/{DEBT_KEY}/collateral ``` Retorna `last_response` (último enumerador) + `reservation_status` + timestamp da última atualização. --- # Margem Livre (Crédito Novo) URL: /documentation/manual_exercito/margem-livre Esteira de **originação direta** quando o militar tem margem consignável disponível e não está trazendo dívida externa nem refinanciando operação ativa. Cobre simulação e emissão para `reservation_type: new_credit`. Para refinanciar uma operação QI ativa ou trazer dívida de outro banco, ver [Portabilidade + Refinanciamento](./04-portabilidade-refin.md). ## Pré-requisitos - `balance_key` recebido na [Consulta de Margem](./02-consulta-margem.md), com webhook `military_payroll.balance.status_change` em `status: succeeded`. - `balance` retornado > parcela desejada × prazo. - `token` Zetra do militar disponível. ## 1. Simulação Antes de emitir, simule as condições para validar margem, prazo e cronograma. ### Request ENDPOINT /debt_simulation MÉTODO POST **Request Body** ```json { "borrower": { "person_type": "natural", "individual_document_number": "45507529710" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 500.00, "disbursement_date": "2026-06-01", "number_of_installments": 24, "monthly_interest_rate": 0.0205, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 } }, "collaterals": [ { "collateral_type": "military_payroll", "percentage": 1, "collateral_data": { "reservation_type": "new_credit", "registration_code": "146254221" } } ] } ``` #### Campos chave | Campo | Descrição | |---|---| | `collaterals[].collateral_type` | **`military_payroll`** (obrigatório) | | `collaterals[].collateral_data.reservation_type` | **`new_credit`** — sempre pra margem livre | | `collaterals[].collateral_data.registration_code` | Matrícula do militar | | `financial.installment_face_value` | Parcela — ≤ `balance` retornado na consulta de margem | | `financial.number_of_installments` | Prazo — ∈ `allowed_installment_numbers` | | `financial.monthly_interest_rate` | Taxa mensal (ex: `0.0205` = 2,05% a.m.) | `modality.code` **NÃO** é obrigatório em margem livre — só em refinanciamento. ### Response Síncrona — retorna o cronograma completo (`disbursement_options[]` com parcelas, IOF, CET). ## 2. Emissão Cria a CCB e dispara a esteira de averbação → formalização → desembolso. ### Request ENDPOINT /debt MÉTODO POST **Request Body** ```json { "borrower": { "name": "JOÃO DA SILVA", "email": "joao@email.com", "phone": { "number": "900000000", "area_code": "11", "country_code": "+55" }, "address": { "city": "São Paulo", "state": "SP", "number": "215", "street": "Gilberto Sabino", "complement": "", "postal_code": "12345012", "neighborhood": "Pinheiros" }, "role_type": "issuer", "birth_date": "1985-03-12", "mother_name": "MARIA DA SILVA", "person_type": "natural", "individual_document_number": "45507529710", "gender": "male", "nationality": "brasileiro", "is_pep": false, "marital_status": "single" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 500.00, "disbursement_date": "2026-06-01", "number_of_installments": 24, "monthly_interest_rate": 0.0205, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 } }, "simplified": true, "collaterals": [ { "collateral_type": "military_payroll", "percentage": 1, "collateral_data": { "reservation_type": "new_credit", "reservation_method": "creation", "registration_code": "146254221", "token": "12345678" } } ], "disbursement_bank_account": { "name": "JOÃO DA SILVA", "bank_code": "104", "account_type": "checking_account", "account_digit": "1", "branch_number": "3880", "account_number": "000736703806", "document_number": "45507529710", "transfer_method": "pix" }, "purchaser_document_number": "32402502000135" } ``` #### `reservation_method` — quando a averbação dispara **creation (averbação imediata)** Averbação no Zetra dispara **junto com a criação do `/debt`**. Feedback rápido de margem antes da assinatura — ideal pra fluxos onde o operador quer saber logo se a margem reserva. **issuing (averbação após formalização)** Averbação só dispara **após a formalização** (`POST /debt/{KEY}/signed`). Usado quando a assinatura é coletada offline ou em fluxos onde o contrato chega já assinado. #### Webhooks pós `/debt` | Webhook | Status | Quando | |---|---|---| | `debt` | `waiting_signature` | Operação criada, aguardando assinatura | | `credit_operation.collateral` | `successfully_accepted` → `successfully_reserved` | Averbação aceita pelo Zetra | | `debt` | `disbursed` | Desembolso PIX/TED enviado | → Próximo passo: [Formalização](./05-formalizacao.md) ## Falhas comuns | Webhook / Erro | Enumerador | Significado | Ação | |---|---|---|---| | Simulação | `INSUFFICIENT_MARGIN` | parcela × prazo > balance | Reduzir parcela ou prazo | | Simulação | `INVALID_INSTALLMENT_NUMBER` | prazo fora de `allowed_installment_numbers` | Usar um dos prazos permitidos | | `credit_operation.collateral` | `consignable_margin_exceeded` | margem insuficiente no momento da averbação (Zetra 359) | Reduzir parcela ou aguardar liberação | | `credit_operation.collateral` | `military_blocked` | Militar com bloqueio em folha (Zetra 352) | Militar precisa resolver com Zetra | | `credit_operation.collateral` | `communication_error` | Zetra indisponível (cod 241) | QI **retenta automaticamente** | → [Lista completa de enumeradores](./08-mapa-de-status.md) ## Sandbox A sandbox militar **conecta na Zetra real de homologação** — não há whitelist local. Os exemplos de CPF/matrícula/token nesta página (`45507529710`, `146254221`, etc.) são apenas placeholders ilustrativos. Solicite ao time de Integrações QI Tech os dados reais cadastrados em `central_homologa.econsig.com.br`. → [Mocks (Sandbox)](./09-mocks-sandbox.md) --- # Mocks (Sandbox) URL: /documentation/manual_exercito/mocks-sandbox :::caution Sandbox militar usa Zetra real de homologação Ao contrário do SIAPE, o `military-payroll-api` em sandbox **NÃO usa mocks locais**. Em sandbox a integração aponta para o endpoint Host-a-Host de homologação da Zetra (eConsig): - Sandbox: `https://www.econsig.com.br/central_homologa/services/HostaHostService-v8_0?wsdl` - Produção: `https://api.econsig.com.br/central/services/HostaHostService` Os dados de teste (CPFs, matrículas, tokens) são fornecidos **pela própria Zetra** via planilha de homologação oficial. **Suporte Zetra:** suporte@econsig.com.br. ::: ## Convênio QI Sociedade — Exército Brasileiro | Item | Valor | |---|---| | **Cliente** | `QI_SOCIEDADE` | | **Convênio** | `QI_SOCIEDADE-EB` | | **Usuário API** | `qi_sociedade_xml` | | **Senha API** | `qi12345` | | **Código Serviço** | `001` | | **Descrição Serviço** | `EMPRÉSTIMO` | | **Código Verba** | `ZQD` | ## Servidores de Teste Servidores fictícios cadastrados na Zetra homologação. Todos com **senha do servidor** = `abc123`. ### Cenário: Margem Negativa Servidor sem margem disponível — toda tentativa de reserva retorna falha. | # | Matrícula | CPF | Data Nascimento | |---|---|---|---| | 1 | `132722899` | `279.315.128-98` | 1983-04-01 | | 2 | `143320397` | `213.628.178-05` | 1978-02-17 | ### Cenário: Margem Limite R$ 500,00 Margem reduzida — útil para testar limites e validação `INSUFFICIENT_MARGIN`. | # | Matrícula | CPF | Data Nascimento | |---|---|---|---| | 3 | `346578694` | `432.108.069-00` | 1997-04-21 | | 4 | `982435311` | `432.108.069-00` | 1993-03-20 | > [!info] > Matrículas 3 e 4 compartilham o mesmo CPF — útil para testar cenário "mesmo militar, múltiplas matrículas/órgãos". ### Cenário: Margem Limite R$ 10.000,00 Margem confortável — usar para testar fluxos completos de margem livre, refinanciamento e portabilidade. | # | Matrícula | CPF | Data Nascimento | |---|---|---|---| | 5 | `346578694` | `540.770.447-15` | 1997-04-21 | | 6 | `961683333` | `734.119.817-68` | 1963-04-09 | ### Cenário: BLOQUEADO Servidor com bloqueio em folha — Zetra retorna `military_blocked` (código 352). | # | Matrícula | CPF | Data Nascimento | |---|---|---|---| | 7 | `234674321` | `045.672.387-02` | 1975-01-01 | | 8 | `342542124` | `472.635.472-87` | 1964-03-06 | ## Como mapear nos payloads QI Quando construir o payload de `POST /military_payroll/balance`: ```json { "document_number": "27931512898", "registration_code": "132722899", "authorization_document_key": "", "token": "abc123" } ``` - `document_number` — CPF sem máscara (remova `.` e `-` da tabela acima). - `registration_code` — matrícula direto da tabela. - `token` — senha do servidor (`abc123` para todos os testes). - `authorization_document_key` — upload de qualquer PDF/PNG; em sandbox a Zetra não valida o conteúdo do termo. ## Webhook esperado por cenário | Cenário | Webhook `military_payroll.balance.status_change` | |---|---| | Margem Negativa (1, 2) | `status: failed`, `failure_reason: invalid_balance` ou `consignable_margin_exceeded` | | Margem Limite R$ 500 (3, 4) | `status: succeeded`, `balance: 500.00`, `allowed_installment_numbers: [...]` | | Margem Limite R$ 10.000 (5, 6) | `status: succeeded`, `balance: 10000.00`, `allowed_installment_numbers: [...]` | | BLOQUEADO (7, 8) | `status: failed`, `failure_reason: military_blocked` (Zetra 352) | | CPF/matrícula fora da tabela | `status: failed`, `failure_reason: military_not_found` (Zetra 293) ou `invalid_registration_code` (Zetra 210) | ## Fluxo end-to-end recomendado Para validar margem livre, use **teste 5** ou **teste 6** (margem alta): 1. `POST /upload` com PDF qualquer → `document_key`. 2. `POST /military_payroll/balance` com `27931512898` (margem negativa, pra testar failure) ou `54077044715` (margem 10k). 3. Aguardar webhook `military_payroll.balance.status_change`. 4. Em caso de sucesso, `POST /debt_simulation` com `installment_face_value` ≤ `balance` retornado. 5. `POST /debt` com `reservation_method: creation` (margem livre) ou `refinancing` (port/refin). 6. Aguardar webhook `credit_operation.collateral` (`successfully_accepted` → `successfully_reserved`). 7. `POST /debt/{KEY}/signed` com QI Sign ou data-signature opt-in. 8. Aguardar webhook `debt` (`disbursed`). 9. (opcional cancelamento) `PATCH /debt/{KEY}/cancel` dentro de 7 dias úteis → recebe PIX QR → simular pagamento → webhook `reversal`. Para testar **portabilidade** com contrato externo, combine teste 5 ou 6 com um `original_contract_number` fictício (Zetra homologação aceita strings arbitrárias nesse campo durante port em sandbox). ## Códigos Zetra observados em sandbox | Código | Mensagem | Mapeamento na QI | |---|---|---| | `000` | Operação realizada com sucesso | `succeeded` | | `210` | Matrícula inválida | `invalid_registration_code` | | `241` | Erro de comunicação | `communication_error` (QI retenta automaticamente) | | `293` | Militar não encontrado | `military_not_found` | | `352` | Militar bloqueado em folha | `military_blocked` | | `359` | Margem consignável excedida | `consignable_margin_exceeded` | | `360` | Margem disponível verificada | retorno de `consultarMargem` | ## Operação 24/7 em sandbox A Zetra em homologação opera **24h/dia, todos os dias** — sem janela operacional restrita (mesmo comportamento da produção). ## Reset de reservas Reservas Zetra em homologação **persistem indefinidamente** salvo cancelamento explícito. Limpe seu ambiente cancelando as reservas que não forem necessárias (`PATCH /debt/{KEY}/cancel`). ## Não há mocks locais ativos O arquivo `src/connectors/zetra_mocker.py` no repo `military-payroll-api` existe mas **não é invocado** no fluxo de runtime — `EconsigConnector` chama diretamente o `ECONSIG_SERVICE_ADDRESS` configurado por ambiente. Se algum dia for necessário introduzir mocks locais (ex: Zetra fora do ar bloqueando QA), o `ZetraMocker` está disponível para ser ativado, mas hoje **toda integração de teste passa pela Zetra real de homologação**. --- # Portabilidade + Refinanciamento URL: /documentation/manual_exercito/portabilidade-refin Fluxo de **compra de dívida de consignado militar** (Exército) via assinatura em lote. A QI Tech emite uma CCB de quitação (`debt_purchase`) que paga o banco vendedor, uma CCB de portabilidade (`portability`) que porta o contrato, e um `refinancing` consolidador **sempre obrigatório** que carrega seguro e troco. Tudo assinado uma única vez via QI Sign. :::info Contas por operação Cada operação do fluxo exige uma conta de desembolso distinta: - **`debt_purchase`** → **conta interna QI** em nome do tomador. O desembolso cai nessa conta e quita a dívida origem no banco vendedor via `after_disbursement_actions` (boleto/PIX). - **`refinancing`** → **conta externa do tomador**. O troco do refinanciamento é desembolsado nessa conta. O parceiro abre a conta interna via `POST /account` antes da emissão. Ver [Conta Interna para Desembolso](./10-conta-interna-desembolso.md). ::: ## Cenários O `refinancing` consolidador é **sempre obrigatório** no batch militar — é ele quem carrega seguro e troco. | Cenário | Composição | Quando usar | |---|---|---| | **α** | 1× `debt_purchase` + 1× `portability` + 1× `refinancing` | Porta **uma** dívida externa | | **β** | N× `debt_purchase` + N× `portability` + 1× `refinancing` | Porta **N dívidas** externas num único envelope | | **γ** | α ou β + `financial.rebates` no `refinancing` | Qualquer composição acima com prêmio de seguro — gera `insurance_premium_term` automaticamente | :::caution Regra do seguro e do troco Seguro (`financial.rebates` com `fee_type: "insurance_premium_qi"`) e troco só podem ser enviados no `refinancing` consolidador (Passo 6). - **`debt_purchase`** — `rebates` proibido (CCB de quitação não carrega seguro). - **`portability`** — `rebates` proibido **e** `final_disbursement_amount` deve ser `0`. ::: ## Sequência de chamadas ``` 0. POST /debt_simulation (opcional — condições do refinanciamento consolidado) 1. POST /upload (documentos do tomador) 2. POST /account (conta interna QI p/ debt_purchase) 3. POST /document/document_batch → criar envelope de assinatura 4. POST /debt (debt_purchase) → desembolso em conta interna QI 5. POST /debt (portability) → sem troco, sem seguro 6. POST /debt (refinancing) → seguro + troco em conta externa 7. PUT /document/document_batch/{key}/send_to_signature ``` :::caution Ordem obrigatória de inserção no batch `debt_purchase` deve ser inserido **antes** da `portability` que o referencia, e a `portability` **antes** do `refinancing` consolidador. Inverter a ordem dispara: - **`DOC000110`** (HTTP 422) — `portability` cujo `refinanced_credit_operations[].operation_key` não casa com nenhum `debt_purchase` já inserido no batch. - **`DOC000112`** (HTTP 422) — `refinancing` cujo `refinanced_credit_operations[].operation_key` não casa com nenhuma `portability` já inserida no batch. ::: --- ## 0. Simulação (opcional) Antes de abrir o lote é possível simular as condições da operação consolidada — parcela, prazo, IOF, CET e troco — sem criar nada. A simulação é **uma só**, feita sobre o `refinancing` consolidador: as dívidas portadas entram como itens de `refinanced_credit_operations`. Não se simula `debt_purchase` nem `portability` separadamente. ENDPOINT /debt_simulation MÉTODO POST :::info Como a dívida portada entra na simulação Cada item de `refinanced_credit_operations` pode ser informado de duas formas: - **Dívida externa** (ainda não existe na QI Tech) — informe `due_balance` com o saldo devedor do contrato no banco vendedor. Opcionalmente envie também `monthly_interest_rate` e `disbursement_date` da operação de origem: com esses dois campos a QI Tech **corrige o saldo** até a data de desembolso da nova operação; sem eles, o `due_balance` é usado exatamente como enviado. - **Operação QI ativa** (refinanciamento puro) — informe `credit_operation_key`. O saldo devedor é calculado pela QI Tech. ::: **Request Body** **Dívida externa (port + refin)** ```json { "borrower": { "person_type": "natural", "individual_document_number": "45507529710" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 500.00, "disbursement_date": "2026-06-01", "number_of_installments": 24, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 } }, "collaterals": [ { "collateral_type": "military_payroll", "percentage": 1, "collateral_data": { "reservation_type": "refinancing", "registration_code": "146254221" } } ], "refinanced_credit_operations": [ { "due_balance": 8500.00, "monthly_interest_rate": 0.0225, "disbursement_date": "2024-03-15", "original_deadline": 60 } ] } ``` **Operação QI ativa (refin puro)** ```json { "borrower": { "person_type": "natural", "individual_document_number": "45507529710" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 500.00, "disbursement_date": "2026-06-01", "number_of_installments": 24, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 } }, "collaterals": [ { "collateral_type": "military_payroll", "percentage": 1, "collateral_data": { "reservation_type": "refinancing", "registration_code": "146254221" } } ], "refinanced_credit_operations": [ { "credit_operation_key": "" } ] } ``` **Simulando pelo troco desejado** ```json { "borrower": { "person_type": "natural", "individual_document_number": "45507529710" }, "financial": { "first_due_date": "2026-07-01", "final_disbursement_amount": 2000.00, "disbursement_date": "2026-06-01", "number_of_installments": 24, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 } }, "collaterals": [ { "collateral_type": "military_payroll", "percentage": 1, "collateral_data": { "reservation_type": "refinancing", "registration_code": "146254221" } } ], "refinanced_credit_operations": [ { "due_balance": 8500.00, "monthly_interest_rate": 0.0225, "disbursement_date": "2024-03-15" } ] } ``` ### Campos chave | Campo | Descrição | |---|---| | `collaterals[].collateral_type` | **`military_payroll`** (obrigatório) | | `collaterals[].collateral_data.reservation_type` | **`refinancing`** — a simulação representa o consolidador, mesmo quando há portabilidade de dívida externa | | `collaterals[].collateral_data.registration_code` | Matrícula do militar no Zetra | | `refinanced_credit_operations[].due_balance` | Saldo devedor da dívida portada. Obrigatório quando a dívida é **externa** (não existe `credit_operation_key`) | | `refinanced_credit_operations[].monthly_interest_rate` | Taxa mensal do contrato de origem — usada, junto com `disbursement_date`, para corrigir o `due_balance` até o desembolso da nova operação | | `refinanced_credit_operations[].disbursement_date` | Data de desembolso do contrato de origem | | `refinanced_credit_operations[].original_deadline` | Prazo original do contrato de origem (informativo) | | `refinanced_credit_operations[].credit_operation_key` | Chave da operação QI a refinanciar — alternativa ao `due_balance` | | `financial.installment_face_value` | Parcela desejada — ≤ `balance` retornado na [Consulta de Margem](./02-consulta-margem.md) | | `financial.final_disbursement_amount` | Troco desejado. Alternativa ao `installment_face_value`: o valor financiado vira `soma dos due_balance + troco` | | `financial.number_of_installments` | Prazo — ∈ `allowed_installment_numbers` | :::tip Cenário β (N dívidas portadas) Para simular a portabilidade de **N** dívidas externas num único envelope, envie **N itens** em `refinanced_credit_operations`, cada um com seu `due_balance`. A simulação devolve as condições do consolidador que quita todas elas. ::: :::note Diferenças em relação à emissão - `modality.code` **não** é necessário na simulação — só na emissão (`POST /debt`) da `portability` e do `refinancing`. - Não é preciso enviar `document_batch_key`, `disbursement_bank_account`, `purchaser_document_number` nem os dados cadastrais completos do tomador: na simulação o `borrower` se resume a `person_type` + `individual_document_number`. - `portability_data` (com `origin_econsig_id` e `token`) também não entra na simulação — é exigido só na emissão da `portability`. ::: ### Response Síncrona — retorna `disbursement_options[]` com cronograma de parcelas, IOF, CET e, quando há refinanciamento, o `due_balance` corrigido de cada dívida portada. --- ## 1. Upload dos documentos Antes de abrir a conta e o lote, faça o **upload dos documentos** exigidos na operação via `POST /upload`. Cada chamada retorna um `document_key`, identificador do documento referenciado nas etapas seguintes. ENDPOINT /upload MÉTODO POST → Autenticação, headers, FormData e exemplos de código (Python / Node.js) em [Upload de Documentos](../upload_de_documentos/upload_de_documentos.md) . :::caution Atenção Salve o `document_key` retornado — ele é necessário para a consulta e o uso futuro do documento. ::: --- ## 2. Abrir a conta interna em nome do tomador Em **compra de dívida**, **portabilidade** e **refinanciamento** do consignado militar (Exército), o desembolso da operação **não vai direto para a conta externa do tomador**: ele cai numa conta interna **em nome do tomador** (aberta pelo parceiro via `POST /account`). É a partir dessa conta que a QI executa as ações pós-desembolso — **quitação do contrato externo**, **repasse de troco**, **conciliação**. ENDPOINT /account MÉTODO POST A conta é aberta pelo **parceiro** (autenticado com seus `client_integration_key`), com `account_owner.individual_document_number` apontando para o **CPF do militar tomador**. Reutilize a conta existente — uma por tomador (não abra uma nova a cada operação). O campo `account_owner.document_identification` recebe o `document_key` retornado no **Passo 1** (upload do documento de identificação do tomador). **Request Body** ```json { "account_owner": { "person_type": "natural", "name": "JOÃO DA SILVA", "email": "joao@email.com", "individual_document_number": "", "mother_name": "MARIA DA SILVA", "birth_date": "1985-03-12", "is_pep": false, "document_identification": "", "phone": { "country_code": "055", "area_code": "11", "number": "900000000" }, "address": { "street": "Eixo Monumental", "state": "DF", "city": "Brasília", "neighborhood": "Asa Sul", "number": "215", "postal_code": "70000000" } } } ``` ### Campos chave | Campo | Tipo | Descrição | |---|---|---| | `account_owner.person_type` | string | Fixo: **`natural`** (pessoa física) | | `account_owner.individual_document_number` | string | **CPF do militar tomador** | | `account_owner.document_identification` | string (UUID) | `document_key` do documento enviado no **Passo 1** | | `account_owner.is_pep` | boolean | Indica se o tomador é pessoa politicamente exposta | **Response Body** ```json { "account_key": "1167955-...", "account_branch": "0001", "account_number": "1167955", "account_digit": "1", "owner_document_number": "", "owner_name": "", "bank_code": "329", "account_status": "active" } ``` :::tip Idempotência por tomador Se já existe conta ativa para esse `owner_document_number` no parceiro, evite chamar `POST /account` de novo — consulte `GET /accounts?owner_document_number= ` antes e reaproveite o `account_key` retornado. ::: --- ## 3. Abrir o lote ENDPOINT /document/document_batch MÉTODO POST **Request Body** ```json { "type": "military_payroll_external_batch", "certifier_type": "qi_sign", "batch_name": "Lote EB portabilidade - ", "request_control_key": "" } ``` ### Campos chave | Campo | Tipo | Descrição | |---|---|---| | `type` | string | Fixo: **`military_payroll_external_batch`** | | `certifier_type` | string | Fixo: **`qi_sign`** | | `batch_name` | string | Nome identificador do lote — **único** (não reutilize entre lotes) e **máximo 100 caracteres** | | `request_control_key` | string (UUIDv4) | **Idempotência** — não reutilize entre lotes | **Response Body** ```json { "document_batch_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc" } ``` Guarde o `document_batch_key` retornado — ele é referenciado em todas as chamadas seguintes. → Para consultar, limpar documentos ou conferir o batch antes do envio, ver [Assinatura em Lote](./11-assinatura-em-lote.md). --- ## 4. Emitir `debt_purchase` CCB de **quitação da dívida original**. A QI Tech vai pagar o banco vendedor. ENDPOINT /debt MÉTODO POST :::info Particularidades do `debt_purchase` - `document_batch_key` incluído na **raiz** do payload (mesmo nível de `borrower`, `financial`). - `disbursement_bank_account` aponta para a **conta interna QI** do tomador (criada no Passo 2). - `collaterals` vazio — o `debt_purchase` é a operação-ponte que carrega o saldo externo; **não** leva colateral. - `after_disbursement_actions` na raiz define a quitação automática da dívida origem após o desembolso (boleto ou PIX do banco vendedor). ::: **Request Body** ```json { "borrower": { "name": "JOÃO DA SILVA", "email": "joao@email.com", "phone": { "number": "900000000", "area_code": "11", "country_code": "055" }, "is_pep": false, "address": { "city": "Brasília", "state": "DF", "number": "215", "street": "Eixo Monumental", "complement": "", "postal_code": "70000000", "neighborhood": "Asa Sul" }, "role_type": "issuer", "birth_date": "1985-03-12", "mother_name": "MARIA DA SILVA", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "single", "individual_document_number": "45507529710", "gender": "male", "document_identification_type": "rg", "document_identification_number": "1234567", "document_identification_date": "2015-01-01" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 100, "disbursement_date": "2026-06-01", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "simplified": true, "collaterals": [], "requester_identifier_key": "", "disbursement_bank_account": { "bank_code": "329", "account_digit": "1", "branch_number": "0001", "account_number": "1167955", "document_number": "45507529710", "name": "JOÃO DA SILVA" }, "purchaser_document_number": "", "document_batch_key": "", "after_disbursement_actions": [ { "action_type": "bankslip_payment", "action_data": { "qr_code": null, "destination": null, "digitable_line": "03399199530490000005237385601010297590005474921", "pix_transfer_type": null, "transaction_amount": 0 } } ] } ``` ### Campos que devem ser alterados | Campo | Obrigatório alterar? | Observação | |---|---|---| | `document_batch_key` | ✅ Sim | Valor retornado no Passo 3 | | `borrower.*` | ✅ Sim | Dados reais do tomador | | `financial.first_due_date` / `disbursement_date` | ✅ Sim | Conforme calendário da operação | | `financial.installment_face_value` / `number_of_installments` / `monthly_interest_rate` | ✅ Sim | Conforme condições comerciais | | `purchaser_document_number` | ✅ Sim | CNPJ do comprador (via variável de ambiente) | | `requester_identifier_key` | ✅ Sim | UUIDv4 único por requisição | | `disbursement_bank_account` | ✅ Sim | **Conta interna QI em nome do tomador** (Passo 2). O `account_branch` da resposta do `POST /account` vai no campo `branch_number` | | `after_disbursement_actions` | ✅ Sim | Quitação da dívida origem. `action_type`: `bankslip_payment` (boleto) ou PIX. Preencha `digitable_line` (boleto) ou `qr_code` (PIX) do banco vendedor | **Response Body** ```json { "proposal_id": "", "status": 200, "key": "", "data": { "credit_operation_key": "", "status": "waiting_signature" } } ``` **Guarde a `key` retornada** — ela é passada em `refinanced_credit_operations[].operation_key` da `portability` correspondente. --- ## 5. Emitir `portability` CCB de **portabilidade da dívida**. Cada portabilidade referencia **exatamente um** `debt_purchase` via `refinanced_credit_operations`. **Não carrega seguro nem troco** — ambos vão no `refinancing` consolidador. ENDPOINT /debt MÉTODO POST :::info Particularidades da `portability` - `collaterals[0].collateral_type` é **`military_payroll`** com `reservation_type: "portability"`. - `collaterals[0].collateral_data.portability_data` é **obrigatório** — contém o `origin_econsig_id` (contrato de origem no Zetra) e o `token` do militar. - `refinanced_credit_operations` carrega a `key` do `debt_purchase` correspondente. - `modality.code` **`"0202"`** é obrigatório em portabilidade/refinanciamento do Exército. ::: :::caution Portabilidade sem seguro e sem troco Em batch militar, a `portability` **não pode** carregar `financial.rebates` (seguro). O seguro é enviado exclusivamente no `refinancing` consolidador. A QI Tech rejeita o `POST /debt` que violar essa regra. ::: **Request Body** ```json { "borrower": { "...": "mesmo borrower do Passo 4" }, "financial": { "first_due_date": "2026-07-01", "disbursement_date": "2026-06-01", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "final_disbursement_amount": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "military_payroll", "collateral_data": { "reservation_type": "portability", "reservation_method": "issuing", "registration_code": "146254221", "token": "12345678", "portability_data": { "origin_econsig_id": "2016587", "token": "12345678" } } } ], "modality": { "code": "0202" }, "requester_identifier_key": "", "disbursement_bank_account": { "...": "mesma conta interna do Passo 4" }, "purchaser_document_number": "", "document_batch_key": "", "refinanced_credit_operations": [ { "operation_key": "" } ] } ``` ### Campos que devem ser alterados | Campo | Obrigatório alterar? | Observação | |---|---|---| | `document_batch_key` | ✅ Sim | Valor retornado no Passo 3 | | `refinanced_credit_operations[0].operation_key` | ✅ Sim | `key` do `debt_purchase` referenciado (Passo 4) | | `collaterals[0].collateral_data.registration_code` | ✅ Sim | Matrícula do militar no Zetra | | `collaterals[0].collateral_data.token` | ✅ Sim | Token Zetra do militar | | `collaterals[0].collateral_data.portability_data.origin_econsig_id` | ✅ Sim | ID do contrato de origem no Zetra (e-consignado da instituição vendedora) | | `collaterals[0].collateral_data.portability_data.token` | ✅ Sim | Token Zetra do militar | | `modality.code` | 🚫 Fixo | Sempre `"0202"` em portabilidade/refinanciamento do Exército | | `financial.installment_face_value` | 🚫 Não enviar | Valor da parcela (auto calculado) | | `financial.rebates` | 🚫 Proibido | Seguro não é aceito em portabilidade — só no `refinancing` | **Response Body** ```json { "proposal_id": "", "status": 200, "key": "", "data": { "credit_operation_key": "", "status": "waiting_signature" } } ``` **Guarde a `key` desta portabilidade** — usada em `refinanced_credit_operations` do `refinancing` consolidador (Passo 6). ### Erros possíveis na criação | Código | HTTP | Quando | |---|---|---| | `DOC000110` | 422 | `refinanced_credit_operations[].operation_key` não casa com nenhum `credit_operation_key` de `debt_purchase` já inserido no batch | | `DOC000114` | 422 | `refinanced_credit_operations[].operation_key` já está em outra portabilidade do mesmo batch (duplicidade) | | `COP000515` | 400 | `final_disbursement_amount` ≠ `0` — portabilidade não carrega troco | | `COP000516` | 400 | `financial.rebates` presente — portabilidade não aceita seguro | | `INVALID_MODALITY_CODE` | 400 | portabilidade sem `modality.code: "0202"` | --- ## 6. Emitir `refinancing` consolidador CCB **mãe** que consolida as portabilidades num único instrumento. **Sempre obrigatória** no batch militar — tanto no cenário α (1 portabilidade) quanto no β (N portabilidades). É a única operação do fluxo que carrega **seguro** e **troco**. ENDPOINT /debt MÉTODO POST :::info Particularidades do `refinancing` consolidador - `collaterals[0].collateral_type` é **`military_payroll`** com `reservation_type: "refinancing"`. - `refinanced_credit_operations` lista as `key` de **todas** as portabilidades do batch. - `disbursement_bank_account` aponta para a **conta externa do tomador** — destino do troco. - `modality.code` **`"0202"`** é obrigatório. - `financial.rebates` é **opcional** — único lugar do fluxo que aceita seguro. - `after_disbursement_actions` só é enviado **quando há seguro** — liquida o prêmio após o desembolso. ::: :::caution `after_disbursement_actions` exige seguro `after_disbursement_actions` só pode ser enviado no `refinancing` **quando a operação tem seguro** (`financial.rebates` presente). Enviar `after_disbursement_actions` sem `rebates` faz a QI Tech rejeitar o `POST /debt`. ::: **Request Body** **Sem seguro** ```json { "borrower": { "...": "mesmo borrower" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 1000, "disbursement_date": "2026-06-01", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "military_payroll", "collateral_data": { "reservation_type": "refinancing", "reservation_method": "issuing", "registration_code": "146254221", "token": "12345678" } } ], "modality": { "code": "0202" }, "requester_identifier_key": "", "disbursement_bank_account": { "...": "conta externa do tomador" }, "purchaser_document_number": "", "document_batch_key": "", "refinanced_credit_operations": [ { "operation_key": "" }, { "operation_key": "" } ] } ``` **Com seguro + troco (Cenário γ)** ```json { "borrower": { "...": "mesmo borrower" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 1500, "disbursement_date": "2026-06-01", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "rebates": [ { "fee_type": "insurance_premium_qi", "description": "credit_insurance_blindado" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "military_payroll", "collateral_data": { "reservation_type": "refinancing", "reservation_method": "issuing", "registration_code": "146254221", "token": "12345678" } } ], "modality": { "code": "0202" }, "requester_identifier_key": "", "disbursement_bank_account": { "...": "conta externa do tomador" }, "purchaser_document_number": "", "document_batch_key": "", "refinanced_credit_operations": [ { "operation_key": "" }, { "operation_key": "" } ], "after_disbursement_actions": [ { "action_type": "bankslip_payment", "action_data": { "qr_code": null, "destination": null, "digitable_line": "03399199530490000005237385601010297590005474921", "pix_transfer_type": null, "transaction_amount": 0 } } ] } ``` ### Campos que devem ser alterados | Campo | Obrigatório alterar? | Observação | |---|---|---| | `document_batch_key` | ✅ Sim | Valor retornado no Passo 3 | | `refinanced_credit_operations` | ✅ Sim | **Todas** as `key` das portabilidades emitidas no Passo 5 | | `collaterals[0].collateral_data.registration_code` | ✅ Sim | Matrícula do militar no Zetra | | `collaterals[0].collateral_data.token` | ✅ Sim | Token Zetra do militar | | `reservation_method` | ✅ Sim | Sempre `"issuing"` para o consolidador | | `modality.code` | 🚫 Fixo | Sempre `"0202"` | | `disbursement_bank_account` | ✅ Sim | **Conta externa do tomador** — destino do troco | | `financial.rebates` | ⚠️ Opcional | Único lugar do fluxo que aceita seguro. Incluir `[{ "fee_type": "insurance_premium_qi", ... }]` apenas se a operação tem seguro | | `financial.final_disbursement_amount` | 🚫 Não enviar | Valor final do desembolso (troco) calculado automaticamente baseado no valor da parcela | | `after_disbursement_actions` | ⚠️ Só com seguro | Liquida o prêmio do seguro após desembolso. **Só envie quando `rebates` está presente** — caso contrário a QI Tech rejeita o `POST /debt` | ### Erros possíveis na criação | Código | HTTP | Quando | |---|---|---| | `DOC000109` | 422 | Batch já contém outro `refinancing` — só 1 por batch | | `DOC000112` | 422 | `refinanced_credit_operations[].operation_key` não casa com nenhum `credit_operation_key` de portabilidade no batch | | `COP000517` | 400 | `refinancing` **com** seguro (`rebates`) sem nenhuma `after_disbursement_actions` — seguro exige ao menos uma ação pós-desembolso | | `COP000518` | 400 | `refinancing` **sem** seguro carregando `after_disbursement_actions` — só permitido quando há `rebates` | | `INVALID_MODALITY_CODE` | 400 | refinanciamento sem `modality.code: "0202"` | --- ## 7. Enviar para assinatura Fecha o lote e dispara os documentos para o QI Sign. **Antes desse PUT, nada é enviado ao militar.** ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY/send_to_signature MÉTODO PUT Body: `{}`. Response: **HTTP 200**. ### Erros possíveis no envio | Código | HTTP | Quando | |---|---|---| | `DOC000108` | 422 | Batch contém mais de 1 `insurance_premium_term` | | `DOC000109` | 422 | Batch contém mais de 1 `refinancing` | | `DOC000110` | 422 | `portability` cujo `refinanced_op` não casa com nenhum `debt_purchase` no batch | | `DOC000111` | 422 | Batch **sem** `refinancing` consolidador | | `DOC000114` | 422 | `debt_purchase` referenciado por 0 ou mais de 1 portabilidade | :::tip Conferir antes de enviar Use `GET /document/document_batch/DOCUMENT_BATCH_KEY` para listar os documentos agrupados e confirmar a composição antes do `send_to_signature`. Ver [Assinatura em Lote](./11-assinatura-em-lote.md). ::: → Próximo passo: [Formalização](./05-formalizacao.md) --- ## Mapa consolidado de erros | Código | HTTP | Ponto de disparo | Quando | |---|---|---|---| | `DOC000108` | 422 | criação + envio | Mais de 1 `insurance_premium_term` no batch | | `DOC000109` | 422 | criação + envio | Mais de 1 `refinancing` no batch | | `DOC000110` | 422 | criação + envio | `portability` com `refinanced_op` sem `debt_purchase` casado no batch | | `DOC000111` | 422 | envio | Batch sem `refinancing` consolidador | | `DOC000112` | 422 | criação | `refinancing` com `refinanced_op` sem portabilidade casada no batch | | `DOC000114` | 422 | criação + envio | `debt_purchase` referenciado por ≠ 1 portabilidade (0 órfão ou ≥ 2 duplicado) | | `COP000515` | 400 | criação (`portability`) | `final_disbursement_amount` ≠ `0` na portabilidade | | `COP000516` | 400 | criação (`portability`) | `financial.rebates` enviado na portabilidade | | `COP000517` | 400 | criação (`refinancing`) | `refinancing` com seguro sem nenhuma `after_disbursement_actions` | | `COP000518` | 400 | criação (`refinancing`) | `refinancing` sem seguro carregando `after_disbursement_actions` | | `INVALID_MODALITY_CODE` | 400 | criação (`portability`/`refinancing`) | operação sem `modality.code: "0202"` | :::info Notas sobre erros recorrentes - `DOC000110` dispara em **dois momentos**: na criação da portabilidade (validação imediata) e no envio (cobertura defensiva). - `DOC000114` dispara em **dois momentos**: na criação da segunda portabilidade duplicada e no envio (cobre o `debt_purchase` órfão, i.e. `count = 0`). - `DOC000111` dispara **apenas no envio** — não há validação na criação. - Batches que **não** são `military_payroll_external_batch` não disparam nenhuma das validações acima. ::: --- ## Glossário | Termo | Significado | |---|---| | **CCB** | Cédula de Crédito Bancário — instrumento de dívida emitido pelo banco | | **Zetra** | Sistema de gestão do e-consignado militar (Exército) — onde a reserva de margem é averbada | | **matrícula militar** | `registration_code` — identificador do militar no Zetra | | **token** | Token Zetra do militar — autoriza a operação de consignado (6 a 8 caracteres) | | **portability_data** | Dados do contrato de origem no Zetra (`origin_econsig_id`, `token`) da instituição vendedora | | **origin_econsig_id** | ID do e-consignado de origem no Zetra — o contrato externo que está sendo portado | | **modality.code** | Código de modalidade do consignado militar — **`"0202"`** para portabilidade/refinanciamento | | **credit_operation_key** | Chave única da operação retornada por `POST /debt` — também chamada `key` | | **insurance_premium_term** | Documento extra gerado automaticamente no batch quando uma `portability` ou `refinancing` carrega `financial.rebates` com `fee_type: "insurance_premium_qi"`. **Nunca** originado de `debt_purchase` | | **QI Sign** | Provedor de assinatura digital QI Tech (configurado via `certifier_type: "qi_sign"`) | --- # Webhooks URL: /documentation/manual_exercito/webhooks Eventos assíncronos emitidos pela QI Tech durante o ciclo de vida da operação consignada militar. Todos seguem o protocolo unificado de [Webhooks QI](/documentation/webhooks/notificacoes_baas_e_laas) — 5 segundos pra resposta HTTP 200 com `encoded_body` assinado, 3 retries de 5 minutos em caso de falha. :::danger Atenção! Os webhooks da QI Tech **não devem ser mapeados de forma restrita**. Campos adicionais podem ser incluídos aos payloads a qualquer momento. Use desserialização permissiva. ::: ## Webhooks específicos do produto militar | Webhook | Quando dispara | Origem | |---|---|---| | `military_payroll.balance.status_change` | Resultado da consulta de margem (`succeeded` ou `failed`) | military-payroll-api | | `military_payroll.due_balance.status_change` | Saldo devedor (usado em refin/port) | military-payroll-api | | `military_payroll.portability_contracts_report.status_change` | Relatório de contratos pra portabilidade | military-payroll-api | | `credit_operation.collateral` | Averbação ou desaverbação no Zetra | credit-operation-api | ## Webhooks comuns LaaS | Webhook | Status | Quando dispara | |---|---|---| | `debt` | `waiting_signature` | Operação criada, aguardando assinatura | | `debt` | `signature_finished` | Assinatura concluída | | `debt` | `disbursed` | Desembolso PIX/TED enviado | | `debt` | `canceled` | Operação cancelada (ver `cancel_reason_enumerator`) | | `debt` | `canceled_permanently` | Cancelamento definitivo | | `debt` | `settled` | Operação liquidada (parcelas pagas) | | `reversal` | `pending_fund` | Borrower pagou PIX QR de cancelamento — reversal iniciado | | `credit_transfer.received_portability` | — | Portabilidade externa recebida (banco origem aceitou) | | `credit_transfer_status_change` | — | Atualização do credit-transfer | | `installment.status_change` | `paid` / `overdue` / etc | Mudança de status de parcela individual | | `laas.devolution.refund_receipt` | `refunded` | Devolução de overpayment via PIX | ## Estrutura padrão do payload Todos os webhooks LaaS seguem essa forma básica: ```json { "key": "", "data": , "status": "", "webhook_type": "", "event_datetime": "2026-06-01 14:30:00" } ``` ## Exemplos ### `military_payroll.balance.status_change` (sucesso) ```json { "webhook_type": "military_payroll.balance.status_change", "key": "81da8afb-e1b2-4215-8093-c4b5feab8a9f", "status": "succeeded", "data": { "balance": 3500.00, "allowed_installment_numbers": [24, 36, 48, 60], "military_unit": "AMAN", "military_branch": "Sistema de Retribuição do Exterior", "category": "ATIVO", "name": "JOÃO DA SILVA", "document_number": "45507529710", "registration_code": "146254221", "birth_date": "1985-03-12", "grant_date": "2010-05-15" }, "event_datetime": "2026-06-01 14:30:00" } ``` ### `credit_operation.collateral` (averbação reservada) ```json { "webhook_type": "credit_operation.collateral", "key": "27a099df-4688-43cb-87fa-515b1cf343a5", "status": "success", "data": { "collateral_constituted": true, "enumerator": "successfully_reserved", "reservation_status": "reserved" }, "event_datetime": "2026-06-01 15:00:00" } ``` ### `debt` (cancelado) ```json { "webhook_type": "debt", "key": "27a099df-4688-43cb-87fa-515b1cf343a5", "status": "canceled", "data": { "cancel_reason": "Operação cancelada manualmente", "cancel_reason_enumerator": "manual" }, "event_datetime": "2026-06-01 16:00:00" } ``` ### `reversal` (cancelamento pós-desembolso) ```json { "webhook_type": "reversal", "credit_operation_key": "2893b8bd-8f4e-4e45-9325-fc7003beb869", "contract_number": "0000049333/TW", "reversal": { "status": "pending_fund", "amount": 2026.93, "amount_to_send": 2026.93, "is_total": true, "is_operation_canceled": true, "reversal_key": "eb0bbd1d-111d-4a61-bb65-c1f66a005ea2", "date": "2026-09-06" } } ``` ## Cancel reasons (`cancel_reason_enumerator`) | Enumerador | Significado | |---|---| | `manual` | Cancelado via API ou portal | | `waiting_signature` | Não assinou no prazo | | `not_collateral_constituted` | Averbação falhou (consent_refused, consent_expired, etc.) | | `is_portability` | Portabilidade falhou | | `pix_max_retry` | Muitas falhas no desembolso PIX | | `lack_of_resource` | Sem recurso pra desembolsar | | `kyc_not_accepted` | KYC reprovado | | `agencia_conta_invalida` | Erro em dados bancários do desembolso | | `invalid_account` | Conta inválida | | `rejected_payment` | Pagamento recusado pelo banco destino | → Lista completa em [Mapa de Status](./08-mapa-de-status.md) ## Reenvio Manual Webhooks podem ser consultados e reenviados via portal seguindo [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). --- # Manual Previdência Privada - Averbação e Desembolso URL: /documentation/manual_previdencia_privada/manual_previdencia_privada_averbacao_desembolso :::info Navegação - [Crédito Novo](/documentation/manual_previdencia_privada/manual_previdencia_privada_credito_novo) (anterior) ::: :::caution API em desenvolvimento A API ainda está em fase de desenvolvimento, sendo assim, este manual está sujeito a alterações. ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1 - Averbação ### Webhooks Em caso de sucesso na averbação o parceiro receberá o seguinte webhook: WEBHOOK TYPE credit_operation.collateral STATUS Opened **Webhook Body** ```json { "webhook": { "key": "", "data": { "collateral_data": "collateral_data": { "total_gross_amount_lock": 1500, "investment_funds": [ { "susep_process_number": "111111111111", "certificate": "12345678", "name": "QI Fund Alpha", "document_number": "32402502000135", "class": "", "subclass": "", "lock_gross_amount": 500, }, { "susep_process_number": "222222222222", "certificate": "87654321", "name": "QI Fund Beta", "document_number": "32402502000135", "class": "", "subclass": "", "lock_gross_amount": 500, }, { "susep_process_number": "333333333333", "certificate": "56781234", "name": "QI Fund Gama", "document_number": "32402502000135", "class": "", "subclass": "", "lock_gross_amount": 500, } ] }, "collateral_type": "private_pension", "collateral_constituted": true }, "event_time": "2025-07-10 02:15:01", "webhook_type": "credit_operation.collateral" } } ``` ### Falha na averbação Se uma reserva falhar, será enviado um webhook no seguinte formato para informar o ocorrido: WEBHOOK TYPE private_pension_failed_reservation STATUS Failed **Webhook Body** ```json title="Webhook Body" { "key": "", "status": "failed", "webhook_type": "private_pension_failed_reservation", "event_datetime": "2025-10-26 16:41:28", "data": { "enumerator": "Fail enumerator.", "description": "Descrição da falha.", } } ``` ## 2 - Desaverbação A desaverbação de um contrato é realizada através da rota de cancelamento permanente. Essa rota coloca um status final no contrato, o qual não é passível de retentativa e dispara a desaverbação da margem averbada. Para realizar o cancelamento definitivo, deve ser utilizado o seguinte endpoint: **POST** /debt/ DEBT-KEY /cancel_permanently Testar no Playground ### Webhooks WEBHOOK TYPE debt STATUS canceled_permanently **Webhook Body** ```json { "key": "", "status": "canceled_permanently", "webhook_type": "debt", "event_datetime": "2025-03-18 16:41:28", "data": {} } ``` ## 3 - Falha no desembolso ### TED Em caso de falha no desembolso via TED WEBHOOK TYPE debt STATUS canceled **Webhook Body** ```json { "key": "", "status": "canceled", "webhook_type": "debt", "event_datetime": "2025-03-18 16:41:28", "data": { "ted_refusal": { "transaction_key": "16faabfc-3876-437d-a4f6-aae17a1d68c9", "description": "341 0000 000000-7 12345678900 - NOME DO EMPREGADO", "origin": { "account_key": "a1d2dea5-fa90-4676-a125-da355fdc3ed0", "account_number": "00086", "bank_code": "329", "name": "ACCOUNT TRANSITORY", "type": "payment_account", "document": "32402502000135", "branch_digit": null, "account_digit": "8", "branch": "0001" }, "fee": 0, "reason_enumerator": "agencia_conta_invalida", "timestamp": "2022-11-07T14:36:05", "amount": 483.6, "reason": "Agência ou Conta Destinatária do Crédito Inválida", "destination": { "branch": "0000", "account_number": "000000", "name": "NOME DO EMPREGADO", "purpose": "Crédito em Conta", "type": "checking_account", "branch_digit": null, "document": "12345678900", "bank_code": "341", "account_digit": "7" } }, "cancel_reason": "ted_refusal" } } ``` ### PIX Em caso de falha no desembolso via PIX WEBHOOK TYPE debt STATUS canceled **Webhook Body** ```json { "key": "", "status": "canceled", "webhook_type": "debt", "event_datetime": "2025-03-18 16:41:28", "data": { "cancel_reason": "pix_refusal", "pix_refusal": { "reason_enumerator": "invalid_document_number", "reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino." } } } ``` ## 4 - Reapresentação de Pagamento Altera a data de desembolso sem afetar os valores financeiros da operação. **POST** /debt/ DEBT-KEY /change_disbursement_date Testar no Playground ### Request **Request Body** ```json { "disbursement_date": "2025-03-19", "disbursement_bank_accounts": [ { "branch_number": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "document_number": "", "bank_code": 184, "ispb_number": "17298092", "name": "", "percentage_receivable": 100 } ] } ``` ### Response STATUS **200** OK **Response Body** ```json { "disbursement_date": "2025-03-19", "disbursement_accounts": [ { "account_branch": "1232", "account_digit": "4", "account_number": "412412412", "account_type": "checking_account", "amount_receivable": null, "created_at": "2022-05-24T14:51:46", "digitable_line": null, "disbursement_type": "ted", "document_number": "37197645832", "financial_institutions": { "code_number": 184, "ispb": 17298092, "name": "BCO ITAÚ BBA S.A." }, "financial_institutions_code_number": 184, "is_pix_disbursement": false, "ispb": "17298092", "name": "Márcio e Catarina Gráfica Ltda", "percentage_receivable": 50.0, "pix_key": null, "pix_transfer_key": null, "pix_type": null, "qr_code_key": null, "retry_counter": 0, "retry_vector": null, "transaction_key": null, "webhook_key": null } ] } ``` --- # Manual Previdência Privada - Consulta URL: /documentation/manual_previdencia_privada/manual_previdencia_privada_consulta :::info Próximo passo - [Crédito Novo](/documentation/manual_previdencia_privada/manual_previdencia_privada_credito_novo) ::: :::caution API em desenvolvimento A API ainda está em fase de desenvolvimento, sendo assim, este manual está sujeito a alterações. ::: --- ## 1. Consulta de garantias A consulta de garantias permite verificar as informações referentes aos produtos de previdência. Esta operação é assíncrona, o pedido de consulta é enviado para uma de nossas filas e processado posteriormente. A requisição retorna de imediato o identificador único referente ao pedido de consulta e seu status de processamento. ### Request **POST** /private_pension/inquiry Testar no Playground **Payload** ```json { "document_number": "\", "operating_entity": "\", "investment_funds": [ { "susep_process_number": "", "certificate": "", "name": "", "document_number": "", "class": "", "subclass": "", }, { "susep_process_number": "", "certificate": "", "name": "", "document_number": "", "class": "", "subclass": "", }, { "susep_process_number": "", "certificate": "", "name": "", "document_number": "", "class": "", "subclass": "", }, ], "authorization_term": { "signature": { "signer": { "name": "\", "birth_date": "\", "address": { "street": "", "neighborhood": "", "city": "", "state": "", "postal_code": "", }, "email": "\", "phone": { "number": "\", "area_code": "\", "country_code": "55" }, } }, "authentication_type": "opt_in", "authenticity": { "timestamp": "\", "ip_address": "\", "city": "\", "session_id": "\", }, } } ``` **Body Details** | Campo | Tipo | Descrição | |--------------------|--------|----------------------------------| | document_number | string | CPF do tomador | | operating_entity | string | Enumerador da entidade operadora | | investment_funds | objeto | Dados de fundos de investimento | | authorization_term | objeto | Dados de autorização | #### Objeto investment_funds | Campo | Tipo | Descrição | |-----------------------|--------|---------------------------------------| | susep_process_number | string | Número do processo SUSEP | | certificate | string | Certificado do produto de previdência | | name | string | Nome do fundo | | document_number | string | CNPJ do fundo | | class | string | Classe do fundo | | subclass | string | Subclasse do fundo | #### Objeto authorization_term | Campo | Tipo | Descrição | |---------------------|--------|----------------------------------| | signature | objeto | Dados de assinatura | | authentication_type | string | Tipo de autenticação (opt_in) | | authenticity | objeto | Dados de autenticidade | #### Objeto signature | Campo | Tipo | Descrição | |--------------------|--------|----------------------------------| | signer | objeto | Dados do assinante | #### Objeto signer | Campo | Tipo | Descrição | |--------------------|--------|----------------------------------| | name | string | Nome do assinante | | birth_date | string | Data de nascimento do assinante | | address | objeto | Endereço do assinante | | email | objeto | Endereço de email do assinante | | phone | objeto | Telefone do assinate | #### Objeto address | Campo | Tipo | Descrição | |--------------------|--------|----------------------------------| | street | string | Logradouro | | neighborhood | string | Bairro | | city | string | Cidade | | state | string | Estado | | postal_code | string | CEP | #### Objeto phone | Campo | Tipo | Descrição | |--------------------|--------|----------------------------------| | number | string | Número de telefone | | area_code | string | DDD | | country_code | string | Código de telefone do país | #### Objeto authenticity | Campo | Tipo | Descrição | |--------------------|--------|----------------------------------| | timestamp | string | Timestamp do aceite do tomador | | ip_address | string | IP da sessão do usuário | | city | string | Cidade de assinatura | | session_id | string | Chave identificadora interna da sessão do usuário | ### Response STATUS **201** (CREATED) **Payload** ```json { "inquiry_key": "69aac130-35cb-4bdd-80e9-ba01d18002bd", "inquiry_status": "pending_inquiry" } ``` **Response Body Details** | Campo | Tipo | Descrição | |---------------------------|---------|---------------------------------------------------------------------| | inquiry_key | string | Identificador única para a consulta da garantia | | inquiry_status | string | Status da requisição de consulta (pending_inquiry/success/rejected) | --- ## 2. Consulta do processamento de garantias **GET** /private_pension/inquiry/[inquiry_key] Testar no Playground ### Response **Response Body** ```json { "inquiry_key": "69aac130-35cb-4bdd-80e9-ba01d18002bd", "inquiry_status": "pending_inquiry" } ``` --- ## 3. Webhook de consulta de garantias Após o processamento do pedido de consulta, o cliente receberá um webhook com as informações das garantias. :::caution Atenção O cliente deve implementar o tratamento deste webhook para capturar as informações do pedido de consulta das garantias. ::: WEBHOOK TYPE laas.private_pension.inquiry.status_change STATUS sucess **Webhook Body** ```json { "key": "69aac130-35cb-4bdd-80e9-ba01d18002bd", "status": "success", "webhook_type": "laas.private_pension.inquiry.status_change", "event_datetime": "2025-10-08T01:00:00Z", "data": { "guarantees": [ { "contract_id": "851cf2e4-524b-48d7-a133-fd10bb0a7313", "product": "PGBL", "operation_type": "PREVIDENCIA", "operating_entity": { "document_number": "42283770000139", "operating_entity_name": "Icatu seguros", "street": "Avenida Ibirapuera", "neighborhood": "Moema", "city": "São Paulo", "state": "SP", "postal_code": "04028002", "authenticity": { "timestamp": "\", "city": "\", "session_id": "\" } }, "guarantor": { "contract_code": "48334488-ecf1-4b84-a352-b3eb57dca066", "person_type": "natural_person", "document_number": "75020251038", "name": "Nome garantidor", "social_name": "Nome social garantidor", "second_document_number": "126979364", "birth_date": "1983-12-01", "street": "Rua Maria Carolina", "neighborhood": "Jardim Paulistano", "city": "São Paulo", "state": "SP", "postal_code": "01445000", "phone": "11911111111", "email": "exemplo@gmail.com", "movement_type": "supply", "consent_term_code": "6bb8b263-c5ed-4406-bfd2-44f314038784", "consent_file_url": null, "consent_file_hash": null, "legal_representatives": [], }, "plan_type": "PGBL", "initial_grace": true, "accumulation_period_end_date": "2050-01-01", "tax_regime": "indefinite", "remaining_grace_period": 15, "load_percentage": 99.50, "investment_funds": [ { "susep_process_number": "111111111111111111111111", "certificate": "12345678QI", "name": "Fundo QI Tech", "document_number": "32402502000135", "class": "Renda Fixa", "subclass": "Crédito Privado", "inquiry_id": "fcfb01b5-5c08-4cdb-9915-aaf16d457803", "response_within_deadline": null, "inquiry_processing_status": "inquiry_nuclea_register", "inquiry_status": "pending", "rejection_reason": null, "rejection_reason_description": null, "remuneration_criteria": null, "available_gross_amount": 500, "elegible_gross_amount": 250, "lock_gross_amount": 200 } ] }, { "contract_id": "733cf2e4-908b-48d7-a222-fd10bb0a1323", "product": "VGBL", "operation_type": "PREVIDENCIA", "operating_entity": { "document_number": "42283770000139", "operating_entity_name": "Icatu seguros", "street": "Avenida Ibirapuera", "neighborhood": "Moema", "city": "São Paulo", "state": "SP", "postal_code": "04028002", "authenticity": { "timestamp": "\", "city": "\", "session_id": "\" } }, "guarantor": { "contract_code": "48334488-ecf1-4b84-a352-b3eb57dca066", "person_type": "natural_person", "document_number": "75020251038", "name": "Nome garantidor", "social_name": "Nome social garantidor", "second_document_number": "126979364", "birth_date": "1983-12-01", "street": "Rua Maria Carolina", "neighborhood": "Jardim Paulistano", "city": "São Paulo", "state": "SP", "postal_code": "01445000", "phone": "11911111111", "email": "exemplo@gmail.com", "movement_type": "supply", "consent_term_code": "6bb8b263-c5ed-4406-bfd2-44f314038784", "consent_file_url": null, "consent_file_hash": null, "legal_representatives": [], }, "plan_type": "VGBL", "initial_grace": true, "accumulation_period_end_date": "2050-01-01", "tax_regime": "indefinite", "remaining_grace_period": 15, "load_percentage": 99.50, "investment_funds": [ { "susep_process_number": "222222222222222222222222", "certificate": "87654321QI", "name": "Fundo QI Tech", "document_number": "32402502000135", "class": "Renda Fixa", "subclass": "Crédito Privado", "inquiry_id": "fcfb01b5-5c08-4cdb-9915-aaf16d457803", "response_within_deadline": null, "inquiry_processing_status": "inquiry_nuclea_register", "inquiry_status": "pending", "rejection_reason": null, "rejection_reason_description": null, "remuneration_criteria": null, "available_gross_amount": 500, "elegible_gross_amount": 250, "lock_gross_amount": 200 } ] }, { "contract_id": "733cf2e4-908b-48d7-a222-fd10bb0a1323", "product": "PGBL", "operation_type": "PREVIDENCIA", "operating_entity": { "document_number": "42283770000139", "operating_entity_name": "Icatu seguros", "street": "Avenida Ibirapuera", "neighborhood": "Moema", "city": "São Paulo", "state": "SP", "postal_code": "04028002", "authenticity": { "timestamp": "\", "city": "\", "session_id": "\" } }, "guarantor": { "contract_code": "94039572-ecf1-4h84-h929-q3eb51gea231", "person_type": "natural_person", "document_number": "75020251038", "name": "Nome garantidor", "social_name": "Nome social garantidor", "second_document_number": "126979364", "birth_date": "1983-12-01", "street": "Rua Maria Carolina", "neighborhood": "Jardim Paulistano", "city": "São Paulo", "state": "SP", "postal_code": "01445000", "phone": "11911111111", "email": "exemplo@gmail.com", "movement_type": "supply", "consent_term_code": "6bb8b263-c5ed-4406-bfd2-44f314038784", "consent_file_url": null, "consent_file_hash": null, "legal_representatives": [], }, "plan_type": "PGBL", "initial_grace": true, "accumulation_period_end_date": "2050-01-01", "tax_regime": "indefinite", "remaining_grace_period": 15, "load_percentage": 99.50, "investment_funds": [ { "susep_process_number": "333333333333333333333333", "certificate": "56781234QI", "name": "Fundo QI Tech", "document_number": "32402502000135", "class": "Renda Fixa", "subclass": "Crédito Privado", "inquiry_id": "fcfb01b5-5c08-4cdb-9915-aaf16d457803", "response_within_deadline": null, "inquiry_processing_status": "inquiry_nuclea_register", "inquiry_status": "pending", "rejection_reason": null, "rejection_reason_description": null, "remuneration_criteria": null, "available_gross_amount": 500, "elegible_gross_amount": 250, "lock_gross_amount": 200 } ] } ] } } ``` **Webhook Body Details** | Campo | Tipo | Descrição | |---------------------|--------|--------------------------------------| | key | string | Chave do pedido de consulta | | status | string | Status do documento (success) | | webhook_type | string | Tipo do webhook | | event_datetime | string | Data e hora do evento | | data | object | Dados do webhook | #### Payload data | Campo | Tipo | Descrição | |------------------------------|--------|--------------------------| | guarantees | objeto | Dados de garantia | #### Objeto guarantees | Campo | Tipo | Descrição | |-------------------------------|--------|----------------------------------| | contract_id | string | Código do anexo IV modelo de termo acessório ao instrumento contratual de garantia | | product | string | Denominação do produto na entidade operadora | | operation_type | string | Tipo do produto (previdencia) | | operating_entity | objeto | Dados da entidade operadora | | guarantor | objeto | Dados do garantidor | | plan_type | objeto | Tipo do plano de previdência | | initial_grace | bool | Existência de período de carência inicial | | accumulation_period_end_date | objeto | Data final do período de acumulação | | tax_regime | enum | Regime tributário | | remaining_grace_period | int | Prazo remanescente do período de carência (em dias) | | load_percentage | number | Percentual de carregamento | | investment_funds | objeto | Dados de fundo de investimento | #### Objeto operating_entity | Campo | Tipo | Descrição | |-----------------------|--------|----------------------------------| | document_number | string | Cnpj da entidade operadora | | operating_entity_name | string | Nome da entidade operadora | | street | string | Logradouro | | neighborhood | string | Bairro | | city | string | Cidade | | state | string | Estado | | postal_code | string | CEP | | authenticity | object | Dados de autenticidade | #### Objeto authenticity | Campo | Tipo | Descrição | |--------------------|--------|-------------------------------------------| | timestamp | string | Timestamp do aceite da entidade operadora | | city | string | Cidade de assinatura | | session_id | string | Chave identificadora interna da sessão | #### Objeto guarantor | Campo | Tipo | Descrição | |------------------------|--------|-------------------------------------------| | contract_code | string | Código contratual | | person_type | enum | Tipo de pessoa (PF, PJ) | | document_number | string | Cpf/cnpj do garantidor | | name | string | Nome do garantidor | | social_name | string | Nome social do garantidor | | second_document_number | string | Rg do garantidor | | birth_date | string | Data de nascimento do garantidor | | street | string | Logradouro | | neighborhood | string | Bairro | | city | string | Cidade | | state | string | Estado | | postal_code | string | CEP | | phone | string | Número de telefone do garantidor | | email | string | Endereço de email do garantidor | | movement_type | enum | Tipo de operação realizada | | consent_term_code | string | Código do termo de consentimento | | consent_file_url | object | Dados da url do arquivo de consentimento | | consent_file_hash | string | Hash do arquivo de consentimento | | legal_representatives | object | Representantes legais | #### Objeto investment_funds | Campo | Tipo | Descrição | |-------------------------------|--------|------------------------------------------------| | susep_process_number | string | Número do processo SUSEP | | certificate | string | Certificado do produto de previdência | | name | string | Nome do fundo | | document_number | string | CNPJ do fundo | | class | string | Classe do fundo | | subclass | string | Subclasse do fundo | | inquiry_id | string | Identificador da garantia | | response_within_deadline | bool | Resposta realizada dentro do prazo | | inquiry_processing_status | enum | Status do processamento do pedido de consulta | | inquiry_status | enum | Status do pedido | | rejection_reason | enum | Motivo de recusa da consulta | | rejection_reason_description | string | Descrição do motivo de recusa da consulta | | remuneration_criteria | string | Critério de remuneração | | available_gross_amount | number | Valor bruto disponível | | elegible_gross_amount | number | Valor bruto elegível | | lock_gross_amount | number | Valor bruto para bloquear | #### Objeto consent_file_url | Campo | Tipo | Descrição | |--------------------|--------|-------------------------------------------| | url | string | Url do arquivo de consentimento | | duration | string | Duração de validade de acesso da url | #### Objeto legal_representatives | Campo | Tipo | Descrição | |--------------------|--------|-------------------------------------------| | person_type | enum | Tipo de pessoa | | document_number | string | Cpf/cnpj do representante legal | | name | string | Nome do representante legal | | social_name | string | Nome social do representante legal | #### Enumerador tax_regime | Enumerador | Descrição | |---------------------------|-------------------------------| | indefinite | Regime tributário indefinido | | progressive | Regime tributário progressivo | | regressive | Regime tributário regressivo | #### Enumerador person_type | Enumerador | Descrição | |---------------------------|------------------------------| | natural_person | Pessoa Física | | legal_person | Pessoa Jurídica | #### Enumerador movement_type | Enumerador | Descrição | |---------------------------|------------------------------------| | supply | Consentimento para a trava | | renegotiate | Consentimento para a repactuação | #### Enumerador inquiry_processing_status | Enumerador | Descrição | |-----------------------------------|-------------------------------------------| | inquiry_nuclea_register | Pedido cadastrado pela Núclea | | inquiry_sent_operating_entity | Pedido recebido pela entidade operadora | | inquiry_returned_operating_entity | Pedido retornado pela entidade operadora | #### Enumerador inquiry_status | Enumerador | Descrição | |---------------------------|------------------------------------| | success | Sucesso no pedido de consulta | | failed | Falha no pedido de consulta | | pending | Pedido de consulta pendente | #### Enumerador rejection_reason | Enumerador | Descrição | |-------------------------------|------------------------------------| | invalid_signature | Assinatura inválida | | invalid_client_information | Informações do cliente inválidas | | invalid_plan_information | Informações do plano inválidas | | incomplete_information | Informações incompletas | | others | Outros motivos de rejeição | WEBHOOK TYPE laas.private_pension.inquiry.status_change STATUS failed **Webhook Body** ```json { "key": "69aac130-35cb-4bdd-80e9-ba01d18002bd", "status": "failed", "webhook_type": "laas.private_pension.inquiry.status_change", "event_datetime": "2025-10-08T01:00:00Z", "data": { "guarantees": [ { "contract_id": "851cf2e4-524b-48d7-a133-fd10bb0a7313", "product": "PGBL", "operation_type": "PREVIDENCIA", "operating_entity": { "document_number": "42283770000139", "operating_entity_name": "Icatu seguros", "street": "Avenida Ibirapuera", "neighborhood": "Moema", "city": "São Paulo", "state": "SP", "postal_code": "04028002", "authenticity": { "timestamp": "\", "city": "\", "session_id": "\" } }, "guarantor": { "contract_code": "48334488-ecf1-4b84-a352-b3eb57dca066", "person_type": "natural_person", "document_number": "75020251038", "name": "Nome garantidor", "social_name": "Nome social garantidor", "second_document_number": "126979364", "birth_date": "1983-12-01", "street": "Rua Maria Carolina", "neighborhood": "Jardim Paulistano", "city": "São Paulo", "state": "SP", "postal_code": "01445000", "phone": "11911111111", "email": "exemplo@gmail.com", "movement_type": "supply", "consent_term_code": "6bb8b263-c5ed-4406-bfd2-44f314038784", "consent_file_url": null, "consent_file_hash": null, "legal_representatives": [], }, "plan_type": "PGBL", "initial_grace": true, "accumulation_period_end_date": "2050-01-01", "tax_regime": "indefinite", "remaining_grace_period": 15, "load_percentage": 99.50, "investment_funds": [ { "susep_process_number": "111111111111111111111111", "certificate": "12345678QI", "name": "Fundo QI Tech", "document_number": "32402502000135", "class": "Renda Fixa", "subclass": "Crédito Privado", "inquiry_id": "fcfb01b5-5c08-4cdb-9915-aaf16d457803", "response_within_deadline": null, "inquiry_processing_status": "inquiry_nuclea_register", "inquiry_status": "failed", "rejection_reason": "invalid_plan_information", "rejection_reason_description": null, "remuneration_criteria": null, "available_gross_amount": null, "elegible_gross_amount": null, "lock_gross_amount": null } ] }, { "contract_id": "733cf2e4-908b-48d7-a222-fd10bb0a1323", "product": "VGBL", "operation_type": "PREVIDENCIA", "operating_entity": { "document_number": "42283770000139", "operating_entity_name": "Icatu seguros", "street": "Avenida Ibirapuera", "neighborhood": "Moema", "city": "São Paulo", "state": "SP", "postal_code": "04028002", "authenticity": { "timestamp": "\", "city": "\", "session_id": "\" } }, "guarantor": { "contract_code": "48334488-ecf1-4b84-a352-b3eb57dca066", "person_type": "natural_person", "document_number": "75020251038", "name": "Nome garantidor", "social_name": "Nome social garantidor", "second_document_number": "126979364", "birth_date": "1983-12-01", "street": "Rua Maria Carolina", "neighborhood": "Jardim Paulistano", "city": "São Paulo", "state": "SP", "postal_code": "01445000", "phone": "11911111111", "email": "exemplo@gmail.com", "movement_type": "supply", "consent_term_code": "6bb8b263-c5ed-4406-bfd2-44f314038784", "consent_file_url": null, "consent_file_hash": null, "legal_representatives": [], }, "plan_type": "VGBL", "initial_grace": true, "accumulation_period_end_date": "2050-01-01", "tax_regime": "indefinite", "remaining_grace_period": 15, "load_percentage": 99.50, "investment_funds": [ { "susep_process_number": "222222222222222222222222", "certificate": "87654321QI", "name": "Fundo QI Tech", "document_number": "32402502000135", "class": "Renda Fixa", "subclass": "Crédito Privado", "inquiry_id": "fcfb01b5-5c08-4cdb-9915-aaf16d457803", "response_within_deadline": null, "inquiry_processing_status": "inquiry_nuclea_register", "inquiry_status": "failed", "rejection_reason": "others", "rejection_reason_description": "O numero do processo susep nao se refere a esse produto", "remuneration_criteria": null, "available_gross_amount": 500, "elegible_gross_amount": 250, "lock_gross_amount": 200 } ] }, { "contract_id": "733cf2e4-908b-48d7-a222-fd10bb0a1323", "product": "PGBL", "operation_type": "PREVIDENCIA", "operating_entity": { "document_number": "42283770000139", "operating_entity_name": "Icatu seguros", "street": "Avenida Ibirapuera", "neighborhood": "Moema", "city": "São Paulo", "state": "SP", "postal_code": "04028002", "authenticity": { "timestamp": "\", "city": "\", "session_id": "\" } }, "guarantor": { "contract_code": "94039572-ecf1-4h84-h929-q3eb51gea231", "person_type": "natural_person", "document_number": "75020251038", "name": "Nome garantidor", "social_name": "Nome social garantidor", "second_document_number": "126979364", "birth_date": "1983-12-01", "street": "Rua Maria Carolina", "neighborhood": "Jardim Paulistano", "city": "São Paulo", "state": "SP", "postal_code": "01445000", "phone": "11911111111", "email": "exemplo@gmail.com", "movement_type": "supply", "consent_term_code": "6bb8b263-c5ed-4406-bfd2-44f314038784", "consent_file_url": null, "consent_file_hash": null, "legal_representatives": [], }, "plan_type": "PGBL", "initial_grace": true, "accumulation_period_end_date": "2050-01-01", "tax_regime": "indefinite", "remaining_grace_period": 15, "load_percentage": 99.50, "investment_funds": [ { "susep_process_number": "333333333333333333333333", "certificate": "56781234QI", "name": "Fundo QI Tech", "document_number": "32402502000135", "class": "Renda Fixa", "subclass": "Crédito Privado", "inquiry_id": "fcfb01b5-5c08-4cdb-9915-aaf16d457803", "response_within_deadline": null, "inquiry_processing_status": "inquiry_nuclea_register", "inquiry_status": "success", "rejection_reason": null, "rejection_reason_description": null, "remuneration_criteria": null, "available_gross_amount": 500, "elegible_gross_amount": 250, "lock_gross_amount": 200 } ] } ] } } ``` --- --- # Manual Previdência Privada - Crédito Novo URL: /documentation/manual_previdencia_privada/manual_previdencia_privada_credito_novo :::info Navegação - [Consulta](/documentation/manual_previdencia_privada/manual_previdencia_privada_consulta) (anterior) - [Averbação e Desembolso](/documentation/manual_previdencia_privada/manual_previdencia_privada_averbacao_desembolso) (próximo) ::: :::caution API em desenvolvimento A API ainda está em fase de desenvolvimento, sendo assim, este manual está sujeito a alterações. ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma estrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1 - Simulação da dívida: CRÉDITO NOVO ### Request **POST** /debt_simulation Testar no Playground **Valor de parcela** ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "installment_face_value": 100, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "private_pension" } ] } ``` **Valor desembolsado** ```json title='Request Body' { "borrower": { "person_type": "natural" }, "financial": { "first_due_date": "2024-12-07", "disbursed_amount": 1000, "disbursement_date": "2024-11-05", "limit_days_to_disburse": 3, "number_of_installments": 4, "monthly_interest_rate": 0.018, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "collaterals": [ { "collateral_type": "private_pension" } ] } ``` :::info Na request acima existem 2 simulações sendo realizadas. A primeira está fixando o valor de parcela ao cliente (varia o valor desembolsado) e a segunda está fixando o valor desembolsado (varia o valor de parcela). ::: ### Response STATUS **200** (OK) **Response Body** ```json { "type": "debt", "key": "", "status": "finished", "event_datetime": "2024-11-05 16:50:00", "data": { "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "interest_payment_month_period": 1, "principal_grace_period": 0, "principal_amortization_month_period": 1, "operation_type": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2024-11-05", "number_of_installments": 4, "requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a", "final_disbursement_amount": 0.0, "disbursement_options": [ { "iof_amount": 3.93, "total_pre_fixed_amount": 17.8715883143, "cet": 0.0257, "annual_cet": 0.355163, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.29 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.29, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-05", "first_due_date": "2024-12-21", "installments": [ { "calendar_days": 34, "workdays": 23.0, "business_due_date": "2024-12-21", "due_date": "2024-12-21", "due_principal": 382.13, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 7.6967422515, "tax_amount": 0.257341482602818, "total_amount": 100, "principal_amortization_amount": 92.3032577485, "installment_number": 1 }, { "calendar_days": 29, "workdays": 19.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 289.8267422515, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 4.9718040699, "tax_amount": 0.4909156601748966, "total_amount": 100, "principal_amortization_amount": 95.0281959301, "installment_number": 2 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 194.7985463214, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.5742034136, "tax_amount": 0.7432500400879712, "total_amount": 100, "principal_amortization_amount": 96.4257965864, "installment_number": 3 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 98.372749735, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.6288385793, "tax_amount": 0.9841050988526828, "total_amount": 100, "principal_amortization_amount": 98.3711614207, "installment_number": 4 } ], "issue_amount": 382.13, "disbursed_issue_amount": 374.91, "assignment_amount": 382.13, "final_disbursement_amount": 374.91, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.77, "total_pre_fixed_amount": 24.2597288075, "cet": 0.0243, "annual_cet": 0.334037, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.25 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.25, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-06", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 62, "workdays": 41.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.74, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.9149280115, "tax_amount": 0.437656505989534, "total_amount": 100, "principal_amortization_amount": 86.0850719885, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6549280115, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.722070128765373, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.969623951, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9601685182659746, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1979530917, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.2239426674782687, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 375.74, "disbursed_issue_amount": 367.72, "assignment_amount": 375.74, "final_disbursement_amount": 367.72, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.74, "total_pre_fixed_amount": 24.0392857898, "cet": 0.0243, "annual_cet": 0.334673, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-07", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 61, "workdays": 40.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.96, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.6944849939, "tax_amount": 0.4317001860605122, "total_amount": 100, "principal_amortization_amount": 86.3055150061, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6544849939, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.714305933832412, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.9691809334, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.952233241255512, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1975100741, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757157, "tax_amount": 1.2158904130882027, "total_amount": 100, "principal_amortization_amount": 98.1982242843, "installment_number": 4 } ], "issue_amount": 375.96, "disbursed_issue_amount": 367.96, "assignment_amount": 375.96, "final_disbursement_amount": 367.96, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.71, "total_pre_fixed_amount": 23.8187134405, "cet": 0.0244, "annual_cet": 0.335196, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-08", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 60, "workdays": 39.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 376.18, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.4739126445, "tax_amount": 0.42570834978906, "total_amount": 100, "principal_amortization_amount": 86.5260873555, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6539126445, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.706541738899451, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.968608584, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9442979642450494, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-21", "due_date": "2025-04-21", "due_principal": 98.1969377247, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.20783815869566, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 376.18, "disbursed_issue_amount": 368.21, "assignment_amount": 376.18, "final_disbursement_amount": 368.21, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } } ] } } ``` --- ## 2 - Emissão da operação: CRÉDITO NOVO ### Request **POST** /debt Testar no Playground **Sem representante legal** ```json title='Request Body' { "borrower": { "name": "Nome devedor", "email":"email.devedor@gmail.com", "phone": { "number": "999538380", "area_code": "84", "country_code": "055" }, "is_pep": false, "address": { "city": "Natal", "state": "RN", "number": "1984", "street": "Rua", "postal_code": "59065720", "neighborhood": "bairro" }, "birth_date": "1959-07-08", "person_type": "natural", "individual_document_number": "14471835092", "marital_status": "single", "profession": "", "document_identification": "494598fd-c226-4332-a500-591ae3884673", "document_identification_back": "a194d9a3-6790-449b-a429-f450cf904777", "proof_of_residence": "ec838feb-642b-4c58-81d8-f113b607da08", }, "financial": { "interest_type": "pre_price_days", "first_due_date": "2023-09-21", "disbursement_start_date": "2024-11-07", "disbursement_end_date": "2024-11-07", "fine_configuration": { "monthly_rate": 0.0166, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "annual_interest_rate": 0.0166, "disbursed_amount": 1234.56, "issue_date": "2024-11-07", "number_of_installments": 10, "principal_grace_period": 0, "rebates": [ // Opcional { "amount": 20, "rebate_bank_account": { "name": "Teste Ltda", "document_number": "18533555000164", "account_digit": "0", "account_number": "4290001", "branch_number": "0001", "bank_code": "329" }, "amount_type": "percentage", "fee_type": "spread" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "private_pension", "collateral_data": { "total_gross_amount_lock": 1500, "investment_funds": [ { "susep_process_number": "", "certificate": "", "operating_entity_document_number": "", "plan_type": "", "initial_grace": false, "grace_days": 0, "accumulation_end_date": "2050-01-01", "tax_regime": "progressive", "load_percentage": 0.0, "name": "", "document_number": "", "class": "", "subclass": "", "lock_gross_amount": 500, }, { "susep_process_number": "", "certificate": "", "operating_entity_document_number": "", "plan_type": "", "initial_grace": false, "grace_days": 0, "accumulation_end_date": "2050-01-01", "tax_regime": "progressive", "load_percentage": 0.0, "name": "", "document_number": "", "class": "", "subclass": "", "lock_gross_amount": 500, }, { "susep_process_number": "", "certificate": "", "operating_entity_document_number": "", "plan_type": "", "initial_grace": false, "grace_days": 0, "accumulation_end_date": "2050-01-01", "tax_regime": "progressive", "load_percentage": 0.0, "name": "", "document_number": "", "class": "", "subclass": "", "lock_gross_amount": 500, } ] } } ], "purchaser_document_number": "32402502000135", "disbursement_bank_accounts": [ { "name": "NOME DEVEDOR", "bank_code": "001", "account_digit": "0", "branch_number": "2874", "account_number": "000057555", "document_number": "14471835092", "transfer_method": "pix", "percentage_receivable": 100 } ] } ``` ### Response STATUS **201** (Created) **Response Body** ```json title="Response Body" { "webhook_type": "debt", "key": "", "status": "waiting_signature", "event_datetime": "2024-11-07 23:19:22", "data": { "borrower": { "name": "Nome devedor", "document_number": "14471835092", "related_party_key": "28b7fc16-6d1f-467d-9667-62a8c13daea6" }, "contract": { "number": "TST0000644710", "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/a2e9c83a-3666-4def-8b27-e96fabb8705c/NOME_DEVEDOR-CCB-TST0000644710-20241107231916.pdf" ], "signature_information": [ { "signer_name": "Nome devedor", "signer_document_number": "14471835092", "signer_role": "issuer", "signer_email": null, "signer_external_key": null, "signature_url": null } ] }, "requester_identifier_key": "eb859ebe-3a41-49bf-a6c3-d6902039ec00", "iof_charge_method": "financed", "collaterals": [ { "absolute_amount": null, "collateral_constituted": false, "collateral_data": { "operating_entity_document_number": "", "total_gross_amount_lock": 1500, "investment_funds": [ { "susep_process_number": "", "certificate": "", "plan_type": "", // opcional "initial_grace": false, "grace_days": 0, "accumulation_end_date": "2050-01-01", "tax_regime": "progressive", "load_percentage": 0.0, "name": "", "document_number": "", "class": "", // opcional "subclass": "", // opcional "lock_gross_amount": 500, }, { "susep_process_number": "", "certificate": "", "plan_type": "", "initial_grace": false, "grace_days": 0, "accumulation_end_date": "2050-01-01", "tax_regime": "progressive", "load_percentage": 0.0, "name": "", "document_number": "", "class": "", "subclass": "", "lock_gross_amount": 500, }, { "susep_process_number": "", "certificate": "", "plan_type": "", "initial_grace": false, "grace_days": 0, "accumulation_end_date": "2050-01-01", "tax_regime": "progressive", "load_percentage": 0.0, "name": "", "document_number": "", "class": "", "subclass": "", "lock_gross_amount": 500, } ] }, "collateral_key": "26c7f4f4-51f3-41fa-b880-9691211136aa", "collateral_type": "private_pension", "created_at": "2024-11-07T23:19:16.413448", "external_key": null, "percentage": 1, "updated_at": "2024-11-07T23:19:16.413441" } ], "disbursement_options": [ { "disbursement_date": "2024-11-07", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.3, "issue_amount": 909.75, "cet": "2,0100%", "annual_cet": "27,0481%", "base_iof": 16.259002146803677, "additional_iof": 3.45705, "total_iof": 19.72, "total_pre_fixed_amount": 108.6508885851, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 74, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 909.75, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 37.1789024864, "principal_amortization_amount": 64.6610975136, "tax_amount": 0.3923635397125248, "total_amount": 101.84, "workdays": 49.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0889024864, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.753721435360089, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5486660915, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9845001990781314, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2772376046, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.222548377175604, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4632222376, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4797864582180404, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4416948163, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.72770892770474, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7989345071, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.999011328473856, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5716418016, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.274874127227187, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.570357168, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.570318634292211, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3090744135, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8541691195612935, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-08", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 914.79, "issue_amount": 910.24, "cet": "2,0200%", "annual_cet": "27,0539%", "base_iof": 16.187351160427028, "additional_iof": 3.458912, "total_iof": 19.65, "total_pre_fixed_amount": 108.1583324947, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 73, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 910.24, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.6863463961, "principal_amortization_amount": 65.1536536039, "tax_amount": 0.3900097704729454, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0863463961, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7465431359757072, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5461100012, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9770979419422056, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2746815143, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.21518362791551, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4606661473, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4721586929694939, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.439138726, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7200302213593857, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7963784168, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.991202690472005, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5690857113, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.266920021887232, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5678010777, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.562261209106342, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3065183232, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.845943848326202, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-09", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.55 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.05, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.28, "issue_amount": 910.73, "cet": "2,0200%", "annual_cet": "27,0599%", "base_iof": 16.115620969325082, "additional_iof": 3.460774, "total_iof": 19.58, "total_pre_fixed_amount": 107.6655097248, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 72, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 910.73, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 36.1935236262, "principal_amortization_amount": 65.6464763738, "tax_amount": 0.3875767965109152, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0835236262, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7393648365913253, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5432872313, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9696956848062798, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2718587444, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.207818878655416, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4578433774, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4645309277209473, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4363159561, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7123515150140312, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7935556469, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.983394052470154, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5662629414, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2589659165472766, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5649783078, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.554203783920473, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3036955533, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.837718577088265, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-10", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 915.79, "issue_amount": 911.23, "cet": "2,0200%", "annual_cet": "27,0635%", "base_iof": 16.0438115087348, "additional_iof": 3.462674, "total_iof": 19.51, "total_pre_fixed_amount": 107.1724201311, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 71, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 911.23, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.7004340324, "principal_amortization_amount": 66.1395659676, "tax_amount": 0.3850645530633672, "total_amount": 101.84, "workdays": 48.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0904340324, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7321865372069436, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5501976375, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.962293427670354, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2787691506, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.200454129395322, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4647537836, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4569031624724007, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4432263623, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.7046728086686769, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.8004660531, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.975585414468303, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5731733476, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2510118112073214, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.571888714, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.546146358734604, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3106059595, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.829493305847507, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-11", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.28, "issue_amount": 911.72, "cet": "2,0200%", "annual_cet": "27,0698%", "base_iof": 15.971922713858204, "additional_iof": 3.464536, "total_iof": 19.44, "total_pre_fixed_amount": 106.6790635687, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 70, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 911.72, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 35.2070774702, "principal_amortization_amount": 66.6329225298, "tax_amount": 0.382472975321052, "total_amount": 101.84, "workdays": 47.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0870774702, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7250082378225619, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5468410753, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9548911705344282, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2754125884, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.193089380135228, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4613972214, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.449275397223854, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4398698001, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6969941023233224, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7971094909, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.967776776466452, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5698167854, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.243057705867366, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5685321518, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.538088933548735, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3072493973, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141714, "principal_amortization_amount": 100.3081858286, "tax_amount": 2.8212680346152035, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-12", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 916.77, "issue_amount": 912.21, "cet": "2,0200%", "annual_cet": "27,0762%", "base_iof": 15.899954519820076, "additional_iof": 3.466398, "total_iof": 19.37, "total_pre_fixed_amount": 106.1854398936, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 69, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 912.21, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.7134537949, "principal_amortization_amount": 67.1265462051, "tax_amount": 0.3798019984284558, "total_amount": 101.84, "workdays": 46.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0834537949, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.71782993843818, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5432174, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9474889133985024, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2717889131, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.185724630875134, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4577735461, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4416476319753073, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.4362461248, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.689315395977968, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7934858156, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.959968138464601, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5661931101, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.2351036005274114, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5649084765, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.530031508362866, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.303625722, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141716, "principal_amortization_amount": 100.3081858284, "tax_amount": 2.8130427633716497, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-13", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.56 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.06, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.27, "issue_amount": 912.71, "cet": "2,0200%", "annual_cet": "27,0802%", "base_iof": 15.827906861727051, "additional_iof": 3.468298, "total_iof": 19.3, "total_pre_fixed_amount": 105.691548961, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 68, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 912.71, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 34.2195628621, "principal_amortization_amount": 67.6204371379, "tax_amount": 0.3770515574809304, "total_amount": 101.84, "workdays": 45.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0895628621, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7106516390537982, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5493264672, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9400866562625766, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2778979803, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.17835988161504, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4638826133, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4340198667267607, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.442355192, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6816366896326136, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7995948828, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.95215950046275, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5723021773, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.227149495187456, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5710175437, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.521974083176997, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3097347892, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141718, "principal_amortization_amount": 100.3081858282, "tax_amount": 2.8048174921281284, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } }, { "disbursement_date": "2024-11-14", "contract_fees": [ { "fee_type": "spread", "fee_amount": 4.57 }, { "fee_type": "ted_fee", "fee_amount": 1.5 } ], "external_contract_fees": [ { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0 } ], "contract_fee_amount": 6.07, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "assignment_amount": 917.77, "issue_amount": 913.2, "cet": "2,0200%", "annual_cet": "27,0870%", "base_iof": 15.755779674642707, "additional_iof": 3.47016, "total_iof": 19.23, "total_pre_fixed_amount": 105.1973906257, "installments": [ { "additional_costs": [], "business_due_date": "2025-01-21", "calendar_days": 67, "due_date": "2025-01-21", "due_interest": 0.0, "due_principal": 913.2, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": null, "pre_fixed_amount": 33.7254045271, "principal_amortization_amount": 68.1145954729, "tax_amount": 0.3742215875281126, "total_amount": 101.84, "workdays": 44.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-02-21", "calendar_days": 31, "due_date": "2025-02-21", "due_interest": 0.0, "due_principal": 845.0854045271, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": null, "pre_fixed_amount": 14.2997636051, "principal_amortization_amount": 87.5402363949, "tax_amount": 0.7034733396694164, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-03-21", "calendar_days": 28, "due_date": "2025-03-21", "due_interest": 0.0, "due_principal": 757.5451681322, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": null, "pre_fixed_amount": 11.5685715131, "principal_amortization_amount": 90.2714284869, "tax_amount": 0.9326843991266508, "total_amount": 101.84, "workdays": 18.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-04-21", "calendar_days": 33, "due_date": "2025-04-21", "due_interest": 0.0, "due_principal": 667.2737396453, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": null, "pre_fixed_amount": 12.025984633, "principal_amortization_amount": 89.814015367, "tax_amount": 1.170995132354946, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-05-21", "calendar_days": 28, "due_date": "2025-05-21", "due_interest": 0.0, "due_principal": 577.4597242783, "fine_amount": null, "has_interest": true, "installment_number": 5, "post_fixed_amount": null, "pre_fixed_amount": 8.8184725787, "principal_amortization_amount": 93.0215274213, "tax_amount": 1.4263921014782142, "total_amount": 101.84, "workdays": 19.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-06-21", "calendar_days": 31, "due_date": "2025-06-21", "due_interest": 0.0, "due_principal": 484.438196857, "fine_amount": null, "has_interest": true, "installment_number": 6, "post_fixed_amount": null, "pre_fixed_amount": 8.1972396908, "principal_amortization_amount": 93.6427603092, "tax_amount": 1.6739579832872593, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-07-21", "calendar_days": 31, "due_date": "2025-07-21", "due_interest": 0.0, "due_principal": 390.7954365478, "fine_amount": null, "has_interest": true, "installment_number": 7, "post_fixed_amount": null, "pre_fixed_amount": 6.6127072945, "principal_amortization_amount": 95.2272927055, "tax_amount": 1.944350862460899, "total_amount": 101.84, "workdays": 21.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-08-21", "calendar_days": 30, "due_date": "2025-08-21", "due_interest": 0.0, "due_principal": 295.5681438423, "fine_amount": null, "has_interest": true, "installment_number": 8, "post_fixed_amount": null, "pre_fixed_amount": 4.8387153664, "principal_amortization_amount": 97.0012846336, "tax_amount": 2.219195389847501, "total_amount": 101.84, "workdays": 22.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-09-21", "calendar_days": 33, "due_date": "2025-09-21", "due_interest": 0.0, "due_principal": 198.5668592087, "fine_amount": null, "has_interest": true, "installment_number": 9, "post_fixed_amount": null, "pre_fixed_amount": 3.5787172455, "principal_amortization_amount": 98.2612827545, "tax_amount": 2.513916657991128, "total_amount": 101.84, "workdays": 23.0, "installment_status": null, "installment_type": null }, { "additional_costs": [], "business_due_date": "2025-10-21", "calendar_days": 28, "due_date": "2025-10-21", "due_interest": 0.0, "due_principal": 100.3055764542, "fine_amount": null, "has_interest": true, "installment_number": 10, "post_fixed_amount": null, "pre_fixed_amount": 1.5318141715, "principal_amortization_amount": 100.3081858285, "tax_amount": 2.79659222089858, "total_amount": 101.84, "workdays": 20.0, "installment_status": null, "installment_type": null } ], "first_due_date": "2025-01-21", "prefixed_interest_rate": { "monthly_rate": 0.0166, "daily_rate": 0.00054142, "annual_rate": 0.21843191, "interest_base": "calendar_days_365" } } ] } } ``` ### Objeto Installments | Campo | Descrição | |-------|-----------| | additional_costs | Custos adicionais | | business_due_date | Data de vencimento em dia útil | | calendar_days | Dias corridos | | due_date | Data de vencimento | | due_interest | Juros do vencimento | | due_principal | Principal do vencimento | | fine_amount | Multa do vencimento | | has_interest | Indica se o vencimento possui juros | | installment_number | Número da parcela | | installment_status | Status da parcela | | installment_type | Tipo de parcela | | post_fixed_amount | Valor da parcela após juros | | pre_fixed_amount | Valor da parcela antes de juros | | principal_amortization_amount | Valor da amortização do principal da parcela | | tax_amount | Valor dos juros da parcela | | total_amount | Valor total da parcela | | workdays | Dias úteis | ### Objeto Prefixed Interest Rate | Campo | Descrição | |-------|-----------| | monthly_rate | Taxa mensal | | daily_rate | Taxa diária | | annual_rate | Taxa anual | | interest_base | Base de cálculo da taxa de juros | ### Webhooks Caso a operação não seja assinada ou averbada até a última opção de data de desembolso o parceiro receberá um webhook informando a respeito do cancelamento da operação: WEBHOOK TYPE debt STATUS Canceled **Webhook Body** ```json title="Webhook Body" { "key": "", "status": "canceled", "webhook_type": "debt", "event_datetime": "2025-03-18 13:46:31", "data": { "cancel_reason": "", "cancel_reason_enumerator": "" } } ``` ### Objeto Data | Campo | Descrição | |-------|-----------| | cancel_reason | Motivo do cancelamento | | cancel_reason_enumerator | Enumerador do motivo do cancelamento | ## Webhooks Após a assinatura do contrato, o parceiro receberá um webhook informando a respeito da assinatura do contrato. Com o seguinte body: ```json { "key": "", "status": "signed", "signers": [ { "id": "3271efd3-89ba-43aa-b032-af9a459e6096", "images": { "face_image_url": "https://qisign-face-images-bucket-sandbox.s3.amazonaws.com/fad7f924-d210-4ec4-9565-a57662a0a65a.jpeg", "document_back_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/8c7b68ba-07ad-4188-82ae-679833b2843b.jpeg", "document_front_url": "https://qisign-personal-documents-bucket-sandbox.s3.amazonaws.com/f63cd291-5668-4926-be5d-9290aeda3f6e.jpeg", "document_back_template": "cnh_back", "document_front_template": "cnh_front" }, "biometry": { "face_validation": { "score": 80, "provider": "qitech", "available": true }, "fraud_base_flag": false }, "document": { "template": "cnh_front", "face_match_score": 100 }, "liveness": { "result": "live" }, "signed_at": "2025-04-09T19:59:39Z", "ip_address": "182.224.219.198", "signer_data": { "name": "Nome Trabalhador", "email": "exemplo@qitech.com.br", "phone": { "number": "829549234", "area_code": "11", "international_dial_code": "55" }, "address": { "uf": "SP", "city": "Sao Paulo", "number": "123", "street": "Rua tal do sal", "complement": "Ap 23", "postal_code": "00000-000", "neighborhood": "Pinheiros" }, "pix_key": "pix03@pix03.com", "birthdate": "1996-03-13", "document_number": "504.856.400-66", "document_submission_method": "email", "authentication_submission_method": "sms" } } ], "webhook_type": "laas.credit_operation.status_change", "event_datetime": "2025-04-09 20:00:19", "signed_contract_url": "https://storage.googleapis.com/sandbox-doc-api/documents/9b55450e-fca5-44f2-9118-5851ed4bd92e/CCB-0000195364-2230409195718_signed.pdf" } ``` ### Objeto Signers | Campo | Descrição | |-------|-----------| | id | ID do signatário | | images | Imagens do signatário | ### Objeto Images | Campo | Descrição | |-------|-----------| | face_image_url | URL da imagem da face do signatário | | document_back_url | URL da imagem do verso do documento do signatário | | document_front_url | URL da imagem do documento do signatário | | document_back_template | Template do verso do documento do signatário | | document_front_template | Template do documento do signatário | ### Objeto Biometry | Campo | Descrição | |-------|-----------| | face_validation | Validação da rosto do signatário (true ou false) | | face_validation.score | Pontuação da rosto do signatário (0 a 100) | | face_validation.available | Disponibilidade da validação da rosto do signatário (true ou false) | | face_validation.provider | Provedor da validação da rosto do signatário (qitech ou external) | | fraud_base_flag | Flag de fraude base (true ou false) | ### Objeto Document | Campo | Descrição | |-------|-----------| | template | Template do documento (cnh_front, cnh_back, rg_front, rg_back) | | face_match_score | Pontuação da rosto do signatário (0 a 100) | ### Objeto Liveness | Campo | Descrição | |-------|-----------| | result | Resultado da liveness (live ou spoof) | ### Objeto Signer Data | Campo | Descrição | |-------|-----------| | name | Nome do signatário | | email | Email do signatário | | phone | Telefone do signatário | ### Objeto Address | Campo | Descrição | |-------|-----------| | uf | Unidade Federativa | | city | Cidade | | number | Número | | street | Rua | | complement | Complemento | | postal_code | CEP | | neighborhood | Bairro | ## Enumeradores ### Status da reserva {#status-da-reserva} ENUMERADOR reservation_status | Status | Descrição | | ----------------------------- | ------------------------------------------------------------------------- | | pending_reservation | A reserva foi criada e está pendente de averbação. | | pending_documents_submission | A reserva já foi averbada e está pendente de envio de documentos. | | reserved | A reserva foi averbada com sucesso. Fluxo de averbação concluído. | | canceled | Em caso de envio de documentos inválidos, a reserva é cancelada. | | settled | A reserva foi liquidada com sucesso. | | pending_deletion | A reserva está averbada e foi solicitada a exclusão. | | deleted | A reserva foi excluída com sucesso. | --- # Assinatura em Lote URL: /documentation/siape/assinatura-em-lote Agrupa **várias operações SIAPE** em **um único envelope** de assinatura do QI Sign. Você abre o lote, cria as operações referenciando o `document_batch_key`, confere (opcionalmente limpa) e dispara o envio para assinatura. Fluxo recomendado para [compra de dívida](./04-portabilidade-refin.md) — onde N duplas `debt_purchase` + `refinancing` + 1 refin/refin consolidador podem ser assinadas num único envelope (servidor assina uma vez só). :::caution Regras do lote **Mesma titularidade:** todas as operações do lote devem ser do **CPF** (ou do **mesmo representante legal**) do servidor. Incluir CPF "A" e CPF "B" no mesmo lote gera **erro síncrono** no `POST /debt`. **Tipos permitidos:** o lote SIAPE aceita apenas `POST /debt` com `collateral_type: federal_payroll`. ::: ## 1. Abrir o lote ENDPOINT /document/document_batch MÉTODO POST **Request Body** ```json { "type": "federal_payroll_external_batch", "certifier_type": "qi_sign", "batch_name": "Lote SIAPE compra-divida - 5ed20003-0610-46d2-88cc-a5d0de640696", "request_control_key": "5ed20003-0610-46d2-88cc-a5d0de640696" } ``` ### Campos chave | Campo | Tipo | Descrição | |---|---|---| | `type` | string | Fixo: **`federal_payroll_external_batch`** | | `certifier_type` | string | Fixo: **`qi_sign`** | | `batch_name` | string | Nome identificador do lote (**máximo 100 caracteres**) | | `request_control_key` | string (UUIDv4) | **Idempotência** — não reutilize entre lotes | **Response Body** ```json { "document_batch_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc" } ``` Guarde o `document_batch_key` retornado — ele é referenciado em todas as próximas chamadas. ## 2. Incluir operações no lote Ao criar cada operação SIAPE, envie **`document_batch_key` na raiz** do payload do `POST /debt` (mesmo nível dos demais campos principais). ENDPOINT /debt MÉTODO POST ```json { "document_batch_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc", "borrower": { "...": "demais campos do borrower" }, "financial": { "...": "demais campos financeiros" }, "operation_type": "refinancing", "collaterals": [ { "collateral_type": "federal_payroll", "collateral_data": { "reservation_type": "refinancing", "authority_code": "17000", "registration_code": "1354387" } } ], "modality": { "code": "0202" }, "refinanced_credit_operations": [ { "...": "operation_key + contrato externo (ver Portabilidade + Refin)" } ] } ``` O restante do body segue o contrato do `POST /debt`. Consulte os roteiros da [Margem Livre](./03-margem-livre.md) ou [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) conforme a modalidade. :::tip Compra de dívida cabe num lote só Pra [compra de dívida](./04-portabilidade-refin.md) (`debt_purchase` + `refinancing` port-enrustido), todas as duplas Op A + Op B + o refin/refin consolidador podem entrar no mesmo lote. ::: ## 3. Consultar documentos do lote Recomendado **antes de fechar o lote** para conferir os documentos agrupados. ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY MÉTODO GET **Response Body** ```json { "document_batch_key": "1eee4ec2-05f5-45ef-aa64-38bb3d9de02f", "documents": [ { "document_key": "5cca1dad-28fe-4f19-8bbb-0edd6f042384", "document_type": "ccb_pre_price_days" }, { "document_key": "c109d589-ae18-4f4f-ad31-2879bf714c71", "document_type": "ccb_pre_price_days" } ] } ``` ## 4. Limpar documentos do lote (opcional) Remove **todos os documentos** vinculados ao lote — útil pra reagrupar do zero se identificar inconsistência antes do envio. ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY/documents MÉTODO DELETE Body vazio. Response: HTTP 200. ## 5. Enviar para assinatura Fecha o lote e dispara os documentos pro QI Sign. **Antes desse PUT, os documentos não vão pro servidor.** É o gatilho final. ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY/send_to_signature MÉTODO PUT Body: `{}`. Response: HTTP 200. ## Erros comuns | HTTP | Código | Endpoint | Quando ocorre | |---|---|---|---| | 404 | `DOC000007` | `GET /document/document_batch/DOCUMENT_BATCH_KEY` | `document_batch_key` inexistente | | 409 | `DOC000103` | `POST /document/document_batch` | `request_control_key` duplicado (idempotência violada) | **Exemplo — DOC000103 (idempotência)** ```json { "code": "DOC000103", "title": "Bad Request", "description": "request_control_key already exists", "translation": "Chave de controle da request já existe.", "http_status": 409 } ``` :::info Conflito de titularidade Validação de **mesmo CPF/representante** no lote retorna erro no `POST /debt` (não no endpoint do lote). O corpo de erro segue o catálogo do `/debt`. ::: --- # Cancelamento, Desaverbação e Reversal (SIAPE) URL: /documentation/siape/cancelamento Cancelar uma operação SIAPE tem dois eixos independentes: 1. **Cancelamento da CCB** — estado da operação no LaaS, e eventual estorno do dinheiro desembolsado. 2. **Desaverbação no SIGEPE** — liberação da margem em folha. Os dois acontecem de forma assíncrona. Cancelar a operação NÃO libera a margem instantaneamente. ## 1. Pré-desembolso — Cancelamento Imediato ```http PATCH /debt/{DEBT_KEY}/cancel ``` Operação imediatamente vai pra `canceled`. Sem reversal financeiro (dinheiro nem saiu). QI dispara em seguida a desaverbação no SIGEPE. Webhook: `debt` com `status: canceled` + `cancel_reason_enumerator`. ## 2. Pós-desembolso — Janela de Desistência (7 dias úteis) **Janela legal de 7 dias úteis** após desembolso. Dentro dela: ```http PATCH /debt/{DEBT_KEY}/cancel ``` A response retorna um **PIX QR Code** pra borrower pagar de volta o dinheiro desembolsado: | Campo na response | Significado | |---|---| | `cancel_qr_code.qr_code_url` / `digitable_line` | PIX copia-e-cola | | `cancel_qr_code.amount` | Valor a devolver | | `cancel_qr_code.expiration` | Prazo (15 dias úteis após desembolso) | Quando o borrower paga: 1. QI confirma o pagamento. 2. Dispara o **reversal financeiro automático**. 3. Webhook `reversal`: ```json { "webhook_type": "reversal", "credit_operation_key": "", "reversal": { "status": "pending_fund", "amount": 2026.93, "is_total": true, "is_operation_canceled": true, "reversal_key": "" } } ``` 4. QI dispara a desaverbação no SIGEPE. 5. Operação vai pra `canceled`. > [!warning] Janela operacional do SIGEPE afeta desaverbação > Como o SIAPE só processa 07:00-00:00 em dias úteis, a desaverbação pode demorar. Cancelamento de PIX QR funciona 24/7 (BaaS); só a parte do SIGEPE espera janela. Restrições pós-desembolso: - Status `open` (sem parcelas pagas). - Pagamento parcial bloqueia o cancelamento. - Sem cancelamento parcial. ## 3. Cancelamento Permanente ```http PATCH /debt/{DEBT_KEY}/cancel/permanent ``` `canceled_permanently` — não há volta. Sem reversal automático. ## 4. Desaverbação no SIGEPE ![Fluxo de cancelamento SIAPE](/img/diagrams/siape-cancelamento.svg) | Status | Significado | |---|---| | `waiting_confirmation` | SIGEPE ainda processando | | `successfully_deleted` | Margem liberada | | `communication_error` | SIGEPE indisponível — QI retenta | Pra consultar: ```http GET /debt/{DEBT_KEY}/collateral ``` ## 5. Auto-cancelamento (7 dias) Operações em `canceled` por mais de 7 dias viram automaticamente `canceled_permanently`. Aplica-se a: - `consent_refused` - `consent_expired` - Pendente de assinatura além do prazo - QR não pago dentro de 15 dias úteis ## Resumo dos Endpoints | Endpoint | Quando usar | Reversal automático? | |---|---|---| | `PATCH /debt/{KEY}/cancel` (pré-desembolso) | Antes do desembolso | Não aplica | | `PATCH /debt/{KEY}/cancel` (pós-desembolso) | Em até 7 dias úteis após desembolso | Sim — após borrower pagar o PIX QR | | `PATCH /debt/{KEY}/cancel/permanent` | Definitivo (sem volta) | Não | ## Cancel reasons no webhook `debt` (`status: canceled`) | Enumerador | Significado | |---|---| | `manual` | Cancelado via API ou portal | | `waiting_signature` | Não assinou no prazo | | `not_collateral_constituted` | Averbação falhou (consent_refused, consent_expired, etc.) | | `is_portability` | Portabilidade falhou | | `pix_max_retry` | Muitas falhas no desembolso PIX | | `lack_of_resource` | Sem recurso pra desembolsar | | `kyc_not_accepted` | KYC reprovado | → [Lista completa de enumeradores em Mapa de Status](./08-mapa-de-status.md) --- # Consulta de Margem Consignável (SIAPE) URL: /documentation/siape/consulta-margem Endpoint que consulta a margem disponível do servidor federal no SIGEPE/SIAPE. Sem o `balance_key` desse passo, não dá pra simular nem emitir. ## Pré-requisitos 1. **Servidor pré-autorizou QI SCD** no Portal do Servidor (válida 30 dias). 2. `authority_code` (código UPAG) — recebido na fase comercial. > [!warning] > Diferente do Exército, **não há upload de documento de autorização**. Tudo é digital no portal. ## Endpoint ```http POST /federal_payroll/balance ``` | Campo | Tipo | Descrição | |---|---|---| | `document_number` | string | CPF do servidor (11 dígitos) | | `authority_code` | string | Código da Unidade Pagadora (UPAG) | | `registration_code` | string | Matrícula SIAPE | Resposta síncrona: ```json { "balance_key": "...", "status": "pending_search" } ``` ## Webhook de resultado Tipo: `federal_payroll.balance` Estrutura do payload de **sucesso**: ```json { "balance_query": [ { "available_balance": 3500.00, "authority_code": "17000", "registration_code": "1354387", "employment_relationship": "active", "consigned_credit": 1200.00, "consigned_card": 300.00 } ] } ``` - `available_balance` — margem disponível - `consigned_credit` — quanto já está consignado em crédito - `consigned_card` — quanto está em cartão consignado ## Enumeradores de falha (balance) | Enumerador | Significado | Ação | |---|---|---| | `unauthorized_institution` | Servidor não pré-autorizou QI SCD no portal | Pedir autorização | | `inexistent_relationship` | Sem vínculo federal | Verificar dados | | `invalid_document_number` | CPF malformado | Verificar CPF | | `inactive_federal_employee` | Servidor inativo | Não há ação | | `deceased_federal_employee` | Servidor falecido | Não há ação | ## Cenários de Sandbox ### Sucesso | `document_number` | `authority_code` | `registration_code` | |---|---|---| | 25256363506 | 17000 | 1354387 | ### Falha | `document_number` | `failure_reason` | |---|---| | 71987878353 | `unauthorized_institution` | > [!info] Reset diário > Reservas não-finalizadas no sandbox são **encerradas todo dia às 23:59h** pra manter o ambiente limpo. ## Próximo passo Após o webhook `succeeded` com `available_balance` retornado, escolha a modalidade: - [Margem Livre](./03-margem-livre.md) — crédito novo com margem disponível - [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) — refin de operação QI ou compra de dívida externa --- # Conta Interna para Desembolso URL: /documentation/siape/conta-interna-desembolso Em **compra de dívida**, **portabilidade** e **refinanciamento** consignado, o desembolso da operação **não vai direto para a conta externa do tomador**: ele cai numa conta interna **em nome do tomador** (aberta pelo parceiro via `POST /account`). É a partir dessa conta que a QI executa as ações pós-desembolso — **quitação do contrato externo**, **repasse de troco**, **conciliação**. :::tip Por que conta interna? Concentrar o desembolso numa conta operacional dá controle do fluxo: a QI consegue orquestrar quitação externa + averbação + repasse de troco sem depender de SLA de banco terceiro no meio do processo. ::: ## Quando usar conta interna vs externa | Cenário | `disbursement_bank_account` | |---|---| | [Margem Livre](./03-margem-livre.md) (crédito novo direto) | Conta **externa** do tomador | | [Refinanciamento puro](./04-portabilidade-refin.md) (renegocia CO QI ativa) | Conta **interna** em nome do tomador | | [Portabilidade](./04-portabilidade-refin.md) (com ou sem troco) | Conta **interna** em nome do tomador | | [Compra de dívida](./04-portabilidade-refin.md) (`debt_purchase` + `refinancing` port-enrustido) | Conta **interna** em nome do tomador **nas duas operações da dupla** | | Refin/refin consolidador (opcional, fecha várias port/refins) | Conta **interna** em nome do tomador | ## 1. Abrir a conta interna em nome do tomador ENDPOINT /account MÉTODO POST A conta é aberta pelo **parceiro** (autenticado com seus `client_integration_key`), com o `owner_document_number` apontando para o **CPF do tomador**. Reutilize a conta existente — uma por tomador (não abrir nova a cada operação). **Request Body** ```json { "owner_document_number": "", "owner_person_key": "", "requester_key": "", "webhook_enabled": true } ``` :::info Pré-requisito O tomador precisa estar **onboarded** previamente (ter `person_key`) — o parceiro envia esse `person_key` no `owner_person_key`. Caso contrário, o `/account` falha com `ACC000xxx` por validation. ::: **Response Body** ```json { "account_key": "602de111-21e1-4c1e-8c5c-d60c032309ca", "account_branch": "0001", "account_number": "1431704", "account_digit": "3", "owner_document_number": "", "owner_name": "", "bank_code": "329", "account_status": "active", "webhook_enabled": true } ``` :::tip Idempotência por tomador Se já existe conta ativa para esse `owner_document_number` no parceiro, evite chamar `POST /account` de novo — consulte `GET /accounts?owner_document_number= ` antes e reaproveite o `account_key` retornado. ::: ## 2. Usar a conta no `/debt` Use os dados retornados em `disbursement_bank_account` no payload do `POST /debt`. **A mesma conta vai nas DUAS operações da dupla `debt_purchase` + `refinancing`** (e no `refinancing` consolidador, se houver). ```json { "disbursement_bank_account": { "name": "", "bank_code": "329", "account_type": "checking_account", "account_branch": "0001", "account_number": "1431704", "account_digit": "3", "document_number": "", "transfer_method": "ted" } } ``` | Campo | Valor (conta interna QI Tech) | |---|---| | `bank_code` | `"329"` (QI Tech S.A. — SCD) | | `account_branch` | `"0001"` | | `account_number` / `account_digit` | retornados no `POST /account` | | `document_number` | **CPF do tomador** (mesmo do `owner_document_number`) | | `transfer_method` | `"ted"` (recomendado para `payment_type_id: 10`) | Exemplo completo: ver [Portabilidade + Refinanciamento — Compra de dívida](./04-portabilidade-refin.md). ## 3. Ações pós-desembolso A QI dispara as ações abaixo automaticamente conforme os webhooks confirmam cada etapa. ### 3.1 Conferir saldo ENDPOINT /account/ACCOUNT_KEY/balance MÉTODO GET ### 3.2 Quitação do contrato externo (port) Disparada pela QI ao receber `credit_operation.collateral` (`reservation_status: deleted`) na operação antiga: saldo da conta interna é enviado ao banco origem via **PIX** ou **TED** para liquidar o contrato externo. ### 3.3 Repasse de troco pro tomador (se houver) Se `final_disbursement_amount > 0` na simulação, o saldo residual é transferido da conta interna para a **conta externa do tomador** (informada no onboarding ou no payload da operação). ### 3.4 Conciliação ENDPOINT /account/ACCOUNT_KEY/statement MÉTODO GET Query params `from_date` e `to_date` no formato `YYYY-MM-DD`. ### 3.5 Webhooks relevantes | Webhook | Quando dispara | |---|---| | `account.balance_change` | Crédito recebido na conta interna (desembolso da CO) | | `pix_transfer.status_change` | Quitação externa OU repasse de troco confirmados | | `ted.status_change` | Quitação externa OU repasse via TED confirmados | ## Referências - [Conta de pagamento — fluxo completo](/documentation/contas/abertura_de_conta/fluxo_de_abertura_de_conta) — referência do `POST /account` em detalhes - [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) — usa essa conta em compra de dívida (`debt_purchase` + `refinancing`) - [Webhooks](./07-webhooks.md) — eventos assíncronos da operação --- # Modelos de Formalização (SIAPE) URL: /documentation/siape/formalizacao A QI suporta **5 modelos de formalização** pra operações SIAPE — mesmo conjunto do Exército. Adicionalmente, pra agrupar várias operações num único envelope (recomendado em [compra de dívida](./04-portabilidade-refin.md)), use [Assinatura em Lote](./11-assinatura-em-lote.md). :::tip Várias operações no mesmo envelope Em compra de dívida com N duplas `debt_purchase` + `refinancing` (+ refin/refin consolidador), use [Assinatura em Lote](./11-assinatura-em-lote.md) (`POST /document/document_batch` com `type: federal_payroll_external_batch`) — o servidor assina tudo de uma vez só. ::: ## Modelos disponíveis | Modelo | Quando usar | |---|---| | **QI Sign automático** (default) | QI envia link de assinatura ao borrower; nenhuma config extra | | **QI Sign em lote** | Várias operações num único envelope; ver [Assinatura em Lote](./11-assinatura-em-lote.md) | | **PDF assinado externamente** | Parceiro tem signature provider próprio | | **Data-signature: opt-in** | Borrower clica "concordo" em portal do parceiro | | **Data-signature: zip** | Parceiro envia zip de evidências | | **Data-signature: selfie** | Biometria via CaaS | ## QI Sign Automático Não requer chamada adicional após `/debt`. QI envia URL pro borrower. Webhook `debt` fires com `status: signature_finished`. ## PDF assinado externamente ```http POST /debt/{DEBT_KEY}/signed ``` ```json { "signed_document_key": "" } ``` ## Data-signature: opt-in ```json { "data_signature": { "type": "opt_in", "evidence": { "ip_address": "...", "user_agent": "...", "timestamp": "..." } } } ``` ## Data-signature: zip ```json { "data_signature": { "type": "zip", "signed_document_key": "" } } ``` ## Data-signature: selfie Requer integração CaaS (face match + liveness): ```json { "data_signature": { "type": "selfie", "signed_document_key": "" } } ``` ## Webhook após formalização `debt` com `status: signature_finished` — assinatura aceita pela QI. Em seguida, se `reservation_method: issuing`, a averbação é disparada agora; se `creation`, já foi disparada antes e o desembolso entra na fila quando confirmada. ## Próximo passo Após o `signature_finished`, a operação segue automaticamente: averbação confirmada (se `issuing`) → desembolso PIX/TED → webhook `debt` (`disbursed`). Para acompanhar via webhooks: [Webhooks](./07-webhooks.md). Para cancelar a qualquer momento: [Cancelamento](./06-cancelamento.md). --- # SIAPE-SIGEPE — Introdução URL: /documentation/siape/introducao API para originação de **CCB consignado** para **servidores públicos federais** (professores em universidades federais, funcionários em órgãos federais — **não inclui** militares). A reserva de margem é feita via **SIGEPE/SIAPE** e exige pré-autorização da QI SCD no **Portal do Servidor** pelo próprio servidor antes de qualquer operação. | Item | Valor | |---|---| | Autoridade pagadora | Governo Federal / **SIGEPE-SIAPE** | | Tipo de garantia (`collateral_type`) | `federal_payroll` | | Modelo de reserva | Averbação (assíncrona, consentida no Portal do Servidor) | | Funcionamento | **07:00–00:00, dias úteis, exceto feriados** | | Modalidades suportadas | [Margem Livre (Crédito Novo)](./03-margem-livre.md) e [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) | | Pré-autorização do servidor | **30 dias** de validade — Portal do Servidor: *Consignações → Empréstimo Consignado → Autorizar Consignatário* | | Instrumento | CCB (via `POST /debt`) | :::danger Atenção! Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: :::caution Janela operacional Diferente do Exército (24/7), o SIAPE só processa de **segunda a sexta, das 07:00 às 00:00**. Requisições de averbação fora dessa janela ficam em fila e são processadas no próximo dia útil. Planeje retries e SLA com isso em mente. ::: ## Fluxo End-to-End Em **margem livre** o desembolso vai direto pra conta externa do servidor. Em **refinanciamento, portabilidade e compra de dívida** o desembolso vai pra uma **conta interna em nome do tomador** (aberta pelo parceiro via `POST /account`) — daí a QI quita o contrato externo, repassa o troco e faz a conciliação. Ver [Conta Interna para Desembolso](./10-conta-interna-desembolso.md). ![Fluxo end-to-end SIAPE](/img/diagrams/siape-introducao.svg) ## Modalidades A operação se divide em quatro modalidades, escolhidas no `operation_type` e `collateral_data`: | Modalidade | `operation_type` / `reservation_type` | Quando usar | Doc | |---|---|---|---| | **Margem Livre** (Crédito Novo) | `operation_type: structured_operation` / `reservation_type: new_credit` | Servidor com margem disponível; sem dívida externa nem refin de operação ativa | [→ Margem Livre](./03-margem-livre.md) | | **Refinanciamento** | `operation_type: refinancing` / `reservation_type: refinancing` + `operation_key` | Renegociar operação QI ativa (prazo/taxa), eventualmente liberando troco | [→ Port + Refin](./04-portabilidade-refin.md) | | **Portabilidade** (com ou sem troco) | `operation_type: refinancing` / `reservation_type: refinancing` + `original_contract_number` | Trazer dívida de outro banco; pode incluir troco | [→ Port + Refin](./04-portabilidade-refin.md) | | **Compra de dívida** (port enrustida) | `operation_type: debt_purchase` + `operation_type: refinancing` (dupla) | Trazer N dívidas externas; QI emite uma dupla `debt_purchase` + `refinancing` por contrato externo, com desembolso em [conta interna em nome do tomador](./10-conta-interna-desembolso.md) | [→ Port + Refin](./04-portabilidade-refin.md) | ## Pré-requisitos 1. **Servidor pré-autorizou QI SCD no Portal do Servidor** — autorização válida 30 dias. Sem isso, `federal_payroll.balance` falha com `unauthorized_institution`. O parceiro deve orientar o servidor a entrar em `Consignações → Empréstimo Consignado → Autorizar Consignatário` antes de qualquer chamada. 2. **Não há upload de termo de autorização** — diferente do Exército, a autorização SIAPE é digital no portal (não há `authorization_document_key` no payload de balance). ## Referência por área - [Consulta de Margem](./02-consulta-margem.md) — endpoint `/federal_payroll/balance` + UPAG - [Margem Livre](./03-margem-livre.md) — Simulação + Emissão para `new_credit` - [Portabilidade + Refinanciamento](./04-portabilidade-refin.md) — Simulação + Emissão para `refinancing` + payloads de compra de dívida (`debt_purchase` + `refinancing` port-enrustido) - [Formalização](./05-formalizacao.md) — 5 modelos: QI Sign, PDF, opt-in, zip, selfie - [Conta Interna para Desembolso](./10-conta-interna-desembolso.md) — POST `/account` em nome do tomador + uso em compra de dívida + ações pós-desembolso - [Assinatura em Lote](./11-assinatura-em-lote.md) — agrupar várias operações num único envelope QI Sign (`POST /document/document_batch`) - [Cancelamento, Desaverbação e Reversal](./06-cancelamento.md) — pré + pós-desembolso + reversal automático - [Webhooks](./07-webhooks.md) — todos os eventos assíncronos + payloads - [Mapa de Status](./08-mapa-de-status.md) — enumeradores consolidados - [Mocks (Sandbox)](./09-mocks-sandbox.md) — dados de teste e cenários end-to-end --- # Mapa de Status URL: /documentation/siape/mapa-de-status Referência consolidada de todos os enumeradores que podem aparecer nas respostas síncronas e webhooks do produto consignado SIAPE. ## Consulta de Margem (`federal_payroll.balance`) | Status | Significado | |---|---| | `pending_search` | Resposta síncrona — consulta enfileirada | | `succeeded` | Webhook — margem retornada | | `failure` | Webhook — falha | ### Failure reasons | Enumerador | Significado | |---|---| | `unauthorized_institution` | Servidor não pré-autorizou QI SCD no Portal | | `inexistent_relationship` | Sem vínculo federal | | `invalid_document_number` | CPF malformado | | `inactive_federal_employee` | Servidor inativo | | `deceased_federal_employee` | Servidor falecido | ## Averbação / Desaverbação (`credit_operation.collateral`) | Status | Significado | |---|---| | `pending_consent` | SIGEPE aceitou; aguardando servidor confirmar no Portal | | `success` | Averbação confirmada (`collateral_constituted: true`) | | `failure` | Falha (ver enumerator) | ### Enumeradores de failure | Enumerador | Ação | |---|---| | `consent_refused` | Servidor recusou no Portal — cancela operação | | `consent_expired` | Janela de consentimento expirou — cancela | | `invalid_balance` | Margem insuficiente — cancela | | `unauthorized_institution` | Autorização QI SCD expirou no Portal — **retenta por até 7 dias** | | `origin_contract_not_found` | Contrato origem (port/refin) não existe — cancela | | `waiting_for_origin_contract_closure` | Aguardando quitação externa — permanece em retry | | `expired_portability` | Janela de port no SIGEPE fechou | | `successfully_deleted` | Margem desaverbada com sucesso | ## Operação (`debt`) | Status | Significado | |---|---| | `waiting_signature` | Aguardando assinatura | | `signature_finished` | Assinatura concluída | | `waiting_disbursement` | Aguardando desembolso | | `disbursed` | Desembolsado | | `canceled` | Cancelada (não-permanente) | | `canceled_permanently` | Cancelada definitivamente | | `settled` | Liquidada | ### Cancel reasons | Enumerador | Significado | |---|---| | `manual` | Cancelado via API ou portal | | `waiting_signature` | Não assinou no prazo | | `not_collateral_constituted` | Averbação falhou | | `is_portability` | Portabilidade falhou | | `pix_max_retry` | Muitas falhas no desembolso PIX | | `lack_of_resource` | Sem recurso pra desembolsar | | `kyc_not_accepted` | KYC reprovado | | `agencia_conta_invalida` | Erro em dados bancários | | `invalid_account` | Conta inválida | | `rejected_payment` | Pagamento recusado pelo banco destino | ## Reversal (cancelamento pós-desembolso) | Status | Significado | |---|---| | `pending_fund` | Reversal iniciado, aguardando devolução pro fundo | | `completed` | Reversal completo | | `failed` | Reversal falhou (raro — investigação manual) | ## Parcelas (`installment.status_change`) | Status | Significado | |---|---| | `opened` | Aberta, ainda não venceu | | `waiting_payment` | Aberta, na data de vencimento | | `paid` | Paga em dia | | `paid_early` | Paga antes do vencimento | | `paid_partial` | Paga parcialmente | | `paid_overdue` | Paga após o vencimento | | `paid_partial_overdue` | Paga parcialmente após vencimento | | `overdue` | Em atraso | | `canceled` | Cancelada | ## Recuperar último estado ```http GET /debt/{DEBT_KEY}/collateral ``` Retorna `last_response` + `reservation_status` + timestamp. --- # Margem Livre (Crédito Novo) URL: /documentation/siape/margem-livre Esteira de **originação direta** quando o servidor federal tem margem consignável disponível no SIAPE/SIGEPE. Cobre simulação e emissão para `reservation_type: new_credit`. Para refinanciar uma operação QI ativa ou trazer dívida de outro banco, ver [Portabilidade + Refinanciamento](./04-portabilidade-refin.md). ## Pré-requisitos - Servidor **pré-autorizou QI SCD no Portal do Servidor** (válida 30 dias). - `balance_key` recebido na [Consulta de Margem](./02-consulta-margem.md), com webhook `federal_payroll.balance` em `status: succeeded`. - `available_balance` retornado > parcela desejada × prazo. ## 1. Simulação ENDPOINT /debt_simulation MÉTODO POST **Request Body** ```json { "borrower": { "person_type": "natural", "individual_document_number": "25256363506" }, "financial": { "first_due_date": "2026-07-01", "installment_face_value": 500.00, "disbursement_date": "2026-06-02", "number_of_installments": 72, "monthly_interest_rate": 0.0185, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 } }, "collaterals": [ { "collateral_type": "federal_payroll", "percentage": 1, "collateral_data": { "reservation_type": "new_credit", "authority_code": "17000", "registration_code": "1354387" } } ] } ``` ### Campos chave | Campo | Descrição | |---|---| | `collaterals[].collateral_type` | **`federal_payroll`** (obrigatório) | | `collaterals[].collateral_data.reservation_type` | **`new_credit`** — sempre pra margem livre | | `collaterals[].collateral_data.authority_code` | Código da Unidade Pagadora (UPAG) | | `collaterals[].collateral_data.registration_code` | Matrícula SIAPE | | `financial.installment_face_value` | Parcela — ≤ `available_balance` | | `financial.number_of_installments` | Prazo (geralmente até 96 meses pra SIAPE) | `modality.code` **NÃO** é obrigatório em margem livre. ### Janela operacional Pra `disbursement_date`, lembre que o SIAPE só processa em **dias úteis das 07:00 às 00:00**. Datas em fim de semana ou feriados são empurradas pro próximo dia útil. ## 2. Emissão ENDPOINT /debt MÉTODO POST **Request Body** ```json { "borrower": { "name": "MARIA DOS SANTOS", "email": "maria@email.com", "phone": { "number": "900000000", "area_code": "11", "country_code": "+55" }, "address": { "city": "Brasília", "state": "DF", "number": "100", "street": "Esplanada", "complement": "", "postal_code": "70000000", "neighborhood": "Centro" }, "role_type": "issuer", "birth_date": "1978-09-22", "mother_name": "JOSEFINA DOS SANTOS", "person_type": "natural", "individual_document_number": "25256363506", "gender": "female", "nationality": "brasileiro", "is_pep": false, "marital_status": "married" }, "financial": , "simplified": true, "collaterals": [ { "collateral_type": "federal_payroll", "percentage": 1, "collateral_data": { "reservation_type": "new_credit", "reservation_method": "creation", "authority_code": "17000", "registration_code": "1354387" } } ], "disbursement_bank_account": { "name": "MARIA DOS SANTOS", "bank_code": "001", "account_type": "checking_account", "account_digit": "8", "branch_number": "1234", "account_number": "00098765", "document_number": "25256363506", "transfer_method": "ted" }, "purchaser_document_number": "32402502000135" } ``` ### `reservation_method` **creation (averbação imediata)** Averbação no SIGEPE dispara junto com a criação do `/debt`. **issuing (averbação após formalização)** Averbação só dispara após a formalização (`POST /debt/{KEY}/signed`). ### Etapa-chave: confirmação do servidor no Portal ![Fluxo de margem livre SIAPE](/img/diagrams/siape-margem-livre.svg) :::warning Servidor precisa confirmar Após o `/debt`, o webhook chega com `status: pending_consent`. **O servidor precisa entrar no Portal do Servidor e confirmar a operação** dentro da janela do SIGEPE. Se não confirmar, expira com `consent_expired` e cancela. Comunique o servidor imediatamente após o `/debt`. ::: ### Webhooks pós `/debt` | Webhook | Status | Quando | |---|---|---| | `debt` | `waiting_signature` | Operação criada | | `credit_operation.collateral` | `pending_consent` | Aguardando servidor confirmar no Portal | | `credit_operation.collateral` | `success` (`collateral_constituted: true`) | Servidor confirmou; averbação ativa | | `debt` | `disbursed` | Desembolso PIX/TED enviado | → Próximo passo: [Formalização](./05-formalizacao.md) ## Falhas comuns | Webhook / Erro | Enumerador | Significado | Ação | |---|---|---|---| | `federal_payroll.balance` | `unauthorized_institution` | Servidor não pré-autorizou QI SCD | Solicitar autorização | | `federal_payroll.balance` | `inexistent_relationship` | Sem vínculo federal | Verificar dados | | `credit_operation.collateral` | `invalid_balance` | Margem insuficiente | Reduzir parcela | | `credit_operation.collateral` | `consent_refused` | Servidor recusou no Portal | Conversar com servidor | | `credit_operation.collateral` | `consent_expired` | Janela do SIGEPE fechou | Re-emitir | → [Lista completa de enumeradores](./08-mapa-de-status.md) ## Sandbox ### Sucesso | `document_number` | `authority_code` | `registration_code` | |---|---|---| | 25256363506 | 17000 | 1354387 | ### Falha | `document_number` | `failure_reason` | |---|---| | 71987878353 | `unauthorized_institution` | → [Mocks completos](./09-mocks-sandbox.md) --- # Mocks (Sandbox) URL: /documentation/siape/mocks-sandbox O `federal-payroll-api` da QI Tech intercepta as chamadas ao SIAPE/SIGEPE em sandbox e retorna respostas mockadas via [`siape_mocker.py`](https://gitlab.qitech.com.br/qilaas/federal-payroll-api/-/blob/master/src/connectors/siape_mocker.py). Apenas os CPFs listados abaixo são reconhecidos — qualquer outro retorna `cdRetCode 9999` ("O número do documento informado não é um mock válido no ambiente de teste"). ## Sucesso completo (consulta + emissão + portabilidade) CPFs que passam por **todos** os endpoints (`consultarAutorizacoesMargemConsignavelV2`, `incluirContratoV2`, `incluirContratoPortabilidade`, `renovarContratoV2`, etc.) com retorno OK: | `document_number` (CPF) | `authority_code` | `registration_code` | |---|---|---| | 25256363506 | 17000 | 1354387 | | 03137300088 | 17000 | 1354387 | | 20472510010 | 17000 | 1354387 | | 67050758051 | 17000 | 1354387 | | 59669701066 | 17000 | 1354387 | Resposta esperada no webhook `federal_payroll.balance` (`status: succeeded`): ```xml nome: KAUAN RIBEIRO PEREIRA codOrgao: 17000 (MINISTERIO DA ECONOMIA) cdMatricula: 1354387 autorizacaoEmprestimo: S (válida até 09/10/2024) autorizacaoPortabilidade: S (válida até 24/10/2024) contratoPortado: nrCnpj: 00000000000191 nrContrato: 526985/WU vlMargemDisp: 100000 (geral), 50000 (portabilidade) ``` ## Cenários especiais ### CPF sem autorização (`unauthorized_institution`) | `document_number` | Comportamento | |---|---| | `71987878353` | Funciona apenas em `consultarAutorizacoesMargemConsignavelV2`. Retorna servidor "HELEN LUCIA REZENDE DE MORAES" com `autorizacaoEmprestimo: N` e `autorizacaoPortabilidade: N` | Use este CPF pra testar a UX de "peça pro servidor autorizar QI SCD no Portal". ### CPF sem margem (`consignable_margin_exceeded`) | `document_number` | Comportamento | |---|---| | `33673248090` | Funciona em `consultarAutorizacoes` (retorna `vlMargemDisp: 0`) E em `incluirContratoV2/incluirContratoPortabilidade/renovarContratoV2` (retorna `cdRetCode: 8058` "Funcionário não tem margem para essa solicitação") | Use este CPF pra testar fluxo de margem insuficiente após autorização concedida. ## CPFs fora da whitelist Qualquer outro CPF retorna: ```xml cdRetCode: 9999 dsRetCode: O número do documento informado não é um mock válido no ambiente de teste ``` Webhook resultante: `federal_payroll.balance` com `status: failure` + `failure_reason: mock_error`. ## Token e Portal do Servidor em Sandbox - **Não há autorização real no Portal do Servidor em sandbox.** Os mocks já trazem `autorizacaoEmprestimo: S` (ou N) baseado no CPF da whitelist. - O endpoint `consultarAnuenciaContratos` retorna `void` (não há body) — significa que o mock pula o passo de consulta de anuência. ## Portabilidade — dados do contrato origem mockados Quando você usa um CPF da whitelist e simula portabilidade, os mocks já têm: | Campo | Valor mockado | |---|---| | `original_financial_institution_document_number` | `00000000000191` (Banco do Brasil) | | `original_contract_number` | `526985/WU` | | `due_balance` mockado | varia conforme `vlMargemDisp` da resposta | Use estes valores ao montar o payload de `/debt` em portabilidade pra que o mock reconheça o contrato origem. ## Reset diário Reservas que não atingiram estado terminal (`reserved`, `canceled`, `deleted`) são **encerradas automaticamente às 23:59h** pra manter o ambiente limpo. ## Cenário end-to-end completo Sequência recomendada para validar a integração em sandbox: 1. `POST /federal_payroll/balance` com `25256363506` + `authority_code: 17000` + `registration_code: 1354387` 2. Aguardar webhook `federal_payroll.balance` (succeeded) com `available_balance` retornado 3. `POST /debt_simulation` com `installment_face_value` ≤ `available_balance` retornado 4. `POST /debt` com `reservation_method: creation` (margem livre) ou com `refinanced_credit_operations` (port com `original_contract_number: 526985/WU`) 5. Aguardar webhook `credit_operation.collateral` (`pending_consent` → `success`) — em sandbox o consent é automático após o `/debt` 6. `POST /debt/{KEY}/signed` com QI Sign ou data-signature opt-in 7. Aguardar webhook `debt` (`disbursed`) 8. (opcional cancelamento) `PATCH /debt/{KEY}/cancel` → recebe PIX QR → simular pagamento → webhook `reversal` ## Janela operacional sandbox Diferente da produção, o sandbox SIAPE **não respeita a janela 07:00-00:00** dias úteis — você pode rodar a qualquer hora, qualquer dia da semana. Em prod a janela é estrita. ## Endpoints mockados (referência interna) O `siape_mocker.py` cobre estes operation types do SIAPE (SOAP): | Operation type | Comportamento mockado | |---|---| | `consultarAutorizacoesMargemConsignavelV2` | Retorna dados do servidor + autorização emprestimo/portabilidade | | `incluirContratoV2` | Inclui novo contrato — sucesso pra CPFs whitelist | | `incluirContratoPortabilidade` | Inclui contrato de portabilidade — sucesso pra whitelist | | `renovarContratoV2` | Refinanciamento — sucesso pra whitelist | | `alterarContrato` | Sucesso fixo `cdRetCode: 0000` | | `consultarContrato` | Retorna situação `Ativo` ou `Aguardando Encerramento do Contrato` (port) | | `encerrarContrato` | Sucesso fixo | | `consultarAnuenciaContratos` | Void (pula passo) | --- # Portabilidade + Refinanciamento URL: /documentation/siape/portabilidade-refin Fluxo de **compra de dívida consignada** SIAPE via assinatura em lote. A QI Tech emite uma CCB de quitação (`debt_purchase`) que paga o banco vendedor, uma CCB de portabilidade (`portability`) que porta o contrato, e um `refinancing` consolidador **sempre obrigatório** que carrega seguro e troco. Tudo assinado de uma única vez na QI Sign. :::info Contas por operação Cada operação do fluxo exige uma conta de desembolso distinta: - **`debt_purchase`** → **conta interna QI** em nome do tomador. O desembolso cai nessa conta e quita a dívida origem no banco vendedor via `after_disbursement_actions` (boleto/PIX). - **`refinancing`** → **conta externa do tomador**. O troco do refinanciamento é desembolsado nessa conta. O parceiro abre a conta interna via `POST /account` antes da emissão. Ver [Conta Interna para Desembolso](./10-conta-interna-desembolso.md). ::: ## Cenários O `refinancing` consolidador é **sempre obrigatório** no batch federal — é ele quem carrega seguro e troco. | Cenário | Composição | Quando usar | |---|---|---| | **α** | 1× `debt_purchase` + 1× `portability` + 1× `refinancing` | Porta **uma** dívida externa | | **β** | N× `debt_purchase` + N× `portability` + 1× `refinancing` | Porta **N dívidas** externas num único envelope | | **γ** | α ou β + `financial.rebates` no `refinancing` | Qualquer composição acima com prêmio de seguro — gera `insurance_premium_term` automaticamente | :::caution Regra do seguro e do troco Seguro (`financial.rebates` com `fee_type: "insurance_premium_qi"`) e troco só podem ser enviados no `refinancing` consolidador (Passo 5). - **`debt_purchase`** — `rebates` proibido (CCB de quitação não carrega seguro). - **`portability`** — `rebates` proibido **e** `final_disbursement_amount` deve ser `0`. ::: ## Sequência de chamadas ``` 1. POST /upload (documentos da operação) 2. POST /account (conta interna QI p/ debt_purchase) 3. POST /document/document_batch 4. POST /debt (debt_purchase) → desembolso em conta interna QI 5. POST /debt (portability) → sem troco, sem seguro 6. POST /debt (refinancing) → seguro + troco em conta externa 7. PUT /document/document_batch/{key}/send_to_signature ``` :::caution Ordem obrigatória de inserção no batch `debt_purchase` deve ser inserido **antes** da `portability` que o referencia, e a `portability` **antes** do `refinancing` consolidador. Inverter a ordem dispara: - **`DOC000110`** (HTTP 422) — `portability` cujo `refinanced_credit_operations[].operation_key` não casa com nenhum `debt_purchase` já inserido no batch. - **`DOC000112`** (HTTP 422) — `refinancing` cujo `refinanced_credit_operations[].operation_key` não casa com nenhuma `portability` já inserida no batch. ::: --- ## 1. Upload dos documentos Antes de abrir a conta e o lote, faça o **upload dos documentos** exigidos na operação via `POST /upload`. Cada chamada retorna um `document_key`, identificador do documento referenciado nas etapas seguintes. ENDPOINT /upload MÉTODO POST → Autenticação, headers, FormData e exemplos de código (Python / Node.js) em [Upload de Documentos](../upload_de_documentos/upload_de_documentos.md) . :::caution Atenção Salve o `document_key` retornado — ele é necessário para a consulta e o uso futuro do documento. ::: --- ## 2. Abrir a conta interna em nome do tomador Em **compra de dívida**, **portabilidade** e **refinanciamento** do consignado federal (Siape), o desembolso da operação **não vai direto para a conta externa do tomador**: ele cai numa conta interna **em nome do tomador** (aberta pelo parceiro via `POST /account`). É a partir dessa conta que a QI executa as ações pós-desembolso — **quitação do contrato externo**, **repasse de troco**, **conciliação**. ENDPOINT /account MÉTODO POST A conta é aberta pelo **parceiro** (autenticado com seus `client_integration_key`), com o `owner_document_number` apontando para o **CPF do tomador**. Reutilize a conta existente — uma por tomador (não abrir nova a cada operação). **Request Body** ```json { "owner_document_number": "", "owner_person_key": "", "requester_key": "", "webhook_enabled": true } ``` **Response Body** ```json { "account_key": "1167955-...", "account_branch": "0001", "account_number": "1167955", "account_digit": "1", "owner_document_number": "", "owner_name": "", "bank_code": "329", "account_status": "active", "webhook_enabled": true } ``` :::tip Idempotência por tomador Se já existe conta ativa para esse `owner_document_number` no parceiro, evite chamar `POST /account` de novo — consulte `GET /accounts?owner_document_number= ` antes e reaproveite o `account_key` retornado. ::: --- ## 3. Abrir o lote ENDPOINT /document/document_batch MÉTODO POST **Request Body** ```json { "type": "federal_payroll_external_batch", "certifier_type": "qi_sign", "batch_name": "Lote SIAPE portabilidade - ", "request_control_key": "" } ``` ### Campos chave | Campo | Tipo | Descrição | |---|---|---| | `type` | string | Fixo: **`federal_payroll_external_batch`** | | `certifier_type` | string | Fixo: **`qi_sign`** | | `batch_name` | string | Nome identificador do lote — **único** (não reutilize entre lotes) e **máximo 100 caracteres** | | `request_control_key` | string (UUIDv4) | **Idempotência** — não reutilize entre lotes | **Response Body** ```json { "document_batch_key": "17f35e19-a039-468f-aaa7-84aa8edec3dc" } ``` Guarde o `document_batch_key` retornado — ele é referenciado em todas as chamadas seguintes. → Para consultar, limpar documentos ou conferir o batch antes do envio, ver [Assinatura em Lote](./11-assinatura-em-lote.md). --- ## 4. Emitir `debt_purchase` CCB de **quitação da dívida original**. A QI Tech vai pagar o banco vendedor. ENDPOINT /debt MÉTODO POST :::info Particularidades do `debt_purchase` - `document_batch_key` incluído na **raiz** do payload (mesmo nível de `borrower`, `financial`). - `disbursement_bank_account` aponta para a **conta interna QI** do tomador (Criada no passo 2). - `after_disbursement_actions` na raiz define a quitação automática da dívida origem após o desembolso (boleto ou PIX do banco vendedor). ::: **Request Body** ```json { "borrower": { "name": "MARIA DOS SANTOS", "email": "maria@email.com", "phone": { "number": "900000000", "area_code": "11", "country_code": "055" }, "is_pep": false, "address": { "city": "Brasília", "state": "DF", "number": "100", "street": "Esplanada dos Ministérios", "complement": "", "postal_code": "70000000", "neighborhood": "Centro" }, "role_type": "issuer", "birth_date": "1978-09-22", "mother_name": "JOSEFINA DOS SANTOS", "nationality": "Brasileiro", "person_type": "natural", "marital_status": "married", "individual_document_number": "25256363506", "gender": "female", "document_identification_type": "rg", "document_identification_number": "1234567", "document_identification_date": "2015-01-01" }, "financial": { "first_due_date": "2026-06-10", "installment_face_value": 100, "disbursement_date": "2026-05-10", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.017, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "simplified": true, "collaterals": [], "requester_identifier_key": "", "disbursement_bank_account": { "bank_code": "329", "account_digit": "7", "branch_number": "0001", "account_number": "4944068", "document_number": "25256363506", "name": "MARIA DOS SANTOS" }, "purchaser_document_number": "", "document_batch_key": "", "after_disbursement_actions": [ { "action_type": "bankslip_payment", "action_data": { "qr_code": null, "destination": null, "digitable_line": "03399199530490000005237385601010297590005474921", "pix_transfer_type": null, "transaction_amount": 0 } } ] } ``` ### Campos que devem ser alterados | Campo | Obrigatório alterar? | Observação | |---|---|---| | `document_batch_key` | ✅ Sim | Valor retornado no Passo 2 | | `borrower.*` | ✅ Sim | Dados reais do tomador | | `financial.first_due_date` / `disbursement_date` | ✅ Sim | Conforme calendário da operação | | `financial.installment_face_value` / `number_of_installments` / `monthly_interest_rate` | ✅ Sim | Conforme condições comerciais | | `purchaser_document_number` | ✅ Sim | CNPJ do comprador (via variável de ambiente) | | `requester_identifier_key` | ✅ Sim | UUIDv4 único por requisição | | `disbursement_bank_account` | ✅ Sim | **Conta interna QI em nome do tomador** | | `after_disbursement_actions` | ✅ Sim | Quitação da dívida origem. `action_type`: `bankslip_payment` (boleto) ou PIX. Preencha `digitable_line` (boleto) ou `qr_code` (PIX) do banco vendedor | **Response Body** ```json { "proposal_id": "", "status": 200, "key": "", "data": { "credit_operation_key": "", "status": "waiting_signature" } } ``` **Guarde a `key` retornada** — ela é passada em `refinanced_credit_operations[].operation_key` da `portability` correspondente. --- ## 5. Emitir `portability` CCB de **portabilidade da dívida**. Cada portabilidade referencia **exatamente um** `debt_purchase` via `refinanced_credit_operations`. **Não carrega seguro nem troco** — ambos vão no `refinancing` consolidador. ENDPOINT /debt MÉTODO POST :::info Particularidades da `portability` - `collaterals[0].collateral_data.portability_data` é **obrigatório** — contém os dados do contrato de origem na instituição vendedora. - `refinanced_credit_operations` carrega a `key` do `debt_purchase` correspondente. ::: :::caution Portabilidade sem seguro e sem troco Em batch federal, a `portability` **não pode** carregar `financial.rebates` (seguro). O seguro é enviado exclusivamente no `refinancing` consolidador. A QI Tech rejeita o `POST /debt` que violar essa regra. ::: **Request Body** ```json { "borrower": { "...": "mesmo borrower do Passo 4" }, "financial": { "first_due_date": "2026-06-10", "disbursement_date": "2026-05-10", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.017, "interest_type": "pre_price_days", "final_disbursement_amount": 0, "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "federal_payroll", "collateral_data": { "authority": { "description": "GOVERNO DO DISTRITO FEDERAL", "authority_document_number": "00.394.601/0001-26" }, "authority_code": "99072", "reservation_type": "portability", "registration_code": "1393831", "reservation_method": "issuing", "pensioner_registration_code": "", "portability_data": { "start_date": "2024-06-24", "control_number": "57309647149", "origin_contract": { "contract_number": "866415127", "financial_institution_document_number": "90400888000142" } } } } ], "requester_identifier_key": "", "disbursement_bank_account": { "...": "mesmo disbursement do Passo 4" }, "purchaser_document_number": "", "document_batch_key": "", "refinanced_credit_operations": [ { "operation_key": "" } ] } ``` ### Campos que devem ser alterados | Campo | Obrigatório alterar? | Observação | |---|---|---| | `document_batch_key` | ✅ Sim | Valor retornado no Passo 2 | | `refinanced_credit_operations[0].operation_key` | ✅ Sim | `key` do `debt_purchase` referenciado (Passo 4) | | `collaterals[0].collateral_data.registration_code` | ✅ Sim | Matrícula SIAPE do servidor | | `collaterals[0].collateral_data.authority_code` / `authority.description` / `authority.authority_document_number` | ✅ Sim | Órgão pagador (UPAG) | | `portability_data.start_date` | ✅ Sim | Data de início do contrato de origem | | `portability_data.control_number` | ✅ Sim | Número de controle no SIAPE | | `portability_data.origin_contract.contract_number` | ✅ Sim | Nº do contrato na instituição vendedora | | `portability_data.origin_contract.financial_institution_document_number` | ✅ Sim | CNPJ da instituição vendedora | | `financial.installment_face_value` | 🚫 Não enviar | Valor da parcela (auto calculado) | | `financial.rebates` | 🚫 Proibido | Seguro não é aceito em portabilidade — só no `refinancing` | **Response Body** ```json { "proposal_id": "", "status": 200, "key": "", "data": { "credit_operation_key": "", "status": "waiting_signature" } } ``` **Guarde a `key` desta portabilidade** — usada em `refinanced_credit_operations` do `refinancing` consolidador (Passo 5) no cenário β. ### Erros possíveis na criação | Código | HTTP | Quando | |---|---|---| | `DOC000110` | 422 | `refinanced_credit_operations[].operation_key` não casa com nenhum `credit_operation_key` de `debt_purchase` já inserido no batch | | `DOC000114` | 422 | `refinanced_credit_operations[].operation_key` já está em outra portabilidade do mesmo batch (duplicidade) | | `COP000515` | 400 | `final_disbursement_amount` ≠ `0` — portabilidade não carrega troco | | `COP000516` | 400 | `financial.rebates` presente — portabilidade federal não aceita seguro | --- ## 6. Emitir `refinancing` consolidador CCB **mãe** que consolida as portabilidades num único instrumento. **Sempre obrigatória** no batch federal — tanto no cenário α (1 portabilidade) quanto no β (N portabilidades). É a única operação do fluxo que carrega **seguro** e **troco**. ENDPOINT /debt MÉTODO POST :::info Particularidades do `refinancing` consolidador - `reservation_type: "refinancing"` no `collateral_data`. - `refinanced_credit_operations` lista as `key` de **todas** as portabilidades do batch. - `disbursement_bank_account` aponta para a **conta externa do tomador** — destino do troco. - `financial.rebates` é **opcional** — único lugar do fluxo que aceita seguro. - `after_disbursement_actions` só é enviado **quando há seguro** — liquida o prêmio após o desembolso. ::: :::caution `after_disbursement_actions` exige seguro `after_disbursement_actions` só pode ser enviado no `refinancing` **quando a operação tem seguro** (`financial.rebates` presente). Enviar `after_disbursement_actions` sem `rebates` faz a QI Tech rejeitar o `POST /debt`. ::: **Request Body** **Sem seguro** ```json { "borrower": { "...": "mesmo borrower" }, "financial": { "first_due_date": "2026-06-10", "installment_face_value": 1000, "disbursement_date": "2026-05-10", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.017, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0 }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "federal_payroll", "collateral_data": { "authority": { "description": "GOVERNO DO DISTRITO FEDERAL", "authority_document_number": "00.394.601/0001-26" }, "authority_code": "99072", "reservation_type": "refinancing", "registration_code": "1393831", "reservation_method": "issuing", "pensioner_registration_code": "" } } ], "requester_identifier_key": "", "disbursement_bank_account": { "...": "conta externa do tomador" }, "purchaser_document_number": "", "document_batch_key": "", "refinanced_credit_operations": [ { "operation_key": "" }, { "operation_key": "" } ] } ``` **Com seguro + troco (Cenário γ)** ```json { "borrower": { "...": "mesmo borrower" }, "financial": { "first_due_date": "2026-06-10", "installment_face_value": 1500, "disbursement_date": "2026-05-10", "limit_days_to_disburse": 5, "number_of_installments": 20, "monthly_interest_rate": 0.017, "interest_type": "pre_price_days", "fine_configuration": { "monthly_rate": 0.01, "interest_base": "calendar_days", "contract_fine_rate": 0.02 }, "credit_operation_type": "ccb", "interest_grace_period": 0, "principal_grace_period": 0, "rebates": [ { "fee_type": "insurance_premium_qi", "description": "credit_insurance_blindado" } ] }, "simplified": true, "collaterals": [ { "percentage": 1, "collateral_type": "federal_payroll", "collateral_data": { "authority": { "description": "GOVERNO DO DISTRITO FEDERAL", "authority_document_number": "00.394.601/0001-26" }, "authority_code": "99072", "reservation_type": "refinancing", "registration_code": "1393831", "reservation_method": "issuing", "pensioner_registration_code": "" } } ], "requester_identifier_key": "", "disbursement_bank_account": { "...": "conta externa do tomador" }, "purchaser_document_number": "", "document_batch_key": "", "refinanced_credit_operations": [ { "operation_key": "" }, { "operation_key": "" } ], "after_disbursement_actions": [ { "action_type": "bankslip_payment", "action_data": { "qr_code": null, "destination": null, "digitable_line": "03399199530490000005237385601010297590005474921", "pix_transfer_type": null, "transaction_amount": 0 } } ] } ``` ### Campos que devem ser alterados | Campo | Obrigatório alterar? | Observação | |---|---|---| | `document_batch_key` | ✅ Sim | Valor retornado no Passo 2 | | `refinanced_credit_operations` | ✅ Sim | **Todas** as `key` das portabilidades emitidas no Passo 5 | | `collaterals[0].collateral_data.authority.*` / `authority_code` / `registration_code` | ✅ Sim | Conforme órgão e servidor | | `reservation_method` | ✅ Sim | Sempre `"issuing"` para o consolidador | | `disbursement_bank_account` | ✅ Sim | **Conta externa do tomador** — destino do troco | | `financial.rebates` | ⚠️ Opcional | Único lugar do fluxo que aceita seguro. Incluir `[{ "fee_type": "insurance_premium_qi", ... }]` apenas se a operação tem seguro | | `financial.final_disbursement_amount` | 🚫 Não enviar | Valor final do desembolso (troco) calculado automaticamente baseado no valor da parcela | | `after_disbursement_actions` | ⚠️ Só com seguro | Liquida o prêmio do seguro após desembolso. **Só envie quando `rebates` está presente** — caso contrário a QI Tech rejeita o `POST /debt` | ### Erros possíveis na criação | Código | HTTP | Quando | |---|---|---| | `DOC000109` | 422 | Batch já contém outro `refinancing` — só 1 por batch | | `DOC000112` | 422 | `refinanced_credit_operations[].operation_key` não casa com nenhum `credit_operation_key` de portabilidade no batch | | `COP000517` | 400 | `refinancing` **com** seguro (`rebates`) sem nenhuma `after_disbursement_actions` — seguro exige ao menos uma ação pós-desembolso | | `COP000518` | 400 | `refinancing` **sem** seguro carregando `after_disbursement_actions` — só permitido quando há `rebates` | --- ## 7. Enviar para assinatura Fecha o lote e dispara os documentos para o QI Sign. **Antes desse PUT, nada é enviado ao servidor.** ENDPOINT /document/document_batch/DOCUMENT_BATCH_KEY/send_to_signature MÉTODO PUT Body: `{}`. Response: **HTTP 200**. ### Erros possíveis no envio | Código | HTTP | Quando | |---|---|---| | `DOC000108` | 422 | Batch contém mais de 1 `insurance_premium_term` | | `DOC000109` | 422 | Batch contém mais de 1 `refinancing` | | `DOC000110` | 422 | `portability` cujo `refinanced_op` não casa com nenhum `debt_purchase` no batch | | `DOC000111` | 422 | Batch **sem** `refinancing` consolidador | | `DOC000114` | 422 | `debt_purchase` referenciado por 0 ou mais de 1 portabilidade | :::tip Conferir antes de enviar Use `GET /document/document_batch/DOCUMENT_BATCH_KEY` para listar os documentos agrupados e confirmar a composição antes do `send_to_signature`. Ver [Assinatura em Lote](./11-assinatura-em-lote.md). ::: → Próximo passo: [Formalização](./05-formalizacao.md) --- ## Mapa consolidado de erros | Código | HTTP | Ponto de disparo | Quando | |---|---|---|---| | `DOC000108` | 422 | criação + envio | Mais de 1 `insurance_premium_term` no batch | | `DOC000109` | 422 | criação + envio | Mais de 1 `refinancing` no batch | | `DOC000110` | 422 | criação + envio | `portability` com `refinanced_op` sem `debt_purchase` casado no batch | | `DOC000111` | 422 | envio | Batch sem `refinancing` consolidador | | `DOC000112` | 422 | criação | `refinancing` com `refinanced_op` sem portabilidade casada no batch | | `DOC000114` | 422 | criação + envio | `debt_purchase` referenciado por ≠ 1 portabilidade (0 órfão ou ≥ 2 duplicado) | | `COP000515` | 400 | criação (`portability`) | `final_disbursement_amount` ≠ `0` na portabilidade | | `COP000516` | 400 | criação (`portability`) | `financial.rebates` enviado na portabilidade federal | | `COP000517` | 400 | criação (`refinancing`) | `refinancing` com seguro sem nenhuma `after_disbursement_actions` | | `COP000518` | 400 | criação (`refinancing`) | `refinancing` sem seguro carregando `after_disbursement_actions` | :::info Notas sobre erros recorrentes - `DOC000110` dispara em **dois momentos**: na criação da portabilidade (validação imediata) e no envio (cobertura defensiva). - `DOC000114` dispara em **dois momentos**: na criação da segunda portabilidade duplicada e no envio (cobre o `debt_purchase` órfão, i.e. `count = 0`). - `DOC000111` dispara **apenas no envio** — não há validação na criação. - Batches que **não** são `federal_payroll_external_batch` não disparam nenhuma das validações acima. ::: --- ## Glossário | Termo | Significado | |---|---| | **CCB** | Cédula de Crédito Bancário — instrumento de dívida emitido pelo banco | | **SIAPE** | Sistema Integrado de Administração de Recursos Humanos do Governo Federal — folha de pagamento dos servidores da União | | **UPAG** | Unidade Pagadora — órgão da União que paga o salário do servidor (identificado por `authority_code` + `authority_document_number`) | | **matrícula SIAPE** | `registration_code` — identificador do servidor na folha | | **portability_data** | Dados do contrato de origem na instituição vendedora (`start_date`, `control_number`, `contract_number`, `financial_institution_document_number`) | | **credit_operation_key** | Chave única da operação retornada por `POST /debt` — também chamada `key` | | **insurance_premium_term** | Documento extra gerado automaticamente no batch quando uma `portability` ou `refinancing` carrega `financial.rebates` com `fee_type: "insurance_premium_qi"`. **Nunca** originado de `debt_purchase` | | **QI Sign** | Provedor de assinatura digital QI Tech (configurado via `certifier_type: "qi_sign"`) | --- # Webhooks URL: /documentation/siape/webhooks Eventos assíncronos emitidos pela QI Tech durante o ciclo de vida da operação consignada SIAPE. Todos seguem o protocolo unificado de [Webhooks QI](/documentation/webhooks/notificacoes_baas_e_laas) — 5 segundos pra resposta HTTP 200 com `encoded_body` assinado, 3 retries de 5 minutos em caso de falha. :::danger Atenção! Os webhooks da QI Tech **não devem ser mapeados de forma restrita**. Campos adicionais podem ser incluídos aos payloads a qualquer momento. Use desserialização permissiva. ::: ## Webhooks específicos do produto SIAPE | Webhook | Quando dispara | Origem | |---|---|---| | `federal_payroll.balance` | Resultado da consulta de margem (`succeeded` ou `failure`) | federal-payroll-api | | `credit_operation.collateral` | Averbação ou desaverbação no SIGEPE | credit-operation-api | | `credit_transfer.received_portability` | Portabilidade externa recebida (banco origem aceitou) | credit-transfer-api | | `credit_transfer_status_change` | Atualização do credit-transfer | credit-transfer-api | ## Webhooks comuns LaaS | Webhook | Status | Quando dispara | |---|---|---| | `debt` | `waiting_signature` | Operação criada, aguardando assinatura | | `debt` | `signature_finished` | Assinatura concluída | | `debt` | `disbursed` | Desembolso PIX/TED enviado | | `debt` | `canceled` | Operação cancelada | | `debt` | `canceled_permanently` | Cancelamento definitivo | | `debt` | `settled` | Operação liquidada | | `reversal` | `pending_fund` | Borrower pagou PIX QR de cancelamento — reversal iniciado | | `installment.status_change` | `paid` / `overdue` / etc | Mudança de status de parcela individual | | `laas.devolution.refund_receipt` | `refunded` | Devolução de overpayment via PIX | ## Estrutura padrão ```json { "key": "", "data": , "status": "", "webhook_type": "", "event_datetime": "2026-06-02 14:30:00" } ``` ## Exemplos ### `federal_payroll.balance` (sucesso) ```json { "webhook_type": "federal_payroll.balance", "key": "81da8afb-e1b2-4215-8093-c4b5feab8a9f", "status": "succeeded", "data": { "balance_query": [ { "available_balance": 3500.00, "authority_code": "17000", "registration_code": "1354387", "employment_relationship": "active", "consigned_credit": 1200.00, "consigned_card": 300.00 } ] }, "event_datetime": "2026-06-02 14:30:00" } ``` ### `credit_operation.collateral` (pending_consent) ```json { "webhook_type": "credit_operation.collateral", "key": "27a099df-4688-43cb-87fa-515b1cf343a5", "status": "pending_consent", "data": { "collateral_constituted": false, "enumerator": "waiting_borrower_consent" }, "event_datetime": "2026-06-02 15:00:00" } ``` ### `credit_operation.collateral` (success) ```json { "webhook_type": "credit_operation.collateral", "key": "27a099df-4688-43cb-87fa-515b1cf343a5", "status": "success", "data": { "collateral_constituted": true, "enumerator": "successfully_reserved", "reservation_status": "reserved" }, "event_datetime": "2026-06-02 15:30:00" } ``` ### `debt` (disbursed) ```json { "webhook_type": "debt", "key": "27a099df-4688-43cb-87fa-515b1cf343a5", "status": "disbursed", "data": { "ted_receipt_list": [{ "amount": 12500.00, "transaction_key": "...", "destination": { "name": "MARIA DOS SANTOS", "bank_ispb": "60746948" } }] }, "event_datetime": "2026-06-02 16:00:00" } ``` ### `reversal` (cancelamento pós-desembolso) ```json { "webhook_type": "reversal", "credit_operation_key": "2893b8bd-...", "contract_number": "0000049333/TW", "reversal": { "status": "pending_fund", "amount": 12500.00, "is_total": true, "is_operation_canceled": true, "reversal_key": "...", "date": "2026-09-06" } } ``` ## Cancel reasons (`cancel_reason_enumerator`) | Enumerador | Significado | |---|---| | `manual` | Cancelado via API ou portal | | `waiting_signature` | Não assinou no prazo | | `not_collateral_constituted` | Averbação falhou (`consent_refused`, `consent_expired`, etc.) | | `is_portability` | Portabilidade falhou | | `pix_max_retry` | Muitas falhas no desembolso PIX | | `lack_of_resource` | Sem recurso pra desembolsar | | `kyc_not_accepted` | KYC reprovado | → Lista completa em [Mapa de Status](./08-mapa-de-status.md) ## Reenvio Manual Webhooks podem ser consultados e reenviados via portal seguindo [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes).