# QI Tech — Payroll Loans › Private Payroll Loans Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 33 página(s). Índice: - Manual Consignado Privado - Averbação de Novos Empréstimos: Consulta de Reservas (/en/documentation/manual_consignado_privado/averbacao_novos_emprestimos/consultas) - Manual Consignado Privado - Averbação de Novos Empréstimos: Enumeradores (/en/documentation/manual_consignado_privado/averbacao_novos_emprestimos/enumeradores) - Manual Consignado Privado - Averbação de Novos Empréstimos: Erros de Averbação (/en/documentation/manual_consignado_privado/averbacao_novos_emprestimos/erros) - Manual Consignado Privado - Averbação de Novos Empréstimos: Autorização e Averbação (/en/documentation/manual_consignado_privado/averbacao_novos_emprestimos/tecnico) - Manual Consignado Privado - Averbação de Novos Empréstimos: Regras de Negócio (/en/documentation/manual_consignado_privado/averbacao_novos_emprestimos/visao_geral) - Consulta de escriturações (/en/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_conciliacao) - Consulta de pagamentos (/en/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_pagamentos) - Private Payroll Manual - Credit Operation Tracking (/en/documentation/manual_consignado_privado/manual_assinatura_leilao) - Manual Consignado Privado - Registration and Disbursement (/en/documentation/manual_consignado_privado/manual_averbacao_desembolso) - Private Payroll Manual - Configuration of Auction Proposal Receipt Filters (/en/documentation/manual_consignado_privado/manual_configuracao_filtros) - Private Payroll Manual - Worker Inquiries (/en/documentation/manual_consignado_privado/manual_consultas_trabalhador) - Manual Consignado Privado - Crédito Novo (/en/documentation/manual_consignado_privado/manual_credito_novo) - Private Payroll Loan Manual - Active Origination Flow (/en/documentation/manual_consignado_privado/manual_detalhamento_fluxo_ativo) - Private Payroll Loan Manual - Auction Issuance Flow (/en/documentation/manual_consignado_privado/manual_detalhamento_fluxo_leilao) - Private Payroll Manual - Internal Auction (/en/documentation/manual_consignado_privado/manual_leilao_interno) - Manual Consignado Privado - Refinanciamento (/en/documentation/manual_consignado_privado/manual_refinanciamento) - Manual Consignado Privado - Portabilidade: Consultas Prévias (/en/documentation/manual_consignado_privado/portabilidade/consultas) - Manual Consignado Privado - Portabilidade: Consultas e Operações Pós-Proposta (/en/documentation/manual_consignado_privado/portabilidade/consultas_pos_proposta) - Manual Consignado Privado - Portabilidade: Enumeradores (/en/documentation/manual_consignado_privado/portabilidade/enumeradores) - Manual Consignado Privado - Portabilidade: Formalização (/en/documentation/manual_consignado_privado/portabilidade/formalizacao) - Manual Consignado Privado - Portabilidade: Acompanhamento da Operação (/en/documentation/manual_consignado_privado/portabilidade/maquina_de_status) - Manual Consignado Privado - Portabilidade: Mocks e Sandbox (/en/documentation/manual_consignado_privado/portabilidade/mocks_sandbox) - Manual Consignado Privado - Portabilidade: Digitação da Proposta (/en/documentation/manual_consignado_privado/portabilidade/proposta) - Manual Consignado Privado - Portabilidade: Simulação (/en/documentation/manual_consignado_privado/portabilidade/simulacao) - Manual Consignado Privado - Portabilidade + Refinanciamento (/en/documentation/manual_consignado_privado/portabilidade/visao_geral) - Webhook de pagamento do sinistro (/en/documentation/manual_consignado_privado/referencia/webhook-pagamento-do-sinistro) - Webhook de status do sinistro (/en/documentation/manual_consignado_privado/referencia/webhook-status-do-sinistro) - Manual Consignado Privado - Movimentação de Vínculos: Consulta de Reservas (/en/documentation/manual_consignado_privado/vinculos_empregaticios/consultas) - Manual Consignado Privado - Movimentação de Vínculos: Enumeradores (/en/documentation/manual_consignado_privado/vinculos_empregaticios/enumeradores) - Webhook de migração automática de contrato (/en/documentation/manual_consignado_privado/vinculos_empregaticios/migracao_automatica) - Manual Consignado Privado - Movimentação de Vínculos: Webhooks de Movimentação (/en/documentation/manual_consignado_privado/vinculos_empregaticios/movimentacao_de_vinculos) - Manual Consignado Privado - Movimentação de Vínculos: Averbação por Revínculo (/en/documentation/manual_consignado_privado/vinculos_empregaticios/revinculo) - Manual Consignado Privado - Movimentação de Vínculos: Regras de Negócio (/en/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral) --- # Manual Consignado Privado - Averbação de Novos Empréstimos: Consulta de Reservas URL: /en/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: /en/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: /en/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: /en/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: /en/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. | --- # Consulta de escriturações URL: /en/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_conciliacao A escrituração é o registro, feito pelo empregador no eSocial, do desconto da parcela do consignado na folha de pagamento do trabalhador. Este endpoint lista, de forma paginada, as escriturações que a QI Tech coletou na DATAPREV e associou aos contratos da sua integração. ## Endpoint ENDPOINT /private_payroll_conciliation/registers MÉTODO GET STATUS 200 Testar no Playground ## Autenticação Requer assinatura da requisição. Veja [Troca de chaves](/documentation/primeiros_passos/troca_de_chaves). ## Parâmetros de consulta | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ----------------- | --------- | ----------- | ------------------------------------------------------------------------------------------------- | ------- | | `start_date` | `string` | Sim | Data inicial do período, no formato `AAAA-MM-DD`. | 10 | | `end_date` | `string` | Sim | Data final do período, no formato `AAAA-MM-DD`. Não inclui o próprio dia: veja a nota após a tabela. | 10 | | `external_key` | `string` | Não | Chave da operação de crédito (`credit_operation_key`). Retorna só as escriturações desse contrato. | 36 | | `reservation_key` | `string` | Não | Chave da averbação do contrato. Retorna só as escriturações dessa averbação. | 36 | | `page_number` | `integer` | Não | Página desejada. A primeira página é a `1`. Padrão `1`. | — | | `page_rows` | `integer` | Não | Escriturações por página. Padrão `100`. | — | O período filtra pela data em que a QI Tech coletou a escrituração na DATAPREV, e não por `registered_at`. A escrituração coletada no dia de `start_date` entra no resultado; a coletada no dia de `end_date`, não. Para incluir um dia como o último do período, informe o dia seguinte em `end_date`: para consultar agosto de 2025, use `start_date=2025-08-01` e `end_date=2025-09-01`. A consulta retorna só as escriturações que a QI Tech já associou a um contrato da sua integração. Uma escrituração coletada e ainda não associada a um contrato não aparece no resultado. ## Resposta A resposta tem a lista de escriturações da página (`data`) e os dados de paginação (`pagination`). As escriturações vêm em ordem crescente de inclusão na QI Tech. ```json { "data": [ { "register_key": "3f0b6d1e-2a4c-4f8e-9b7d-5c1a2e3f4b6d", "registered_at": "2025-08-06T03:49:52Z", "contract_number": "1234567890", "amount": 2405.76, "reference_month": "2025-07", "external_reference_month": "2025-07", "document_number": "96969879003", "employer_document_type": "cnpj", "employer_document_number": "12345678", "registration_number": "11841", "credit_operation_key": "9c2e7a4b-1d3f-4e5a-8b6c-7d8e9f0a1b2c", "external_key": "9c2e7a4b-1d3f-4e5a-8b6c-7d8e9f0a1b2c", "register_type": "regular_pay" } ], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 100 } } ``` ### Campos de `data` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | -------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | ------- | | `register_key` | `string` | Sim | Chave da escrituração na QI Tech. | 36 | | `registered_at` | `string` | Sim | Data e hora do evento de escrituração no eSocial, no formato `AAAA-MM-DDTHH:MM:SSZ`. | 20 | | `contract_number` | `string` | Sim | Número do contrato informado pelo empregador na escrituração. | — | | `amount` | `number` | Sim | Valor da parcela escriturada para desconto, em reais. | — | | `reference_month` | `string` | Sim | Competência da folha de pagamento a que a escrituração se refere, no formato `AAAA-MM`. | 7 | | `external_reference_month` | `string` | Sim | Mesmo valor de `reference_month`. | 7 | | `document_number` | `string` | Sim | CPF do trabalhador. | 11 | | `employer_document_type` | `string` | Não | Tipo de inscrição do empregador. Veja [Tipos de documento do empregador](#employer_document_type). | — | | `employer_document_number` | `string` | Sim | Número de inscrição do empregador: raiz do CNPJ (8 dígitos) ou CPF (11 dígitos). | 11 | | `registration_number` | `string` | Sim | Matrícula do trabalhador no empregador. | — | | `credit_operation_key` | `string` | Sim | Chave da operação de crédito associada à escrituração. | 36 | | `external_key` | `string` | Sim | Mesmo valor de `credit_operation_key`. | 36 | | `register_type` | `string` | Sim | Tipo de escrituração. Veja [Tipos de escrituração](#register_type). | — | :::caution Dados informados pelo empregador `contract_number`, `employer_document_number` e `registration_number` são os dados que o empregador informou na escrituração e podem não coincidir com os da operação de crédito. Para relacionar a escrituração ao contrato, use `credit_operation_key`. ::: ### Campos de `pagination` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | --------------- | --------- | ----------- | ----------------------------------------------------------------------------------------------- | ------- | | `current_page` | `integer` | Sim | Página retornada. | — | | `next_page` | `integer` | Não | Próxima página. Vem `null` quando a página retornada tem menos itens que `rows_per_page`. | — | | `rows_per_page` | `integer` | Sim | Escriturações por página, conforme `page_rows`. | — | :::tip Fim da paginação Percorra as páginas até `next_page` vir `null`. Se a última página vier completa, `next_page` aponta para uma página vazia, e a consulta dessa página retorna `404` com o código `PPC010003`: trate esse retorno também como fim da paginação. ::: ### Tipos de escrituração {#register_type} | Valor | Descrição | | --------------- | ---------------------------------------------------------------------------------------------- | | `regular_pay` | Desconto escriturado em evento de remuneração periódico (folha mensal). | | `severance_pay` | Desconto escriturado em evento não periódico de desligamento ou término de vínculo (rescisão). | ### Tipos de documento do empregador {#employer_document_type} | Valor | Descrição | | ------ | -------------------------- | | `cnpj` | Empregador pessoa jurídica | | `cpf` | Empregador pessoa física | ## Erros | Status | Código | Descrição | | ------ | ----------- | ---------------------------------------------------------------------------------------------------------- | | 400 | `QIT000400` | Parâmetros de consulta inválidos: parâmetro obrigatório ausente, data fora do formato `AAAA-MM-DD`, chave que não é UUID ou paginação não numérica. | | 404 | `PPC010003` | Nenhuma escrituração encontrada para os filtros e a página informados. | ```json { "code": "PPC010003", "title": "Register not found", "description": "Register not found", "translation": "Registro nao encontrado" } ``` ## Próximo passo - [Consulta de pagamentos](/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_pagamentos): os pagamentos de guia que a DATAPREV informou para as escriturações. --- # Consulta de pagamentos URL: /en/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_pagamentos Lista, de forma paginada, os pagamentos de desconto em folha que a QI Tech coletou na DATAPREV e associou aos contratos da sua integração. Cada pagamento corresponde ao recolhimento, pelo empregador, de uma ou mais [escriturações](/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_conciliacao). ## Endpoint ENDPOINT /private_payroll_conciliation/payments MÉTODO GET STATUS 200 Testar no Playground ## Autenticação Requer assinatura da requisição. Veja [Troca de chaves](/documentation/primeiros_passos/troca_de_chaves). ## Parâmetros de consulta | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ----------------- | --------- | ----------- | ---------------------------------------------------------------------------------------------- | ------- | | `start_date` | `string` | Sim | Data inicial do período, no formato `AAAA-MM-DD`. | 10 | | `end_date` | `string` | Sim | Data final do período, no formato `AAAA-MM-DD`. Não inclui o próprio dia: veja a nota após a tabela. | 10 | | `external_key` | `string` | Não | Chave da operação de crédito (`credit_operation_key`). Retorna só os pagamentos desse contrato. | 36 | | `reservation_key` | `string` | Não | Chave da averbação do contrato. Retorna só os pagamentos dessa averbação. | 36 | | `page_number` | `integer` | Não | Página desejada. A primeira página é a `1`. Padrão `1`. | — | | `page_rows` | `integer` | Não | Pagamentos por página. Padrão `100`. | — | O período filtra pela data em que a QI Tech coletou o pagamento na DATAPREV. Ele não considera a data de pagamento da guia (`paid_at`) nem a data do repasse (`transferred_at`). O pagamento coletado no dia de `start_date` entra no resultado; o coletado no dia de `end_date`, não. Para incluir um dia como o último do período, informe o dia seguinte em `end_date`: para consultar agosto de 2025, use `start_date=2025-08-01` e `end_date=2025-09-01`. A consulta retorna só os pagamentos que a QI Tech já conciliou com as escriturações e associou a um contrato da sua integração. Um pagamento coletado e ainda não conciliado não aparece no resultado. ## Resposta A resposta tem a lista de pagamentos da página (`data`) e os dados de paginação (`pagination`). Os pagamentos vêm em ordem crescente de inclusão na QI Tech. ```json { "data": [ { "payment_key": "8f14e45f-ceea-467a-9575-0e2b4a1d1c2b", "external_id": "000123456789", "contract_number": "1234567890", "amount": 2405.76, "reference_month": "2025-07", "payment_type": "regular_pay", "transfer_code": "145645096", "document_number": "96969879003", "employer_document_type": "cnpj", "employer_document_number": "12345678", "registration_number": "11841", "monetary_adjustment_amount": 12.30, "late_payment_interest_amount": 8.15, "late_payment_fine_amount": 48.12, "paid_at": "2025-08-07T10:15:00", "transferred_at": "2025-08-10T09:00:00" } ], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 100 } } ``` ### Campos de `data` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ------------------------------ | -------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------- | ------- | | `payment_key` | `string` | Sim | Chave do pagamento na QI Tech. | 36 | | `external_id` | `string` | Sim | Identificador do pagamento na DATAPREV. | — | | `contract_number` | `string` | Sim | Número do contrato informado no pagamento. | — | | `amount` | `number` | Sim | Valor da parcela paga, em reais. Não inclui atualização monetária, juros de mora e multa, que vêm nos três campos abaixo. | — | | `reference_month` | `string` | Sim | Competência da folha de pagamento a que o pagamento se refere, no formato `AAAA-MM`. | 7 | | `payment_type` | `string` | Não | Tipo de pagamento. Veja [Tipos de pagamento](#payment_type). | — | | `transfer_code` | `string` | Não | Código da transferência (TRF) do repasse da Caixa Econômica Federal à instituição financeira. Um repasse pode agrupar vários pagamentos. | — | | `document_number` | `string` | Não | CPF do trabalhador. | 11 | | `employer_document_type` | `string` | Não | Tipo de inscrição do empregador. Veja [Tipos de documento do empregador](#employer_document_type). | — | | `employer_document_number` | `string` | Não | Número de inscrição do empregador: raiz do CNPJ (8 dígitos) ou CPF (11 dígitos). | 11 | | `registration_number` | `string` | Não | Matrícula do trabalhador no empregador. | — | | `monetary_adjustment_amount` | `number` | Não | Valor de atualização monetária, em reais. | — | | `late_payment_interest_amount` | `number` | Não | Valor de juros de mora, em reais. | — | | `late_payment_fine_amount` | `number` | Não | Valor de multa, em reais. | — | | `paid_at` | `string` | Sim | Data e hora do pagamento da guia pelo empregador, no formato `AAAA-MM-DDTHH:MM:SS`. | 19 | | `transferred_at` | `string` | Sim | Data e hora do repasse do valor à instituição financeira, no formato `AAAA-MM-DDTHH:MM:SS`. | 19 | Campo com `Obrigatório` igual a `Não` pode vir `null`. :::caution Dados informados pelo empregador `contract_number`, `employer_document_number` e `registration_number` são os dados informados pelo empregador e podem não coincidir com os da operação de crédito. Para consultar os pagamentos de um contrato, filtre por `external_key`. ::: ### Campos de `pagination` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | --------------- | --------- | ----------- | ----------------------------------------------------------------------------------------- | ------- | | `current_page` | `integer` | Sim | Página retornada. | — | | `next_page` | `integer` | Não | Próxima página. Vem `null` quando a página retornada tem menos itens que `rows_per_page`. | — | | `rows_per_page` | `integer` | Sim | Pagamentos por página, conforme `page_rows`. | — | :::tip Fim da paginação Percorra as páginas até `next_page` vir `null`. Se a última página vier completa, `next_page` aponta para uma página vazia, e a consulta dessa página retorna `404` com o código `PPC020002`: trate esse retorno também como fim da paginação. ::: ### Tipos de pagamento {#payment_type} | Valor | Descrição | | --------------- | ----------------------------------------- | | `regular_pay` | Pagamento de desconto da folha mensal. | | `severance_pay` | Pagamento de desconto de verbas rescisórias. | ### Tipos de documento do empregador {#employer_document_type} | Valor | Descrição | | ------ | -------------------------- | | `cnpj` | Empregador pessoa jurídica | | `cpf` | Empregador pessoa física | ## Erros | Status | Código | Descrição | | ------ | ----------- | ---------------------------------------------------------------------------------------------------------- | | 400 | `QIT000400` | Parâmetros de consulta inválidos: parâmetro obrigatório ausente, data fora do formato `AAAA-MM-DD`, chave que não é UUID ou paginação não numérica. | | 404 | `PPC020002` | Nenhum pagamento encontrado para os filtros e a página informados. | ```json { "code": "PPC020002", "title": "Payment not found", "description": "Payment not found", "translation": "Pagamento nao encontrado" } ``` ## Próximo passo - [Consulta de escriturações](/documentation/manual_consignado_privado/escrituracao_e_pagamento/manual_consultas_conciliacao): as escriturações que deram origem aos pagamentos. --- # Private Payroll Manual - Credit Operation Tracking URL: /en/documentation/manual_consignado_privado/manual_assinatura_leilao ## 1. Formalization After winning the internal auction, the partner must wait to receive the formalization webhook, indicating that the borrower has completed the QI Sign signature flow. ```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" } ``` In cases of signature failure, the partner will receive a webhook in this format. ```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. Proposal Confirmation A second webhook is sent informing that the operation is waiting for the endorsement authorization call. 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" }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "pending_requester_authorization" } ``` At this moment, the partner can decide to proceed with the operation disbursement or cancel the proposal: ### Authorize Endorsement To proceed with the endorsement, the following call must be made: #### Request **PATCH** /private_payroll/reservation/external_key/ EXTERNAL-KEY /authorize #### 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" } ``` ### Cancel Operation To not proceed with the endorsement, it is necessary to cancel the operation. If the operation was originated via auction, this can be done through the permanent cancellation endpoint, in the same way as done in item [6 - De-endorsement](#desaverbacao). If the operation was originated in the active flow, the cancellation must be done through the endpoint that appears in [this manual](./manual_averbacao_desembolso.md). :::info Important The `external_key` field is the UUID of the credit operation, the same as `debt_key` and `credit_operation_key`. ::: ## 3 - Endorsement ### Endorsement Success In case of successful endorsement, the partner will receive the following 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" } } ``` ### Endorsement Failure In case of endorsement failure, a webhook will be sent with the DATAPREV criticism. The possible reasons for endorsement failure can be consulted in the [Endorsement failure reason](#fail_reservation_reason) table. Depending on the endorsement error, QI will keep the proposal in "retry mode" making new endorsement attempts until the operation is manually canceled or disbursement options are exhausted. WEBHOOK TYPE credit_operation.collateral collateral_constituted False **Webhook Body** ```json title="Webhook Body" { "key": "72926c65-35a5-4060-b5ec-af8661d8546a", "data": { "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "monthly_interest_rate_exceeds_active_proposal" } ] }, "last_response_event_datetime": "2025-10-10T19:45:39Z" }, "collateral_type": "private_payroll", "collateral_constituted": false }, "event_time": "2025-10-10 00:07:21", "webhook_type": "credit_operation.collateral" } ``` ## 4 - Disbursement After successful endorsement, the operation will automatically proceed to disbursement. ### Disbursement Success WEBHOOK TYPE laas.credit_operation.status_change STATUS opened **Webhook Body** ``` ``` ### Disbursement Failure 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 DISBURSEMENT FAILURE In case of disbursement failure, it is critical that there is action on the proposal, as the margin is not automatically de-endorsed. It is necessary for the partner to decide whether to contact the borrower to request an update of banking data, making it possible to [resubmit the debt payment](#reapresentacao), or for the partner to make the [permanent cancellation](#desaverbacao) call to de-endorse the payroll margin. ::: ## 5 - Payment Resubmission {#reapresentacao} To retry the debt disbursement, the following call must be made, updating both the disbursement date and banking data (if the retry is to the same bank account, only the disbursement date parameter can be sent). The possible disbursement account payloads are available on the [disbursement payload examples page](/documentation/emissao_de_divida/emissao/exemplo_payloads_desembolso). For this API, the payload name was changed from disbursement_bank_accounts to disbursement_account. To resubmit a debt, a request must be made using the auction_proposal_key. ENDPOINT - `/private_payroll_auction/auction_proposal/{auction_proposal_key}/change_disbursement_date` METHOD - `PATCH` ```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 - De-endorsement {#desaverbacao} To permanently cancel the operation and de-endorse the margin, the following call must be made: #### Request ENDPOINT - `/private_payroll_auction/auction_proposal/{auction_proposal_key}/cancel` METHOD - `PATCH` #### Response STATUS - 202 (Accepted) Response Body: Canceled proposal ```json { "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea", "status": "cancelled" } ``` In case of successful change, status 200 will be returned. STATUS - 200 If there is any error in the format of the payload sent for the change, an invalid schema error will be returned STATUS - 400 ## 7 - Endorsement Query To query endorsement data and endorsement or de-endorsement protocol receipts, the following endpoint can be used: :::warning Endorsement receipts It is possible to query endorsement, de-endorsement and suspension receipts with this method. The possible enumerators for protocol_type are available in the [Protocol types](#protocol_type) table ::: #### Request **GET** /private_payroll/reservation/external_key/ [DEBT-KEY] #### 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", "disbursement_end_date": "2025-02-06", "annual_interest_rate": 0.6163544955, "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 } } ``` ## Attachments ### Disbursement Resubmission Details | Field | Type | Description| |-----------------------|---------|----------| | `disbursement_date` | string | New disbursement date in YYYY-MM-DD format, not required| | `disbursement_account` | dict | disbursement account data, not required| ### Endorsement Failure Reason {#fail_reservation_reason} | Enumerator | Description | QI Action |------------------------------------------ |------------------------------------------------------- |---------- | **monthly_interest_rate_exceeds_active_proposal** | There is an active proposal in the borrower's CTPS app sent by QI with a lower rate than the endorsement attempt | Retry mode | **margin_exceeded** | Payroll margin exceeded | Retry mode | **allowed_number_of_contracts_exceeded** | Maximum number of contracts exceeded | Operation cancellation | **employment_relationship_blocked** | Employment relationship blocked by borrower (can be unblocked via CTPS app) | Operation cancellation ### Protocol Types {#protocol_type} | Enumerator | Description |------------------------------------------ |------------------------------------------------------- | **reservation** | Endorsement | **documents_inclusion** | Document submission (process of sending formalization documents to DATAPREV) | **suspension** | Suspension | **deletion** | Deletion --- # Manual Consignado Privado - Registration and Disbursement URL: /en/documentation/manual_consignado_privado/manual_averbacao_desembolso :::info Navigation - [New Credit](/documentation/manual_consignado_privado/manual_credito_novo) (previous) ::: :::danger Attention! QI Tech webhooks should not be mapped strictly. Additional fields may be included in the webhook payloads returned by our APIs. ::: :::info Webhook Resend You can check and resend webhooks following the detailed instructions in the documentation: [Webhook Resend](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1. Proposal confirmation In the active flow, it's possible to configure the environment so that the operation proceeds to registration and disbursement stages right after the debt formalization is completed by the borrower. Otherwise, a webhook will be sent informing that the operation is awaiting an authorization call to continue the flow (this configuration must be aligned with the operations team). ### Registration pending authorization 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" }, "key": "", "event_datetime": "2025-04-09T20:00:20Z", "status": "pending_requester_authorization" } ``` At this moment the partner can make the decision to proceed with the operation disbursement or cancel the proposal: ### Authorize Registration To proceed with registration, the following call must be made: #### Request **PATCH** /private_payroll/reservation/external_key/ EXTERNAL-KEY /authorize #### 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" } ``` ### Cancel operation To not proceed with registration, it's necessary to cancel the operation. If the operation was originated in the active flow, this can be done through the permanent cancellation endpoint, in the same way as done in item [5 - Deregistration](#desaverbação). If the operation was originated via auction, the cancellation should be done through the proposal cancellation endpoint, as per the Auction documentation. :::info Important The `external_key` field is the credit operation UUID, the same as `debt_key` and `credit_operation_key`. ::: ## 2 - Registration ### Successful registration In case of successful registration the partner will receive the following 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" } } ``` ### Registration failure If there's a registration failure, a webhook will be sent with the DATAPREV critique. The possible reasons for registration failure can be consulted in the table [Registration failure reason](#fail_reservation_reason). Depending on the registration error, QI will keep the proposal in "retry" mode making new registration attempts until the operation is manually cancelled or runs out of disbursement options. WEBHOOK TYPE credit_operation.collateral collateral_constituted False **Webhook Body** ```json title="Webhook Body" { "key": "72926c65-35a5-4060-b5ec-af8661d8546a", "data": { "collateral_data": { "status": "pending_reservation", "last_response": { "errors": [ { "enumerator": "monthly_interest_rate_exceeds_active_proposal" } ] }, "last_response_event_datetime": "2025-10-10T19:45:39Z" }, "collateral_type": "private_payroll", "collateral_constituted": false }, "event_time": "2025-10-10 00:07:21", "webhook_type": "credit_operation.collateral" } ``` ## 3 - Disbursement After successful registration, the operation will automatically proceed to disbursement. ### Successful disbursement 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" } ``` ### Disbursement failure #### TED In case of TED disbursement failure 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 In case of PIX disbursement failure 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 DISBURSEMENT FAILURE In case of disbursement failure, it's critical that action is taken on the proposal, as the margin is not deregistered automatically. It's necessary for the partner to make the decision to contact the borrower to request an update of banking details so that it's possible to [resubmit the debt payment](#reapresentacao), or for the partner to make the [permanent cancellation](#desaverbacao) call to deregister the payroll deduction margin. ::: ## 4 - Payment resubmission{#reapresentacao} To retry debt disbursement, the following call should be made updating both the disbursement date and banking details (if the retry is to the same bank account, only the disbursement date parameter can be sent). The possible disbursement account payloads are available on the [disbursement payload examples](/documentation/emissao_de_divida/emissao/exemplo_payloads_desembolso) page. #### Request **POST** /debt/ DEBT-KEY /change_disbursement_date ### 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 - Deregistration {#desaverbacao} Contract deregistration is performed through the permanent cancellation route. This route sets a final status on the contract, which is not subject to retry and triggers the deregistration of the registered margin. To perform permanent cancellation, the following endpoint should be used: ### Request **POST** /debt/ DEBT-KEY /cancel_permanently ### 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": {} } ``` ## 6 - Registration query To check registration data and registration or deregistration protocol receipts, you can use the endpoint: :::warning Registration receipts It's possible to check registration, deregistration and suspension receipts with this method. The possible enumerators for protocol_type are available in the table [Protocol types](#protocol_type) ::: **GET** /private_payroll/reservation/external_key/ [DEBT-KEY] ### 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 } } ``` ## Attachments --- ### Registration failure reason {#fail_reservation_reason} | Enumerator | Description | QI Action |------------------------------------------ |------------------------------------------------------- |---------- | **monthly_interest_rate_exceeds_active_proposal** | There's an active proposal in the borrower's CTPS app sent by QI with a rate lower than the registration attempt | Retry | **margin_exceeded** | Payroll deduction margin exceeded | Retry | **allowed_number_of_contracts_exceeded** | Maximum number of contracts exceeded | Operation cancellation | **employment_relationship_blocked** | Employment relationship blocked by borrower (can be unblocked via CTPS app) | Operation cancellation ### Protocol types {#protocol_type} | Enumerator | Description |------------------------------------------ |------------------------------------------------------- | **reservation** | Registration | **documents_inclusion** | Document submission (process of sending formalization documents to DATAPREV) | **suspension** | Suspension | **deletion** | Deletion --- # Private Payroll Manual - Configuration of Auction Proposal Receipt Filters URL: /en/documentation/manual_consignado_privado/manual_configuracao_filtros ## Introduction The auction operation issuance flow begins when a borrower requests a loan in the digital CTPS app, QI Tech consults all requests made periodically and, for each request, opens an internal loan proposal auction notifying partners via webhook. This manual contains the necessary endpoints to configure request filters that enable controlling the operation's target audience. ## Modifying filtering rules ENDPOINT - `/private_payroll_auction/requester_configuration/custom_data` METHOD - `PATCH` In this request there are two types of fields that can be modified; the client status and the client filters. Regarding the client status, it can be changed between [active and inactive](#status_do_cliente), indicating whether the client wants to receive new auction requests or not. ```json { "status": "active" } ``` The [custom_data](#custom_data_params) field contains the actual filters. All filtering fields must be sent as in the example below: ```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" } } } ``` :::warning Each field must obligatorily have the min and max keys, except for received_daily_proposals, days_since_employment and alert_preferences. *NOTE: All custom data fields must be sent, even if not all values need to be changed. Additionally, sending all min/max keys is mandatory, with 'null' being passed if this filter is not needed*. ::: ### Example [Body](#custom_data_payload) ```json { "status": "inactive", "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}, } } ``` ### Response STATUS - 201 (Accepted) Response Body: Updated Configuration ```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}, } } ``` ## Adding filtering CNPJs For clients who wish to receive requests only from employees of specific CNPJs, there is an option to add these CNPJs in bulk: ENDPOINT - `/private_payroll_auction/requester_configuration/related_employer` METHOD - `POST` :::caution Warning! DATAPREV only operates with the root of CNPJs, therefore for filtering based on the employer's document, **only the first 8 digits of the CNPJ** should be sent. ::: ### [Body](#employer_payload) ```json { "employer_document_numbers": [ "01234567", "12345678" ] } ``` **The [list](#employer_payload) can contain a maximum of 100 CNPJs.** ### Response STATUS - 201 Response Body: Added CNPJs ```json { "employer_document_numbers": [ "01234567", "12345678" ] } ``` :::info Note Only CNPJs that were effectively added will be returned. In cases where a CNPJ has already been registered, it will not be returned in the response list. If no CNPJ is added, an empty list will be returned. ::: ## Removing filtering CNPJs ENDPOINT - `/private_payroll_auction/requester_configuration/remove_related_employers` METHOD - `POST` ### [Body](#employer_payload) ```json { "employer_document_numbers": [ "01234567", "12345678" ] } ``` **CNPJs must be sent with only the first 8 digits and the list can contain a maximum of 100 CNPJs.** ### Response STATUS - 200 Response Body: Removed CNPJs ```json { "employer_document_numbers": ["01234567", "12345678"] } ``` ## Searching filtering CNPJs To consult CNPJs registered as filters for a requester, use the endpoint below with pagination support. ### Endpoint ENDPOINT - `/private_payroll_auction/requester_configuration/related_employers` METHOD - `GET` ### Query Params | Field | Type | Description | Default | |---------------|------|--------------------------------|---------| | `page_number` | int | Current page number | 1 | | `page_rows` | int | Number of records per page | 100 | ### Example Response - 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 } } ``` ## Attachments ### Filtering Rules Modification Payload Details {#custom_data_payload} | Field | Type | Description | Required | |---------------|-------- |-----------------------------------|------------ | | `status` | string | new client status | No | | `custom_data` | dict | New filters for the client | No | ### Client Status {#status_do_cliente} | Status | Description | |---------- | ------------------------------------------------------------------------- | | active | Client wants to receive new auction proposal requests | | inactive | Client does **NOT** want to receive new proposal requests | ### Custom Data Parameters {#custom_data_params} | Field | Type | Description | Required | |---------------------------- |-------|----------------------------------------------------------------------- |----------| | `disbursed_issue_amount` | dict | Issued contract amount (minimum and maximum) | Yes | | `number_of_installments` | dict | Number of installments (minimum and maximum) | Yes | | `consigned_credit_balance` | dict | Consigned credit balance (minimum and maximum) | Yes | | `days_since_employment` | dict | Days since employment start (minimum) | Yes | | `age` | dict | Proposer's age (minimum and maximum) | Yes | | `received_daily_proposals` | dict | Number of proposals received per day (maximum) | Yes | | `alert_preferences` | dict | Filter for loan requests with some alert, for details see [alert_preferences Parameters](#alert_preferences)| Yes | ### alert_preferences Parameters {#alert_preferences} | Field | Type | Description | Required | Enumerators | |---------------------------- |------- |----------------------------------------------------------------------- |--------------|------------- | | `default` | string | Default behavior, if specific behaviors are not configured | Yes | ignore to not receive, acknowledge to receive | | `termination` | string | Filter for leads with termination alert | No | ignore to not receive, acknowledge to receive | | `leave` | string | Filter for leads with leave alert | No | ignore to not receive, acknowledge to receive | ### CNPJ Filtering Addition and Removal Payload Details {#employer_payload} | Field | Type | Description | Required | |---------------|--------|------------------------------------------------------|----------| | `employer_document_number` | array of strings | List of CNPJ roots (with 8 digits each). Must contain between 1 and 100 items | Yes | --- # Private Payroll Manual - Worker Inquiries URL: /en/documentation/manual_consignado_privado/manual_consultas_trabalhador :::info Navigation - [Issuance Flow](/documentation/manual_consignado_privado/manual_detalhamento_fluxo_ativo) (previous) - [Issuance and Formalization](/documentation/manual_consignado_privado/manual_credito_novo) (next) ::: At the beginning of the active flow for issuing a private payroll debt, it is necessary to perform two main inquiries related to the worker: 1. Employment relationships inquiry: performed by providing only the worker's CPF. This operation returns the list of the worker's active relationships, along with the eligibility of each one for credit operations. 2. Worker data inquiry: performed based on a specific relationship, providing the employer's document number and registration number obtained from the employment relationships inquiry. This operation returns detailed additional information about the selected relationship, including personal data, consignable margin, relationship history, and any alerts. :::caution Attention To perform any of these inquiries, it is mandatory to send an [Authorization term](#authorization_term). This term must be created from the collection of evidence that the borrower provided express consent (opt-in) authorizing the execution of the inquiries. The evidence — such as timestamp, IP address, and session identifier — must be included in the request to ensure traceability and regulatory compliance of the process. ::: These inquiries, along with the [Authorization term](#authorization_term), are fundamental steps to validate the worker's eligibility and obtain the necessary data before formalizing the credit operation. :::danger Attention! QI Tech webhooks should not be strictly mapped. Additional fields may be included in the webhook payloads returned by our APIs. ::: :::info Webhook Resending You can consult and resend webhooks by following the detailed instructions in the documentation: [Webhook Resending](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## 1 - Worker employment relationships inquiry: The employment relationships inquiry is an asynchronous operation. When sending the request, QI Tech will process the inquiry in the background and return the result through a webhook when completed. The webhook will be sent to the URL configured in your environment. **POST** /private_payroll/employment_relationships_inquiry ### Request **Case 1:** The worker is the signer of the [Authorization term](#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" } } } } ``` **Case 2:** The legal representative is the signer of the [Authorization term](#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 Attention In cases where there is a legal representative, it is necessary to fill the **"legal_representative_document_number"** field with the legal representative's CPF, and the **"signer"** object data must be filled with the same person's data. ::: ### Response STATUS **202** Accepted **Response Body** ```json { "employment_relationships_inquiry_key": "", "employment_relationships_inquiry_status": "pending_inquiry" } ``` :::info The possible values for the **employment_relationships_inquiry_status** enumerator are listed in the section [Employment relationships inquiry status](#status-das-consultas). ::: ### Webhooks WEBHOOK TYPE laas.private_payroll.employment_relationships_inquiry_status_change Employment relationships inquiry result: 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 Warning To simulate a failure in sandbox environment, perform an inquiry with a CPF starting with digit 2. ::: --- ## 2 - Worker data inquiry: {#consulta-de-dados} The worker data inquiry is an asynchronous operation. When sending the request, QI Tech will process the inquiry in the background and return the result through a webhook when completed. The webhook will be sent to the URL configured in your environment. There are two possible scenarios for performing the inquiry: 1. Using an [Authorization term](#authorization_term) previously sent in the employment relationships inquiry 2. Sending a new [Authorization term](#authorization_term) along with the inquiry In both cases, it is necessary to provide the worker's registration number obtained from the employment relationships inquiry. **POST** /private_payroll/balance_inquiry ### Request **Case 1:** Worker data inquiry with previously sent [Authorization term](#authorization_term). **Request Body** ```json { "document_number": "", "registration_number": "", "employer_document_number": "" } ``` **Case 2:** Worker data inquiry with [Authorization term](#authorization_term) sending. **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 Attention In cases where there is a legal representative, it is necessary to fill the **"legal_representative_document_number"** field with the legal representative's CPF, and the **"signer"** object data must be filled with the same person's data. ::: ### Response STATUS **202** (Accepted) **Response Body** ```json { "balance_inquiry_key": "", "balance_inquiry_status": "pending_inquiry" } ``` :::info The possible values for the **balance_inquiry_status** enumerator are listed in the section [Worker data inquiry status](#status-das-consultas). ::: ### Webhooks WEBHOOK TYPE laas.private_payroll.balance_inquiry_status_change Worker data inquiry result: 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" } ] } } ``` 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" } } } ``` Result in case of blocked employment relationship: STATUS completed **Webhook Body** ```json { "document_number": "99999999999", "registration_number": "abc", "employer_document_number": "12345678", "block_type": "blocked_by_the_worker", "blocked_at": "2025-12-11T10:00:00Z", "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 Warning To simulate a failure in sandbox environment, perform an inquiry with a CPF starting with digit 2. ::: ## Attachments --- ### Authorization term object details {#authorization_term} | Field | Requirement | Description | |-------------------------|-----------------|------------------------------------| |Name |Required |Borrower name | |Email |Optional |Borrower email | |Phone |Optional |Borrower phone | |Document_number |Required |Borrower CPF | |Authentication_type |Required |Mandatory "opt-in" | |Timestamp |Required |Borrower consent timestamp, mandatory in format: 2025-08-04T23:45:30Z| |Ip_address |Required |User session IP, either IPv4 (e.g.: 192.168.0.1) or IPv6 (e.g.: 2001:0db8:85a3:0000:0000:8a2e:0370:7334)| |Fingerprint |Required |Object where additional evidence can be sent that contributes to the robustness of consent and assists in traceability, although required, can be sent as a null object| |Session_id |Required |Internal identifier key of the user session, minimum length 10 and maximum 50| **Examples of fingerprint object fields** ```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" } ``` ### Worker data inquiry webhook details | Field | Description | |------------------------- |------------------------------------| |document_number |Borrower document | |registration_number |Employment relationship registration number | |employer_document_number |Employer document number (for CNPJ only the first 8 digits)| |name |Borrower name | |gender |Borrower gender | |birth_date |Borrower birth date| |worker_category_code |[Worker category](https://www.gov.br/esocial/pt-br/documentacao-tecnica/manuais/leiautes-esocial-v-1-1-beta/tabelas.html#01) in compliance with the eSocial website| |eligible |Relationship eligibility for payroll credit issuance| |available_margin_amount |Consignable margin| |base_margin_amount |Salary| |total_due_amount |Borrower outstanding balance| |admission_date |Admission date| |termination_date |Termination date| |termination_reason_code |[Termination reason](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#19) in compliance with the eSocial website| |political_exposition |Borrower political exposure level, check possible enumerators in the [Political exposure](#exposição-política) table| |employer_name |Employer name| |mother_name |Borrower mother's name| |nationality.description |Borrower nationality| |nationality.code |Borrower nationality code according to the numerical standard of part 1 of ISO 3166 norm| |occupation.description |Borrower occupation according to the Brazilian Classification of Occupations (CBO)| |occupation.code |Code according to CBO 2002| |economic_activity.description |Employer economic activity according to the National Classification of Economic Activities (CNAE)| |economic_activity.code |Code according to CNAE Subclasses 2.3| |ineligibility_reason |Relationship ineligibility reason| |employer_activity_start_date |Employer activity start date| |legacy_loans |List of active loans reported by FIs, for field details check the [Legacy loans object details](#legacy_loans) table| |alerts |List with history of leaves and termination warnings of the relationship, for field details check the [Alerts object details](#alerts) table| |suspended_loans_count |Number of suspended loans| |block_type |Employment relationship blocking type, check possible enumerators in the [Salary blocking](#block) table| |blocked_at |Employment relationship blocking date| ### Political exposure {#exposicao-politica} ENUMERATOR political_exposition | Enumerator | Description | | ------------- | ------------------------------------------------------------------------- | | not_exposed | Person not politically exposed | | level_1 | Politically exposed person level 1 | | level_2 | Politically exposed person level 2 | | not_informed | No information about political exposure | ### Alerts object details {#alerts} | Field | Description | |------------------------- |------------------------------------| |alert_type |Alert type, check possible enumerators in the [Alert types](#alert_type) table| |reference_date |Event reference date| |event_id |Event identifier| |leave_reason_code |[Leave reason](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#18) in compliance with the eSocial website| |leave_start_date |Leave start date| |leave_end_date |Leave end date| |termination_reason_code |[Termination reason](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#19) in compliance with the eSocial website| |termination_date |Relationship termination date| |notice_period_start_date |Notice period start date| |notice_period_end_date |Notice period end date| ### Alert types {#alert_type} ENUMERATOR alert_type | Enumerator | Description | |------------------------- |-----------------------------------| |leave |Leave | |termination |Termination notice | ### Legacy loans object details {#legacy_loans} | Field | Description | |------------------------- |------------------------------------| |loan_amount |Disbursed amount| |monthly_cet |Monthly CET| |monthly_rate |Monthly rate| |contract_type |Contract type, check possible enumerators in the [Legacy contract types](#contract_type) table| |contract_number |Contract number| |contract_end_date |Contract end date| |paid_installments |Number of paid installments| |total_installments |Total number of installments| |installment_amount |Installment amount| |contract_start_date |Contract start date| |outstanding_balance |Outstanding balance| |last_update_timestamp |Last update date| |financial_institution_code |Code of the FI that reported the loan| ### Legacy contract types{#contract_type} ENUMERATOR contract_type | Enumerator | Description | |------------------------- |-----------------------------------| |unsecured_non_consigned_loan |Unsecured non-payroll loan| |loan_with_payroll_deductions |Loan with payroll deductions| ### Employment relationships inquiry and worker data inquiry status {#status-das-consultas} ENUMERATOR employment_relationships_inquiry_status ENUMERATOR balance_inquiry_status | Status | Description | | --------------------- | ----------------------------------------------------------------------------- | | pending_authorization | Authorization data was sent and is pending processing. | | pending_inquiry | The inquiry is authorized and pending processing. | | completed | The inquiry was successfully completed. | | failed | The inquiry failed. | ### Employment relationship blocking {#block} ENUMERATOR block_type | Enumerator | Description | | ------------- | ------------------------------------------------------------------------- | | no_block | Employment relationship not blocked | | blocked_by_the_worker | Employment relationship blocked by the worker | --- # Manual Consignado Privado - Crédito Novo URL: /en/documentation/manual_consignado_privado/manual_credito_novo :::info Navegação - [Consultas do Trabalhador](/documentation/manual_consignado_privado/manual_consultas_trabalhador) (anterior) - [Averbação e Desembolso](/documentation/manual_consignado_privado/manual_averbacao_desembolso) (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 **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" } ] } ``` :::info Na request acima existem 2 simulações sendo realizadas. A primeira está fixando o valor de parcela ao cliente (varia o valor desembolsado) e a segunda está fixando o valor desembolsado (varia o valor de parcela). ::: ### Response STATUS **200** (OK) **Response Body** ```json { "type": "debt", "key": "", "status": "finished", "event_datetime": "2024-11-05 16:50:00", "data": { "interest_type": "pre_price_days", "credit_operation_type": "ccb", "interest_grace_period": 0, "interest_payment_month_period": 1, "principal_grace_period": 0, "principal_amortization_month_period": 1, "operation_type": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2024-11-05", "number_of_installments": 4, "requester_key": "e5eb6a0a-e003-4cbd-b702-5a25bf71af0a", "final_disbursement_amount": 0.0, "disbursement_options": [ { "iof_amount": 3.93, "total_pre_fixed_amount": 17.8715883143, "cet": 0.0257, "annual_cet": 0.355163, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.29 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.29, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-05", "first_due_date": "2024-12-21", "installments": [ { "calendar_days": 34, "workdays": 23.0, "business_due_date": "2024-12-21", "due_date": "2024-12-21", "due_principal": 382.13, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 7.6967422515, "tax_amount": 0.257341482602818, "total_amount": 100, "principal_amortization_amount": 92.3032577485, "installment_number": 1 }, { "calendar_days": 29, "workdays": 19.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 289.8267422515, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 4.9718040699, "tax_amount": 0.4909156601748966, "total_amount": 100, "principal_amortization_amount": 95.0281959301, "installment_number": 2 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 194.7985463214, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.5742034136, "tax_amount": 0.7432500400879712, "total_amount": 100, "principal_amortization_amount": 96.4257965864, "installment_number": 3 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 98.372749735, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.6288385793, "tax_amount": 0.9841050988526828, "total_amount": 100, "principal_amortization_amount": 98.3711614207, "installment_number": 4 } ], "issue_amount": 382.13, "disbursed_issue_amount": 374.91, "assignment_amount": 382.13, "final_disbursement_amount": 374.91, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.77, "total_pre_fixed_amount": 24.2597288075, "cet": 0.0243, "annual_cet": 0.334037, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.25 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.25, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-06", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 62, "workdays": 41.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.74, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.9149280115, "tax_amount": 0.437656505989534, "total_amount": 100, "principal_amortization_amount": 86.0850719885, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6549280115, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.722070128765373, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.969623951, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9601685182659746, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1979530917, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.2239426674782687, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 375.74, "disbursed_issue_amount": 367.72, "assignment_amount": 375.74, "final_disbursement_amount": 367.72, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.74, "total_pre_fixed_amount": 24.0392857898, "cet": 0.0243, "annual_cet": 0.334673, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-07", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 61, "workdays": 40.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 375.96, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.6944849939, "tax_amount": 0.4317001860605122, "total_amount": 100, "principal_amortization_amount": 86.3055150061, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6544849939, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.714305933832412, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.9691809334, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.952233241255512, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-07", "due_date": "2025-04-07", "due_principal": 98.1975100741, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757157, "tax_amount": 1.2158904130882027, "total_amount": 100, "principal_amortization_amount": 98.1982242843, "installment_number": 4 } ], "issue_amount": 375.96, "disbursed_issue_amount": 367.96, "assignment_amount": 375.96, "final_disbursement_amount": 367.96, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } }, { "iof_amount": 4.71, "total_pre_fixed_amount": 23.8187134405, "cet": 0.0244, "annual_cet": 0.335196, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.6, "fee_amount": 2.26 }, { "fee_type": "ted_fee", "amount_type": "absolute", "amount": 1.0, "fee_amount": 1.0 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 2.26, "external_contract_fee_amount": 0.0, "net_external_contract_fee_amount": 0.0, "disbursement_date": "2024-11-08", "first_due_date": "2025-01-21", "installments": [ { "calendar_days": 60, "workdays": 39.0, "business_due_date": "2025-01-21", "due_date": "2025-01-21", "due_principal": 376.18, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 13.4739126445, "tax_amount": 0.42570834978906, "total_amount": 100, "principal_amortization_amount": 86.5260873555, "installment_number": 1 }, { "calendar_days": 31, "workdays": 23.0, "business_due_date": "2025-02-21", "due_date": "2025-02-21", "due_principal": 289.6539126445, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 5.3146959395, "tax_amount": 0.706541738899451, "total_amount": 100, "principal_amortization_amount": 94.6853040605, "installment_number": 2 }, { "calendar_days": 28, "workdays": 18.0, "business_due_date": "2025-03-21", "due_date": "2025-03-21", "due_principal": 194.968608584, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 3.2283291407, "tax_amount": 0.9442979642450494, "total_amount": 100, "principal_amortization_amount": 96.7716708593, "installment_number": 3 }, { "calendar_days": 31, "workdays": 21.0, "business_due_date": "2025-04-21", "due_date": "2025-04-21", "due_principal": 98.1969377247, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 1.8017757158, "tax_amount": 1.20783815869566, "total_amount": 100, "principal_amortization_amount": 98.1982242842, "installment_number": 4 } ], "issue_amount": 376.18, "disbursed_issue_amount": 368.21, "assignment_amount": 376.18, "final_disbursement_amount": 368.21, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } } ] } } ``` --- ## 2 - Emissão da operação: O campo "registration_number", localizado dentro do objeto "collateral_data", refere-se ao número de matrícula de um vínculo empregatício. O mesmo é retornado na consulta de vínculos empregatícios. CRÉDITO NOVO ### Request **POST** /debt **Sem representante legal** ```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 } ] } ``` ### 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** ::: ## 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 | ## 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. | --- # Private Payroll Loan Manual - Active Origination Flow URL: /en/documentation/manual_consignado_privado/manual_detalhamento_fluxo_ativo :::info Next step - [Worker Queries](/documentation/manual_consignado_privado/manual_consultas_trabalhador) ::: ## Flow stages ### 1. Worker queries Perform [worker queries](./manual_consultas_trabalhador.md) to verify the eligibility of employment relationships for payroll loan origination and available payroll deduction margin, along with other information. ### 2. Origination and operation formalization Execute simulation and credit operation creation calls and guide the borrower through the CCB signing flow. ### 3. Registration Monitor DATAPREV's response regarding registration attempts. ### 4. Disbursement Monitor the operation disbursement and handle any disbursement failures. --- # Private Payroll Loan Manual - Auction Issuance Flow URL: /en/documentation/manual_consignado_privado/manual_detalhamento_fluxo_leilao ## Flow Steps ### 1. Loan request filter configuration Configure loan request reception filters in order to select the target audience you wish to target. ### 2. Receiving loan request webhooks and submitting proposals Receive filtered loan request webhooks, simulate desired credit conditions and submit the proposal to the internal auction. ### 3. Monitoring internal auction proposal status and credit operation signature Wait for internal auction update webhooks and operation signature. ### 4. Payroll deduction authorization and disbursement monitoring Authorize the payroll deduction and handle possible payroll deduction and disbursement failures. --- # Private Payroll Manual - Internal Auction URL: /en/documentation/manual_consignado_privado/manual_leilao_interno ## 1. Auction Start After configuring the loan request filters, the partner will start receiving webhooks notifying these requests. ```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" } ] }, } } ``` Each loan request goes through two stages: the internal auction and the auction in the CTPS app. The internal auction starts as soon as the webhook is received and ends at the timestamp indicated in the *inclusion_limit_datetime* field. During this period, proposals from all partners are received and ranked based on the rate. Once the internal auction ends, the proposal with the best conditions is sent to the borrower's CTPS where proposals from all FIs are presented. If no proposal is sent by the end of the internal auction, the first proposal sent after the *inclusion_limit_datetime* will automatically win and be sent to the CTPS. ## 2. Credit Proposal ### Request ENDPOINT - `/private_payroll_auction/issuer_proposal_request/{issuer_proposal_request_key}/auction_proposal` METHOD - `POST` Request Body: Including an AuctionProposal in the auction **Disbursed Amount & Interest Rate** ```json { "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea", "disbursed_issue_amount": 15000, "monthly_interest_rate": 0.02, "number_of_installments": 48, "purchaser_document_number": "01272247000120", "days_to_expiration": 10, "rebates": [ { "fee_type": "spread", "amount_type": "percentage", "amount": 4.17 } ] } ``` **Installment Value & Interest Rate** ```json { "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea", "installment_face_value": 1000, "monthly_interest_rate": 0.02, "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: Proposal created ```json { "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": 15.46, "annual_cet": 0.0603, "monthly_cet": 0.0049, "issue_amount": 1015.46, "annual_interest_rate": 0.0180272568, "monthly_interest_rate": 0.00149, "disbursed_issue_amount": 1000.0, "installment_face_value": 102.25, "number_of_installments" : 48 }, "monthly_interest_rate": null, "disbursed_issue_amount": 15000, "installment_face_value": 102.25, "number_of_installments": 48 }, } ``` STATUS - 400 (Rejected) Response Body: Bad Request ```json { "title": "Bad Request", "description": "Calculated installment face value is greater than consigned credit balance", "translation": "Schema Invalido", "extra_fields": {}, "code": "QIT000001" } ``` ## 3. Auction Closure When the internal auction ends, a webhook is sent updating the partner on whether they won or lost the auction. In case of victory, the credit operation is created and the QI Sign formalization link is sent to the borrower's CTPS app. From this moment on, the operation monitoring should be performed through the *credit_operation_key*. WEBHOOK_TYPE laas.private_payroll_auction.end_of_auction ```json { "key": "250cfea5-99dc-4c80-be3e-2231350cf9a2", // esta chave é igual à auction_proposal_key "data": { "auction_proposal_key": "250cfea5-99dc-4c80-be3e-2231350cf9a2", "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" }, "status": "won", "event_datetime": "2025-03-20T14:48:43Z", "webhook_type": "laas.private_payroll_auction.end_of_auction" } ``` The credit operation key will be sent with a null value for losing proposals. :::info Attention The signature link will not be sent in the production environment, only in sandbox so that it is possible to simulate the borrower's signature. ::: ## Attachments ### IssuerProposalRequest Object Definition | Name | Type | Description | | --------------- | ------ | ---------------------------------------------------------------------------------- | | issuer_proposal_request_key | string | Unique identifier of the **Proposal Request** | | issuer_proposal_request_data| object | Object that describes the **Proposal Request** data | | status | string | Status of the **Proposal Request** (`ongoing`, `finished`, `expired`)| ### IssuerProposalRequestData Object Definition | Name | Type | Description | | --------------- | ------ | ---------------------------------------------------------------------------------- | | name |string | Full name of the Borrower | | document_number |string | CPF of the Borrower | | birth_date |string | Date of birth of the Borrower in `YYYY-MM-DD` format | | disbursed_amount |float | Disbursement amount requested by the borrower | | number_of_installments |integer| Number of installments requested by the borrower | | consigned_credit_balance |float | Available consigned credit balance of the borrower | | admission_date |string | Date of admission of the worker in the current position in `YYYY-MM-DD` format | | issuer_registration_code |string | eSocial registration number of the employee| | employer_document_number |string | CNPJ of the employer | | eligible |boolean| True if eligible, False if not eligible| | employer_document_type |string | CNPJ or CPF| |alerts |List with history of leaves and employment termination notices, for field details check the table [alerts object details](#alerts)| ### alerts object details {#alerts} | Field | Description | |------------------------- |------------------------------------| |alert_type |Alert type, check possible enumerators in the table [Alert types](#alert_type)| |reference_date |Event reference date| |event_id |Event identifier| |leave_reason_code |[Leave reason](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#18) in accordance with the eSocial website| |leave_start_date |Leave start date| |leave_end_date |Leave end date| |termination_reason_code |[Termination reason](https://www.gov.br/esocial/pt-br/documentacao-tecnica/leiautes-esocial-versao-1-3-nt-03-2025/tabelas.html#19) in accordance with the eSocial website| |termination_date |Employment termination date| |notice_period_start_date |Prior notice period start date| |notice_period_end_date |Prior notice period end date| ### Alert types {#alert_type} ENUMERATOR alert_type | Enumerator | Description | |------------------------- |-----------------------------------| |leave |Leave of absence | |termination |Prior notice of termination | ### Proposal Request Status Details | Status | Description | | ------- | ------------------------------------------------------------------------- | | ongoing | **Proposal Request** in progress, the auction remains active. | | finished| **Proposal Request** completed, the auction has ended and a submitted **Proposal** was accepted and included. | | expired | **Proposal Request** expired, the auction has ended without the inclusion of any **Proposal** in due time. | ### Auction Proposal Request Details | Field | Type | Description | Required | |---------------|---------|-----------------------------------------------------------------------------------------------------------------|----------| | `issuer_proposal_request_key` | string | Unique identification key of the **IssuerProposalRequest** included in uuid v4 format. | Yes | | `auction_proposal_key` | string | Unique identification key of the **AuctionProposal** included in uuid v4 format. | Yes | | `disbursed_issue_amount`| float | Disbursement amount intended by the **Proposal**. | Yes | | `purchaser_document_number` | integer | CNPJ of the debt purchaser | Yes | | `monthly_interest_rate` | float | Monthly interest rate of the **Proposal** in the range of 0 to 1 (0% to 100%, respectively). | No | | `installment_face_value`| float | Installment value intended by the **Proposal**. | No | | `number_of_installments`| integer | Number of installments of the proposal. | Yes | | `days_to_expiration`| integer | Number of days until the proposal expires. If the key is not included, the proposal validity will be 7 days | No | | `rebates` | list | List of credit operation rebates. Uses the same standard as active issuance (/debt) | No | --- # Manual Consignado Privado - Refinanciamento URL: /en/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. ::: 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 ```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 ```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: /en/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: /en/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: /en/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: /en/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: /en/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: /en/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: /en/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 tipo e o número do documento do empregador e a matrícula do trabalhador. ```json [ { "collateral_type": "private_payroll", "collateral_data": { "employer_document_type": "cnpj", "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_type` | string | ✅ | Tipo do documento do empregador: `"cnpj"` ou `"cpf"`. Sem ele, o aceite da proposta (`accepted_by_requester`) é recusado. | | `collaterals[].collateral_data.employer_document_number` | string | ✅ | CNPJ (ou CPF) 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: /en/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: /en/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_type`, `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_type` + `employer_document_number` + `registration_number`. | | **`proposal_type`** | Tipo da proposta; para Consignado Privado, `"private_company"`. | --- # Webhook de pagamento do sinistro URL: /en/documentation/manual_consignado_privado/referencia/webhook-pagamento-do-sinistro A QI Tech envia este webhook ao originador a cada pagamento da seguradora registrado num sinistro aceito. Ele traz o pagamento e o sinistro como ficou depois dele. O pagamento que atinge o valor aprovado liquida o sinistro: depois deste webhook vem um [webhook de status](/documentation/manual_consignado_privado/referencia/webhook-status-do-sinistro) com o status `settled` e o motivo `fully_paid`. WEBHOOK_TYPE insurance_premium.claim_transaction A URL que recebe o webhook é a mesma dos demais webhooks do seguro. Veja [Configurando webhooks](/documentation/primeiros_passos/configurando_webhooks). ## Corpo do webhook | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ---------------- | -------- | ----------- | ---------------------------------------------------------------------- | ------- | | `key` | `uuid` | Sim | Chave do pagamento. Igual a `data.claim_transaction_key`. | 36 | | `status` | `string` | Sim | Sempre `received`. | — | | `webhook_type` | `string` | Sim | Sempre `insurance_premium.claim_transaction`. | — | | `event_datetime` | `string` | Sim | Data e hora do registro, em UTC, no formato `AAAA-MM-DDTHH:MM:SSZ`. | 20 | | `data` | `object` | Sim | O pagamento e o sinistro. Veja a tabela abaixo. | — | ### Atributos de `data` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | -------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | `claim_transaction_key` | `uuid` | Sim | Chave do pagamento. | 36 | | `amount` | `number` | Sim | Valor do pagamento, em reais. | — | | `payment_date` | `string` | Sim | Data do pagamento pela seguradora, no formato `AAAA-MM-DD`. | 10 | | `external_transaction_key` | `string` | Não | Referência do pagamento atribuída pela seguradora. | — | | `credit_operation_key` | `uuid` | Sim | Chave da dívida (CCB) à qual o seguro está atrelado. | 36 | | `claim` | `object` | Sim | O sinistro depois deste pagamento, com os mesmos campos de `data` do [webhook de status](/documentation/manual_consignado_privado/referencia/webhook-status-do-sinistro), exceto `credit_operation_key`. | — | ## Exemplo — primeiro pagamento ```json { "key": "2b3f2c1e-8b7a-4d0e-9a51-0f6c4b1d7e21", "status": "received", "webhook_type": "insurance_premium.claim_transaction", "event_datetime": "2026-11-03T12:45:08Z", "data": { "claim_transaction_key": "2b3f2c1e-8b7a-4d0e-9a51-0f6c4b1d7e21", "amount": 454.77, "payment_date": "2026-11-03", "external_transaction_key": "pagamento-0001", "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "claim": { "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "accepted", "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18", "coverage_type": "unemployment", "external_key": "sinistro-0001", "claim_data": { "approved_amount": 909.54, "approved_installment_quantity": 2 }, "paid_amount": 454.77, "transactions": [ { "claim_transaction_key": "2b3f2c1e-8b7a-4d0e-9a51-0f6c4b1d7e21", "amount": 454.77, "payment_date": "2026-11-03", "external_transaction_key": "pagamento-0001" } ] } } } ``` ## Erros Este webhook não devolve erro ao originador. A sua URL deve responder com um status `2xx`; o comportamento de entrega e o reenvio estão em [Configurando webhooks](/documentation/primeiros_passos/configurando_webhooks). ## Próximo passo - [Webhook de status do sinistro](/documentation/manual_consignado_privado/referencia/webhook-status-do-sinistro): os status do sinistro, da abertura à liquidação, e os motivos de recusa e encerramento. --- # Webhook de status do sinistro URL: /en/documentation/manual_consignado_privado/referencia/webhook-status-do-sinistro A QI Tech envia este webhook ao originador a cada mudança de status de um sinistro do seguro de uma dívida (CCB): quando o sinistro é aberto junto à seguradora, quando entra em análise, quando é aceito ou recusado e quando é liquidado. WEBHOOK_TYPE insurance_premium.claim_status_change A URL que recebe o webhook é a mesma dos demais webhooks do seguro e é configurada uma única vez para a sua integração. Veja [Configurando webhooks](/documentation/primeiros_passos/configurando_webhooks). ## Corpo do webhook | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ---------------- | -------- | ----------- | ------------------------------------------------------------------------- | ------- | | `key` | `uuid` | Sim | Chave do sinistro. Igual a `data.claim_key`. | 36 | | `status` | `string` | Sim | Status do sinistro após a mudança. Veja [Status do sinistro](#status). | — | | `webhook_type` | `string` | Sim | Sempre `insurance_premium.claim_status_change`. | — | | `event_datetime` | `string` | Sim | Data e hora da mudança, em UTC, no formato `AAAA-MM-DDTHH:MM:SSZ`. | 20 | | `data` | `object` | Sim | O sinistro. Veja a tabela abaixo. | — | ### Atributos de `data` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ----------------------- | --------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | | `claim_key` | `uuid` | Sim | Chave do sinistro. | 36 | | `status` | `string` | Sim | Status do sinistro. Veja [Status do sinistro](#status). | — | | `insurance_premium_key` | `uuid` | Sim | Chave do seguro, a mesma do webhook `insurance_premium.status_change`. | 36 | | `credit_operation_key` | `uuid` | Sim | Chave da dívida (CCB) à qual o seguro está atrelado. | 36 | | `coverage_type` | `string` | Não | Cobertura do seguro acionada, com o mesmo enumerador da lista `covers` do seguro. Para desemprego involuntário, `unemployment`. | — | | `external_key` | `string` | Não | Referência do sinistro atribuída pela QI Tech. | 100 | | `paid_amount` | `number` | Sim | Soma, em reais, dos pagamentos da seguradora registrados no sinistro. `0` até o primeiro pagamento. | — | | `transactions` | `array` | Sim | Os pagamentos registrados, do mais antigo ao mais recente. Lista vazia até o primeiro pagamento. | — | | `claim_data` | `object` | Não | O que a seguradora aprovou. Presente a partir do status `accepted`. | — | | `reason` | `string` | Não | Motivo da mudança, quando houver. Veja [Motivo](#motivo). | — | ### Atributos de `claim_data` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ------------------------------- | --------- | ----------- | -------------------------------------------------------------------------------------------- | ------- | | `approved_amount` | `number` | Sim | Valor máximo aprovado pela seguradora, em reais. A soma dos pagamentos nunca o ultrapassa. | — | | `approved_installment_quantity` | `integer` | Não | Quantidade de parcelas da dívida cobertas pela aprovação. | — | ### Atributos de cada item de `transactions` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | -------------------------- | -------- | ----------- | ------------------------------------------------------- | ------- | | `claim_transaction_key` | `uuid` | Sim | Chave do pagamento. | 36 | | `amount` | `number` | Sim | Valor do pagamento, em reais. | — | | `payment_date` | `string` | Sim | Data do pagamento pela seguradora, no formato `AAAA-MM-DD`. | 10 | | `external_transaction_key` | `string` | Não | Referência do pagamento atribuída pela seguradora. | — | ## Status do sinistro {#status} Cada linha é um webhook. O sinistro passa pelos status nesta ordem; `rejected` e `settled` são finais. | Status | Descrição | | ------------------- | ------------------------------------------------------------------------------------------------------------------ | | `opened` | Sinistro aberto junto à seguradora. | | `awaiting_analysis` | Em análise pela seguradora. | | `accepted` | Aceito pela seguradora, com o valor aprovado em `claim_data`. A partir daqui o sinistro recebe pagamentos. | | `rejected` | Recusado. Final. | | `settled` | Liquidado. Final. O motivo em `reason` diz se foi pago por inteiro ou encerrado antes. | ## Motivo {#motivo} | Enumerador | Status em que aparece | Descrição | | ------------------------ | --------------------- | ------------------------------------------------------------------------- | | `ineligible` | `rejected` | O sinistro não é coberto pelas condições do seguro. | | `fully_paid` | `settled` | Os pagamentos atingiram o valor aprovado. | | `coverage_ended` | `settled` | A cobertura terminou antes de atingir o valor aprovado. | | `credit_operation_ended` | `settled` | A dívida (CCB) foi encerrada antes de atingir o valor aprovado. | ## Exemplo — sinistro aberto ```json { "key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "opened", "webhook_type": "insurance_premium.claim_status_change", "event_datetime": "2026-10-19T20:39:33Z", "data": { "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "opened", "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18", "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "coverage_type": "unemployment", "external_key": "sinistro-0001", "paid_amount": 0.0, "transactions": [] } } ``` ## Exemplo — sinistro aceito ```json { "key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "accepted", "webhook_type": "insurance_premium.claim_status_change", "event_datetime": "2026-10-26T13:02:10Z", "data": { "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "accepted", "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18", "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "coverage_type": "unemployment", "external_key": "sinistro-0001", "claim_data": { "approved_amount": 909.54, "approved_installment_quantity": 2 }, "paid_amount": 0.0, "transactions": [] } } ``` ## Exemplo — sinistro liquidado ```json { "key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "settled", "webhook_type": "insurance_premium.claim_status_change", "event_datetime": "2026-11-30T15:21:47Z", "data": { "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534", "status": "settled", "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18", "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "coverage_type": "unemployment", "external_key": "sinistro-0001", "claim_data": { "approved_amount": 909.54, "approved_installment_quantity": 2 }, "paid_amount": 909.54, "transactions": [ { "claim_transaction_key": "2b3f2c1e-8b7a-4d0e-9a51-0f6c4b1d7e21", "amount": 454.77, "payment_date": "2026-11-03", "external_transaction_key": "pagamento-0001" }, { "claim_transaction_key": "7d1e9a40-3c55-4f6b-8e2a-91b0c6a5f3d8", "amount": 454.77, "payment_date": "2026-11-30", "external_transaction_key": "pagamento-0002" } ], "reason": "fully_paid" } } ``` ## Erros Este webhook não devolve erro ao originador. A sua URL deve responder com um status `2xx`; o comportamento de entrega e o reenvio estão em [Configurando webhooks](/documentation/primeiros_passos/configurando_webhooks). ## Próximo passo - [Webhook de pagamento do sinistro](/documentation/manual_consignado_privado/referencia/webhook-pagamento-do-sinistro): um webhook por pagamento da seguradora, com o sinistro atualizado. --- # Manual Consignado Privado - Movimentação de Vínculos: Consulta de Reservas URL: /en/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: /en/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 | --- # Webhook de migração automática de contrato URL: /en/documentation/manual_consignado_privado/vinculos_empregaticios/migracao_automatica A DATAPREV pode migrar, por conta própria, um contrato de consignado privado para outro vínculo empregatício do mesmo trabalhador: outro empregador ou outra matrícula no mesmo empregador. A QI Tech consulta essas migrações na DATAPREV, aplica cada uma à averbação do contrato e envia este webhook informando o vínculo anterior e o novo. WEBHOOK_TYPE laas.private_payroll.reservation_automatic_transfer ## Diferença para o revínculo No revínculo, a QI Tech cria uma nova averbação no novo vínculo, que passa por autorização e averbação na DATAPREV. Na migração automática, quem move o contrato é a própria DATAPREV: - O número do contrato (`contract_number`) continua o mesmo. - A averbação continua a mesma: mesma `reservation_key`, agora com o empregador e a matrícula do novo vínculo. - Não há autorização do parceiro nem nova tentativa de averbação. ## Quando o webhook é enviado O webhook é enviado uma vez por migração aplicada, quando o vínculo da averbação muda. Uma averbação em `terminated` (encerrada por término de vínculo) volta para `reserved` ao ser migrada. Essa mudança de status é informada por este webhook, sem um `laas.private_payroll.reservation_status_change` separado. ## Status O campo `status` traz o status da averbação depois da migração: | Status | Significado | | ---------- | ---------------------------------------------------------------------------------------------------------------- | | `reserved` | O contrato segue averbado, agora no novo vínculo. | | `settled` | A DATAPREV migrou o contrato e o informou como liquidado. A averbação foi migrada e encerrada. | ## Corpo do webhook | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ---------------- | -------- | ----------- | --------------------------------------------------------------------------------------------- | ------- | | `webhook_type` | `string` | Sim | Sempre `laas.private_payroll.reservation_automatic_transfer`. | — | | `key` | `uuid` | Sim | Chave da dívida (CCB) à qual a averbação pertence. É a mesma `key` dos outros webhooks da averbação. | 36 | | `status` | `string` | Sim | Status da averbação depois da migração: `reserved` ou `settled`. Veja [Status](#status). | — | | `event_datetime` | `string` | Sim | Data e hora do envio, em UTC, no formato `AAAA-MM-DDTHH:MM:SSZ`. | 20 | | `data` | `object` | Sim | Dados da migração. Veja a tabela abaixo. | — | O webhook não traz a data em que a DATAPREV fez a migração: a consulta de migrações da DATAPREV não informa esse instante. ### Atributos de `data` | Campo | Tipo | Obrigatório | Descrição | Tamanho | | ----------------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------ | ------- | | `reservation_key` | `uuid` | Sim | Chave da averbação migrada. Não muda com a migração. | 36 | | `contract_number` | `string` | Sim | Número do contrato na DATAPREV. Não muda com a migração. | — | | `previous_employer_document_type` | `string` | Sim | Tipo do documento do empregador do vínculo anterior: `cnpj` ou `cpf`. | — | | `previous_employer_document_number` | `string` | Sim | Documento do empregador do vínculo anterior, só dígitos, como estava na averbação. | — | | `previous_registration_number` | `string` | Sim | Matrícula do trabalhador no vínculo anterior. | — | | `employer_document_type` | `string` | Sim | Tipo do documento do empregador do novo vínculo: `cnpj` ou `cpf`. | — | | `employer_document_number` | `string` | Sim | Documento do empregador do novo vínculo, só dígitos, como a DATAPREV informou. | 8 a 14 | | `registration_number` | `string` | Sim | Matrícula do trabalhador no novo vínculo. | — | Para um empregador `cnpj`, a DATAPREV pode informar a raiz do CNPJ (8 dígitos) ou o CNPJ completo (14 dígitos). Para um empregador `cpf`, o documento tem 11 dígitos. ## Exemplo ```json { "webhook_type": "laas.private_payroll.reservation_automatic_transfer", "key": "123e4567-e89b-12d3-a456-426614174000", "status": "reserved", "event_datetime": "2026-10-20T13:05:12Z", "data": { "reservation_key": "9b2f6c1e-4d3a-4f8b-a1c7-2e5d8f0b3a64", "contract_number": "2024001234", "previous_employer_document_type": "cnpj", "previous_employer_document_number": "12345678000190", "previous_registration_number": "99999999999-A", "employer_document_type": "cnpj", "employer_document_number": "98765432", "registration_number": "88888888888-B" } } ``` ## Próximo passo - [Consulta de Reservas](/documentation/manual_consignado_privado/vinculos_empregaticios/consultas): a averbação migrada já aparece com o novo vínculo. - [Regras de Negócio](/documentation/manual_consignado_privado/vinculos_empregaticios/visao_geral): o ciclo do término de vínculo até o revínculo. --- # Manual Consignado Privado - Movimentação de Vínculos: Webhooks de Movimentação URL: /en/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: /en/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: /en/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. |