# QI Tech — Crédito Consignado › Consignado Privado Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 30 página(s). Índice: - Manual Consignado Privado - Averbação de Novos Empréstimos: Consulta de Reservas (/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas) - Manual Consignado Privado - Averbação de Novos Empréstimos: Enumeradores (/documentation/manual_consignado_privado/averbacao_novos_emprestimos/enumeradores) - Manual Consignado Privado - Averbação de Novos Empréstimos: Erros de Averbação (/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros) - Manual Consignado Privado - Averbação de Novos Empréstimos: Autorização e Averbação (/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico) - Manual Consignado Privado - Averbação de Novos Empréstimos: Regras de Negócio (/documentation/manual_consignado_privado/averbacao_novos_emprestimos/visao_geral) - 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 - 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) - Manual Consignado Privado - Movimentação de Vínculos: Consulta de Reservas (/documentation/manual_consignado_privado/vinculos_empregaticios/consultas) - Manual Consignado Privado - Movimentação de Vínculos: Enumeradores (/documentation/manual_consignado_privado/vinculos_empregaticios/enumeradores) - Manual Consignado Privado - Movimentação de Vínculos: Webhooks de Movimentação (/documentation/manual_consignado_privado/vinculos_empregaticios/movimentacao_de_vinculos) - Manual Consignado Privado - Movimentação de Vínculos: Averbação por Revínculo (/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo) - Manual Consignado Privado - Movimentação de Vínculos: Regras de Negócio (/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral) --- # Manual Consignado Privado - Averbação de Novos Empréstimos: Consulta de Reservas URL: /documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas Há duas formas de consultar reservas: por operação específica (`external_key`), útil para acompanhar uma única contratação e recuperar seus comprovantes de averbação/desaverbação; ou em lote (paginada), útil para monitorar várias operações de uma vez sem precisar conhecer a `external_key` de cada uma. ## Consulta por operação (external_key) {#consulta-por-operacao-external_key} Para consultar os dados da averbação de uma operação específica — e, com ela, os **comprovantes de protocolo de averbação ou desaverbação** — pode-se utilizar o endpoint: :::warning Comprovantes de averbação e desaverbação É possível recuperar os comprovantes de averbação, desaverbação e suspensão através do objeto `protocols` da resposta deste endpoint. Os possíveis enumeradores para `protocol_type` estão disponíveis na tabela [Tipos de protocolo](/documentation/manual_consignado_privado/manual_averbação_desembolso#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 } } ``` ## Consulta em lote (paginada) :::info Novidade Endpoint novo de consulta paginada de reservas, útil para monitorar em lote o andamento de averbações — sem precisar conhecer previamente a `external_key` de cada operação. ::: Diferente da consulta por operação acima, este endpoint não recebe nenhuma `external_key` — ele **lista e filtra reservas em lote**, entre todas as operações do solicitante. **GET** /private_payroll/reservation Testar no Playground A consulta é sempre restrita às reservas do próprio solicitante autenticado — não é necessário (nem possível) informar o `requester_key` como filtro. Para acompanhar novas contratações, filtre por `reservation_type=new_credit`. ### Query Params | Campo | Descrição | Tipo | Obrigatório | Valores | |---|---|---|---|---| | `document_number` | CPF do trabalhador, para filtrar as reservas de um único tomador | Texto | Não | — | | `reservation_type` | Filtra pelo método de averbação da reserva | Texto | Não | `new_credit`, `refinancing`, `portability`, `transferred` | | `reservation_status` | Filtra pelo status atual da reserva | Texto | Não | Ver [Enumeradores](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/enumeradores#reservation_status) | | `page_number` | Número da página, começando em 1 | Número | Não (padrão `1`) | Mínimo `1` | | `page_rows` | Quantidade de registros por página | Número | Não (padrão `25`) | Entre `1` e `100` | ### Response sucesso STATUS **200** **Response Body** ```json { "data": [ { "reservation_key": "", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "document_number": "12345678901", "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", "expiration_date": null, "contract_data": { "amount": 5000.00, "installments": 12, "interest_rate": 0.018 }, "reservation_data": { "installment_value": 500.00, "margin_value": 450.00 }, "reservation_type": "new_credit", "reservation_status": "reserved", "reservation_documents_submission_status": "sent", "protocols": {}, "next_check_datetime": null, "next_billing_execution_datetime": null, "balance_inquiry_data": {}, "periods": [], "warranty_type": null } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 25 } } ``` Cada item de `data` tem o mesmo formato retornado pelos endpoints de autorização (ver [Autorização e Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico#1-autorizacao)). Já `pagination.next_page` vem `null` quando a página atual é a última (ou seja, quando a quantidade de itens retornados em `data` é menor que `page_rows`); caso contrário, traz o número da próxima página a ser consultada. ### Response falha Quando nenhuma reserva atende aos filtros informados, o endpoint retorna: STATUS **404** **Response Body** ```json { "title": "Reservation not found", "code": "PRP000035", "description": "The reservation was not found", "translation": "A reserva não foi encontrada" } ``` --- # Manual Consignado Privado - Averbação de Novos Empréstimos: Enumeradores URL: /documentation/manual_consignado_privado/averbacao_novos_emprestimos/enumeradores :::info Motivos de falha na averbação Os motivos retornados pela DATAPREV em uma averbação sem sucesso (e a lógica de retentativa vs. cancelamento) estão em [Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros#motivos-de-falha-na-averbacao), não nesta página. ::: ## Status da reserva {#reservation_status} | Enumerador | Descrição | |---|---| | **pending_requester_authorization** | Averbação criada, aguardando autorização do parceiro | | **pending_reservation** | Averbação criada, na fila para tentativa junto à DATAPREV | | **authorized** | Averbação autorizada pelo parceiro, seguirá para a fila de averbação | | **reserved** | Averbação concluída com sucesso — margem reservada na folha do empregador | | **canceled** | Averbação cancelada — não haverá novas tentativas | ## Método de averbação da reserva {#reservation_type} | Enumerador | Descrição | |---|---| | **new_credit** | Averbação de uma nova contratação | | **refinancing** | Averbação de uma operação de refinanciamento | | **portability** | Averbação de uma operação de portabilidade | | **transferred** | Averbação de um revínculo (reaverbação em um novo vínculo empregatício) — ver [Movimentação de Vínculos](/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral) | --- # Manual Consignado Privado - Averbação de Novos Empréstimos: Erros de Averbação URL: /documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros :::info Regras de negócio Esta página detalha os possíveis erros retornados pela DATAPREV em uma tentativa de averbação, os webhooks que os notificam, e a lógica de retentativa automática ("teimosinha") vs. cancelamento. Para o fluxo de sucesso, veja [Autorização e Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico). ::: ## Como uma falha de averbação é notificada Caso haja uma falha na averbação, o parceiro recebe o seguinte webhook, com os motivos da falha estruturados em uma lista — útil quando há mais de uma crítica retornada pela DATAPREV na mesma tentativa: 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 aceita, cancelada manualmente, ou até esgotar as opções de desembolso. A tabela completa de motivos, e se cada um é retentado ou cancela a operação, está em [Motivos de falha na averbação](#motivos-de-falha-na-averbacao). ### Webhook dedicado de falha na averbação {#reservation-failure-webhook} :::info Disparado também no revínculo É disparado tanto para falhas de averbação de um contrato novo quanto para falhas de reaverbação por revínculo (ver [Movimentação de Vínculos — Averbação por Revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo)). ::: webhook_type laas.private_payroll.reservation_failure **Webhook Body** ```json { "webhook_type": "laas.private_payroll.reservation_failure", "key": "", "status": "pending_reservation", "event_datetime": "2025-10-10T19:45:39Z", "data": { "reservation_key": "", "reservation_status": "pending_reservation", "reservation_type": "new_credit", "reasons": [ { "enumerator": "monthly_interest_rate_exceeds_active_proposal", "description": "There is an active proposal in the borrower's CTPS app sent by QI with a rate lower than the registration attempt", "translation": "Há uma proposta ativa no app da CTPS do tomador enviada pela QI com taxa inferior à da tentativa de averbação" } ] } } ``` #### Detalhamento de campos | Campo | Descrição | Valores | |---|---|---| | `reservation_key` | Chave da reserva (entidade `reservation`) | UUID | | `reservation_status` | Status atual da reserva após a falha | `pending_reservation`, `canceled` | | `reservation_type` | Método de averbação que originou a tentativa | `new_credit`, `refinancing`, `portability`, `transferred` | | `reasons` | Lista de motivos da falha retornados pela DATAPREV na tentativa — pode conter mais de um item | Ver [Motivos de falha na averbação](#motivos-de-falha-na-averbacao) | | `reasons[].enumerator` | Código do motivo | Ver [Motivos de falha na averbação](#motivos-de-falha-na-averbacao) | | `reasons[].description` | Descrição do motivo, em inglês | Texto | | `reasons[].translation` | Descrição do motivo, em português | Texto | ## "Teimosinha" vs. cancelamento Cada motivo de falha devolvido pela DATAPREV leva a QI a uma de duas ações: - **Teimosinha (retentativa automática)** — para críticas transitórias, que podem deixar de existir sem nenhuma ação do parceiro ou do trabalhador (ex.: a margem consignável se libera na próxima competência, ou a proposta concorrente do app CTPS expira). A operação permanece em `pending_reservation` e a QI tenta novamente, até aceitar ou esgotar as opções de desembolso. - **Cancelamento da operação** — para críticas terminais, que dependem de uma ação fora do controle da QI (o trabalhador desbloquear o vínculo pelo app CTPS, por exemplo) ou que já esgotam por definição o espaço de novas tentativas (limite de contratos por vínculo). A operação vai para `canceled` e não há novas tentativas. ## Motivos de falha na averbação {#motivos-de-falha-na-averbacao} | 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 | | **competency_change** | Processamento e atualização das informações do Crédito do Trabalhador para virada de competência (crítica transitória) | 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 | :::info Outros motivos A DATAPREV pode retornar outras críticas de validação de campos (valores obrigatórios, formato de contrato, taxa de juros, quantidade de parcelas, etc.), listadas na íntegra nos manuais de comunicação da DATAPREV referenciados por este produto. Elas seguem a mesma lógica geral descrita acima. ::: --- # Manual Consignado Privado - Averbação de Novos Empréstimos: Autorização e Averbação URL: /documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico :::info Regras de negócio Esta página cobre os endpoints e o webhook de sucesso da averbação de uma nova contratação. Para entender **por que** a garantia funciona dessa forma, veja [Regras de Negócio](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/visao_geral). Para o que fazer quando a averbação falha, veja [Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros). ::: ## 1. Autorização {#1-autorizacao} Após a formalização de uma nova contratação de consignado privado, é criada a entidade `reservation`, 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, identificando a operação pela `external_key` (o UUID da operação de crédito, o mesmo que `debt_key`/`credit_operation_key`): :::info Autorizando um revínculo? Este endpoint identifica a operação pela `external_key` da contratação original. Para autorizar um **revínculo** (reaverbação em um novo vínculo empregatício), a autorização é feita por `reservation_key` em um endpoint próprio — ver [Movimentação de Vínculos — Averbação por Revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo#2-atualizacao-da-margem). ::: #### 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", } ``` ## 2. Averbação {#2-averbacao} ### 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" } } ``` :::info Averbação sem sucesso na primeira tentativa? Se a averbação falhar, o parceiro recebe um webhook diferente do de sucesso acima — ver [Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros). ::: --- # Manual Consignado Privado - Averbação de Novos Empréstimos: Regras de Negócio URL: /documentation/manual_consignado_privado/averbacao_novos_emprestimos/visao_geral Este manual documenta a **colateralização da dívida** de um consignado privado no momento da contratação: a reserva de margem na folha de pagamento do empregador (averbação), realizada junto à DATAPREV, e o ciclo de vida dessa tentativa — da criação da garantia até a confirmação de sucesso ou o esgotamento das retentativas em caso de falha. :::info Vínculo terminou depois de averbado? Este manual cobre a averbação de um contrato **novo**. Para o que acontece quando o vínculo empregatício do trabalhador termina e a dívida precisa ser transferida para o novo emprego, veja [Movimentação de Vínculos](/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral). ::: ## Quando usar Use esta referência para desenhar a esteira de **emissão** de um consignado privado, entendendo: - Como e quando a garantia (`reservation`) é efetivamente constituída após a contratação. - O que fazer quando o parceiro precisa autorizar a averbação manualmente. - Como interpretar e reagir aos motivos de falha retornados pela DATAPREV — assunto do foco desta seção, detalhado em [Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros). ## A entidade reservation Após a formalização de uma nova contratação de consignado privado, é criada a entidade `reservation`, responsável por: - Acompanhar as tentativas de averbação do contrato junto à DATAPREV (o registro do desconto na folha de pagamento do empregador). - Gerir a garantia após a averbação ser aceita — é a partir da averbação bem-sucedida que a garantia passa a estar de fato constituída (`collateral_constituted: true`), e não antes. Até esse momento, o que existe é apenas uma **tentativa** registrada, não uma garantia real. ### 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) ## Autorização pendente ou fila de averbação No **fluxo ativo**, o ambiente pode ser configurado para que a averbação seja criada em um status pendente de autorização (`pending_requester_authorization`) ou diretamente na fila de averbação (`pending_reservation`) — 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. O endpoint de autorização (identificando a operação pela `external_key`) e os detalhes de request/response estão em [Autorização e Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico#1-autorizacao). :::info Autorizando um revínculo? A autorização de um **revínculo** (reaverbação em um novo vínculo empregatício) usa um endpoint próprio, identificado pela `reservation_key` — ver [Movimentação de Vínculos — Averbação por Revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo). ::: ## Consulta de averbação e comprovantes Além dos webhooks, é possível consultar a qualquer momento os dados de uma averbação específica pela `external_key` da operação — inclusive os **comprovantes de averbação e desaverbação da dívida**, disponíveis no objeto `protocols` da resposta. Também existe uma consulta paginada, para acompanhar várias reservas de uma vez sem precisar conhecer a `external_key` de cada uma. Ambas estão documentadas em [Consulta de Reservas](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas). ## Averbação: sucesso, falha e "teimosinha" Uma tentativa de averbação pode ter sucesso ou falhar de acordo com a crítica devolvida pela DATAPREV. Esse retorno determina o que a QI Tech faz a seguir: - **Falha transitória** (ex.: margem consignável momentaneamente insuficiente, ou taxa em conflito com uma proposta ativa do trabalhador no app CTPS) — a QI mantém a operação em **retentativa automática** ("teimosinha"), tentando novamente a averbação até que ela seja aceita ou até que as opções de desembolso se esgotem. - **Falha terminal** (ex.: quantidade máxima de contratos por vínculo excedida, ou vínculo bloqueado pelo próprio trabalhador) — a operação é cancelada, pois não há expectativa de que uma nova tentativa tenha resultado diferente sem uma ação externa (o trabalhador desbloquear o vínculo, por exemplo). A lista completa de motivos de falha, o webhook dedicado que os notifica de forma estruturada, e a classificação de cada motivo entre retentável e terminal estão detalhados em **[Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros)** — o foco principal desta seção do manual. ## Conteúdo desta seção 1. **[Autorização e Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico)** — página técnica: endpoint de autorização por `external_key` e webhook de sucesso na averbação. 2. **[Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros)** — foco nos possíveis erros: o webhook dedicado de falha, a lógica de retentativa ("teimosinha") vs. cancelamento, e a tabela de motivos retornados pela DATAPREV. 3. **[Consulta de Reservas](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas)** — consulta por operação (com os comprovantes de averbação/desaverbação em `protocols`) e consulta paginada de reservas por filtros (documento, tipo e status). 4. **[Enumeradores](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/enumeradores)** — status e método de averbação da reserva. ## Glossário | Termo | Significado | |---|---| | **`reservation`** | Entidade que acompanha as tentativas de averbação de um contrato na DATAPREV e a gestão da garantia (margem reservada) após a averbação. | | **Averbação** | Reserva da margem consignável na folha de pagamento do empregador, garantindo o desconto das parcelas. | | **Desaverbação** | Liberação da margem previamente reservada. | | **"Teimosinha"** | Retentativa automática de averbação feita pela QI Tech quando a tentativa falha por um motivo não terminal. | | **`private_payroll`** | `collateral_type` da garantia de folha de pagamento de funcionários de empresas privadas. | --- # 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. 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. O webhook e a tabela completa de motivos de falha estão documentados em [Averbação de Novos Empréstimos — Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros). ## 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 :::info Consulta de averbação A consulta dos dados da averbação e dos comprovantes de protocolo de averbação/desaverbação por `external_key` foi movida para [Averbação de Novos Empréstimos — Consulta de Reservas](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas). ::: ## 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. 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. O webhook e a tabela completa de motivos de falha estão documentados em [Averbação de Novos Empréstimos — Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros). ## 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" } ``` ::: :::info Consulta de averbação A consulta dos dados da averbação e dos comprovantes de protocolo de averbação/desaverbação por `external_key` foi movida para [Averbação de Novos Empréstimos — Consulta de Reservas](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas). ::: ## 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 - 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/vinculos_empregaticios/visao_geral). --- # 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"`. | --- # Manual Consignado Privado - Movimentação de Vínculos: Consulta de Reservas URL: /documentation/manual_consignado_privado/vinculos_empregaticios/consultas :::info Diferença em relação à consulta por external_key Já existe uma consulta de reserva por operação específica, `GET /private_payroll/reservation/external_key/{external_key}`, documentada em [Averbação de Novos Empréstimos — Consulta de Reservas](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas#consulta-por-operacao-external_key). Aquele endpoint retorna o histórico de tentativas de **uma** operação de crédito. O endpoint desta página não recebe nenhuma `external_key` — ele **lista e filtra reservas em lote**, entre todas as operações do solicitante. ::: ## Consulta paginada de reservas **GET** /private_payroll/reservation Testar no Playground A consulta é sempre restrita às reservas do próprio solicitante autenticado — não é necessário (nem possível) informar o `requester_key` como filtro. Para acompanhar revínculos em andamento, filtre por `reservation_type=transferred`. ### Query Params | Campo | Descrição | Tipo | Obrigatório | Valores | |---|---|---|---|---| | `document_number` | CPF do trabalhador, para filtrar as reservas de um único tomador | Texto | Não | — | | `reservation_type` | Filtra pelo método de averbação da reserva — use `transferred` para localizar revínculos | Texto | Não | `new_credit`, `refinancing`, `portability`, `transferred` | | `reservation_status` | Filtra pelo status atual da reserva | Texto | Não | Ver [Enumeradores](/documentation/manual_consignado_privado/vinculos_empregaticios/enumeradores#reservation_status) | | `page_number` | Número da página, começando em 1 | Número | Não (padrão `1`) | Mínimo `1` | | `page_rows` | Quantidade de registros por página | Número | Não (padrão `25`) | Entre `1` e `100` | ### Response sucesso STATUS **200** **Response Body** ```json { "data": [ { "reservation_key": "", "requester_key": "123e4567-e89b-12d3-a456-426614174000", "document_number": "12345678901", "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", "expiration_date": null, "contract_data": { "amount": 5000.00, "installments": 12, "interest_rate": 0.018 }, "reservation_data": { "installment_value": 500.00, "margin_value": 450.00 }, "reservation_type": "transferred", "reservation_status": "reserved", "reservation_documents_submission_status": "sent", "protocols": {}, "next_check_datetime": null, "next_billing_execution_datetime": null, "balance_inquiry_data": {}, "periods": [], "warranty_type": null } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 25 } } ``` Cada item de `data` tem o mesmo formato retornado pelo endpoint de [autorização do revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo#1-autorizacao). Já `pagination.next_page` vem `null` quando a página atual é a última (ou seja, quando a quantidade de itens retornados em `data` é menor que `page_rows`); caso contrário, traz o número da próxima página a ser consultada. ### Response falha Quando nenhuma reserva atende aos filtros informados, o endpoint retorna: STATUS **404** **Response Body** ```json { "title": "Reservation not found", "code": "PRP000035", "description": "The reservation was not found", "translation": "A reserva não foi encontrada" } ``` --- # Manual Consignado Privado - Movimentação de Vínculos: Enumeradores URL: /documentation/manual_consignado_privado/vinculos_empregaticios/enumeradores :::info Erros de averbação de um contrato novo Os motivos de falha retornados pela DATAPREV na averbação de um **contrato novo** (quantidade máxima de contratos, vínculo bloqueado, etc.) estão em [Averbação de Novos Empréstimos — Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros). Esta página cobre apenas os enumeradores específicos do fluxo de **movimentação de vínculos e revínculo**. ::: ## Status da reserva {#reservation_status} | Enumerador | Descrição | |---|---| | **pending_requester_authorization** | Averbação criada, aguardando autorização do parceiro | | **pending_reservation** | Averbação criada, na fila para tentativa junto à DATAPREV | | **authorized** | Averbação autorizada pelo parceiro (por exemplo, um revínculo com margem parcial), seguirá para a fila de averbação | | **reserved** | Averbação concluída com sucesso — margem reservada na folha do empregador | | **transferred** | Averbação original marcada como transferida para um novo vínculo (revínculo) | | **terminated** | Averbação encerrada por término do vínculo empregatício de origem | | **canceled** | Averbação cancelada — não haverá novas tentativas | ## Método de averbação da reserva {#reservation_type} | Enumerador | Descrição | |---|---| | **new_credit** | Averbação de uma nova contratação | | **refinancing** | Averbação de uma operação de refinanciamento | | **portability** | Averbação de uma operação de portabilidade | | **transferred** | Averbação de um revínculo (reaverbação em um novo vínculo empregatício) | ## Motivo de falha na reaverbação {#fail_renewal_reason} Motivos retornados pela DATAPREV em uma tentativa de reaverbação (revínculo) sem sucesso — presentes em `data.reason` (webhook `laas.private_payroll.reservation_status_change`) e em `data.reasons[].enumerator` (webhook [`laas.private_payroll.reservation_failure`](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros#reservation-failure-webhook)). | Enumerador | Descrição | Ação QI | |---|---|---| | **margin_exceeded** | Margem consignável do novo vínculo excedida | Retorna para `pending_requester_authorization` — nova consulta de dados e reavaliação são necessárias | | **employment_relationship_not_ineligible_due_to_previous_termination** | Vínculo não está inelegível por empréstimo encerrado por término de vínculo anterior — não é possível fazer a reaverbação neste momento | Cancelamento da operação | --- # Manual Consignado Privado - Movimentação de Vínculos: Webhooks de Movimentação URL: /documentation/manual_consignado_privado/vinculos_empregaticios/movimentacao_de_vinculos :::info Regras de negócio Esta página cobre os webhooks de movimentação de vínculos. Para entender o ciclo de inelegibilidade que conecta o encerramento de um vínculo à liberação do novo, veja [Regras de Negócio — Por que a garantia precisa seguir o trabalhador](/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral#por-que-a-garantia-precisa-seguir-o-trabalhador). ::: A DATAPREV fornece um serviço de atualização de vínculos empregatícios que é consultado diariamente pela QI Tech. Nesse 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. ## Encerramento por término de vínculo {#encerramento-por-termino-de-vinculo} 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", } } ``` ## Novo vínculo empregatício {#novo-vinculo-empregaticio} 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 } } } ``` :::info Elegibilidade do novo vínculo Enquanto o contrato do vínculo anterior não for excluído ou reaverbado, o novo vínculo é informado pela DATAPREV como **inelegível** (`eligible: false`), mesmo estando ativo — ver o detalhamento do ciclo de motivos 4 e 8 em [Regras de Negócio](/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral#o-ciclo-de-inelegibilidade-motivo-4-motivo-8). ::: É a partir deste webhook que o fluxo de [Averbação por Revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo) é iniciado. --- # Manual Consignado Privado - Movimentação de Vínculos: Averbação por Revínculo URL: /documentation/manual_consignado_privado/vinculos_empregaticios/revinculo :::info Regras de negócio Esta página cobre os endpoints e webhooks da reaverbação por revínculo. Para entender **por que** a autorização é obrigatória em determinados casos, e o que diferencia uma falha retentável de uma falha terminal, veja [Regras de Negócio — Reaverbação automática vs. autorização obrigatória](/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral#reaverbacao-automatica-vs-autorizacao-obrigatoria). ::: ## 1. Autorização {#1-autorizacao} 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 nos 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", } } ``` ## 2. Autorização e atualização da margem {#2-atualizacao-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. Diferente da averbação de um contrato novo — identificada pela `external_key` da operação de crédito, documentada em [Averbação de Novos Empréstimos — Autorização e Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico#1-autorizacao) — a autorização do revínculo é feita pela **`reservation_key`**: o identificador da própria reserva criada para o revínculo, recebido no webhook `laas.private_payroll.renewed_reservation` acima. ### Request **PATCH** /private_payroll/reservation/ RESERVATION-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** :::warning Reserva não encontrada ou não pertencente ao solicitante Uma `reservation_key` inexistente **e** uma `reservation_key` que exista mas pertença a outro solicitante retornam o **mesmo** erro (`PRP000111`) — não há uma variante dedicada de "não encontrado". ::: **Response Body** **Reserva não encontrada ou não pertence ao solicitante** ```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", } ``` :::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. ::: É possível atualizar o valor da nova averbação através de uma [consulta de dados](/documentation/manual_consignado_privado/manual_consultas_trabalhador#consulta-de-dados) no novo vínculo antes de decidir a autorização; 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. Revínculo {#3-revinculo} ### 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ária uma nova [consulta de dados](/documentation/manual_consignado_privado/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á 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" }, } } ``` :::info Webhook adicional com motivo da falha Assim como na averbação de um contrato novo, essas falhas de reaverbação também disparam o webhook dedicado `laas.private_payroll.reservation_failure` — ver [detalhamento em Erros de Averbação](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros#reservation-failure-webhook). Para o revínculo, `data.reservation_type` vem como `"transferred"`. ::: --- # Manual Consignado Privado - Movimentação de Vínculos: Regras de Negócio URL: /documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral Este manual documenta o que acontece com a garantia de um consignado privado quando o **vínculo empregatício do trabalhador termina**: como a DATAPREV comunica o encerramento e a chegada de um novo emprego, e todo o fluxo até a dívida ser **reaverbada (revínculo)** — ou seja, até a margem do contrato original ser transferida para a margem consignável do novo vínculo. :::info Averbação de um contrato novo Este manual **não** cobre a averbação inicial de uma contratação nova — isso está em [Averbação de Novos Empréstimos](/documentation/manual_consignado_privado/averbacao_novos_emprestimos/visao_geral). Aqui, o ponto de partida é sempre um contrato **já averbado** cujo vínculo de origem terminou. ::: ## Quando usar Use esta referência para desenhar a esteira de **retenção de carteira**: o que a QI Tech faz automaticamente quando um trabalhador muda de emprego, e o que exige uma decisão do parceiro — autorizar um revínculo com margem parcial. ## Por que a garantia precisa "seguir" o trabalhador {#por-que-a-garantia-precisa-seguir-o-trabalhador} A margem consignável está associada a um vínculo empregatício específico (um trabalhador em um empregador). Quando esse vínculo termina, a margem reservada para o contrato deixa de existir — mas a dívida do trabalhador com a instituição financeira, não. A DATAPREV fornece um serviço de atualização de vínculos, consultado diariamente pela QI Tech, que informa: - Os contratos que foram **encerrados por término de vínculo**. - Os **novos vínculos empregatícios** de trabalhadores que possuíam contratos ativos. Essas duas informações são o que permite à QI Tech (e ao parceiro) identificar, monitorar e executar a reaverbação — ajustando os termos da dívida à nova margem consignável disponível, ao mesmo tempo em que preserva a sustentabilidade financeira da carteira. ## O ciclo de inelegibilidade (motivo 4 → motivo 8) {#o-ciclo-de-inelegibilidade-motivo-4-motivo-8} O mecanismo que impede a dupla contagem de margem (a antiga e a nova) durante a transição é o de **inelegibilidade do vínculo**, controlado pela própria DATAPREV: 1. O vínculo do trabalhador com o empregador de origem é encerrado. O contrato ativo nesse vínculo passa para a situação **15 — "Encerrado por término de vínculo"**. Esse vínculo (de origem) fica **inelegível com motivo 4** (vínculo com data de desligamento). 2. Quando o novo vínculo é carregado na base da DATAPREV, ele nasce **inelegível com motivo 8** (vínculo com CPF que possui empréstimo encerrado por término de vínculo) — ou seja, mesmo sendo um vínculo novo e ativo, ele não pode receber novas averbações até que a pendência do contrato anterior seja resolvida. 3. Quando o contrato de origem é **excluído** (por liquidação ou outro motivo) ou **renegociado/reaverbado** no novo vínculo, o novo vínculo deixa de ser inelegível e volta a operar normalmente. ## Do novo vínculo até a reaverbação {#do-novo-vinculo-ate-a-reaverbacao} Este é o fluxo completo, do momento em que a DATAPREV identifica o novo emprego até a dívida estar reaverbada (ou definitivamente cancelada): 1. **Encerramento do vínculo de origem** — a DATAPREV informa o término, o contrato original passa para `terminated` e o parceiro recebe o webhook correspondente. Ver [Movimentação de Vínculos](/documentation/manual_consignado_privado/vinculos_empregaticios/movimentacao_de_vinculos#encerramento-por-termino-de-vinculo). 2. **Identificação do novo vínculo** — a DATAPREV informa o novo emprego do trabalhador (ainda inelegível, motivo 8), e o parceiro recebe o webhook de novo vínculo. Ver [Movimentação de Vínculos](/documentation/manual_consignado_privado/vinculos_empregaticios/movimentacao_de_vinculos#novo-vinculo-empregaticio). 3. **Criação da nova reserva (revínculo)** — a QI cria a nova `reservation` já vinculada ao novo emprego, em um de dois estados, dependendo da configuração do ambiente e da margem disponível: pendente de autorização do parceiro, ou direto na fila de averbação. Ver [Averbação por Revínculo — Autorização](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo#1-autorizacao). 4. **Autorização, quando obrigatória** — se a margem consignável do novo vínculo não for suficiente para a parcela cheia do contrato original (margem parcial), a autorização do parceiro é **sempre obrigatória**, mesmo com a revinculação automática habilitada. Ver [Reaverbação automática vs. autorização obrigatória](#reaverbacao-automatica-vs-autorizacao-obrigatoria). 5. **Tentativa de averbação na DATAPREV** — assim como na averbação de um contrato novo, a tentativa pode ter sucesso ou falhar; uma falha por margem excedida é retentada automaticamente, uma falha por vínculo indisponível para reaverbação é terminal. Ver [O que acontece quando a reaverbação falha](#o-que-acontece-quando-a-reaverbacao-falha). 6. **Resultado** — em caso de sucesso, dois webhooks confirmam a transição: o contrato original passa a `transferred` e a nova reserva passa a `reserved`. Ver [Averbação por Revínculo — Sucesso](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo#3-revinculo). ## Reaverbação automática vs. autorização obrigatória {#reaverbacao-automatica-vs-autorizacao-obrigatoria} Semelhante ao fluxo de contratação de um novo empréstimo, a integração pode ser configurada para que todos os revínculos sejam criados pendentes de autorização, ou para que a QI revincule automaticamente. Mesmo com a revinculação automática habilitada, há um caso em que a autorização do parceiro é **sempre obrigatória**: quando o novo vínculo é informado pela DATAPREV com **margem parcial** — ou seja, quando a margem consignável disponível no novo emprego não é suficiente para cobrir a parcela cheia do contrato original. :::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. ::: Como a primeira margem do novo vínculo informada pela DATAPREV pode ser parcial simplesmente por causa do período de contribuição da primeira competência, é possível — e recomendado — reavaliar esse valor por meio de uma [consulta de dados](/documentation/manual_consignado_privado/manual_consultas_trabalhador#consulta-de-dados) no novo vínculo antes de decidir a autorização. ## O que acontece quando a reaverbação falha {#o-que-acontece-quando-a-reaverbacao-falha} Diferente da averbação de crédito novo, uma falha no revínculo por **margem excedida** deixa a `reservation` em situação de teimosinha: ela retorna ao status `pending_requester_authorization`, pois a margem consignável do novo vínculo pode ter flutuado desde a última consulta — cabendo ao parceiro fazer uma nova [consulta de dados](/documentation/manual_consignado_privado/manual_consultas_trabalhador#consulta-de-dados) e reavaliar a reaverbação. Já uma falha porque o vínculo empregatício **não está mais disponível para reaverbação** (por exemplo, o vínculo de origem já não está mais na situação que permite a transferência) é **terminal**: a nova averbação é cancelada e não há mais tentativas automáticas. Os webhooks de autorização, sucesso e falha do revínculo estão documentados em **[Averbação por Revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo)**. ## Conteúdo desta seção 1. **[Movimentação de Vínculos](/documentation/manual_consignado_privado/vinculos_empregaticios/movimentacao_de_vinculos)** — webhooks de encerramento de contrato por término de vínculo e de identificação de novo vínculo empregatício. 2. **[Averbação por Revínculo](/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo)** — autorização, atualização de margem, e webhooks de sucesso e falha da reaverbação no novo vínculo. 3. **[Consulta de Reservas](/documentation/manual_consignado_privado/vinculos_empregaticios/consultas)** — consulta paginada de reservas por filtros (documento, tipo e status), com foco em revínculos. 4. **[Enumeradores](/documentation/manual_consignado_privado/vinculos_empregaticios/enumeradores)** — status de reserva e motivos de falha específicos do revínculo. ## Glossário | Termo | Significado | |---|---| | **`reservation`** | Entidade que acompanha as tentativas de averbação de um contrato na DATAPREV e a gestão da garantia (margem reservada) após a averbação. | | **Revínculo / Reaverbação** | Transferência da averbação de um contrato encerrado por término de vínculo para o novo vínculo empregatício do trabalhador. | | **Motivo 4** | Inelegibilidade da DATAPREV para o vínculo de origem, por já possuir data de desligamento. | | **Motivo 8** | Inelegibilidade da DATAPREV para o novo vínculo, enquanto o contrato do vínculo anterior não é excluído ou reaverbado. | | **Margem parcial** | Situação em que a margem consignável do novo vínculo é insuficiente para cobrir a parcela cheia do contrato original, exigindo autorização do parceiro. | | **"Teimosinha"** | Retentativa automática de averbação feita pela QI Tech quando a tentativa falha por um motivo não terminal. |