Pular para o conteúdo principal

Manual Consignado Privado - Tombamento do Legado

API em desenvolvimento

A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações.

1 - Pré requisitos​

Para tombar um contrato para o novo modelo do empréstimo consignado, é necessário que este tenha sido informado previamente e esteja no status "active", caso ainda haja algum contrato legado que não foi informado ou que não esteja no status correto, favor informar o time de operações com urgência, no manual de contratos legados está a documentação para consultar os contratos informados.

Além disso, por determinação da DATAPREV, é necessário que o tomador ainda esteja empregado no mesmo vínculo do contrato informado. É possível consultar os vínculos ativos do tomador sem enviar um termo de autorização utilizando a chamada abaixo (será validado se existe um contrato legado ativo para o mesmo CPF):

2 - Consulta de vínculos empregatícios para tombamento:​

A consulta de vínculos empregatícios é uma operação assíncrona. Ao enviar a requisição, a QI Tech processará a consulta em background e retornará o resultado através de um webhook quando finalizada.

O webhook será enviado para a URL configurada no seu ambiente.

POST
/private_payroll/employment_relationships_rollover_inquiry

Request​

Request Body
{
    "document_number": "<CPF FUNCIONÁRIO>"
}

Response​

STATUS
202 Accepted
Response Body
{
    "employment_relationships_rollover_inquiry_key": "<UUID>",
    "employment_relationships_rollover_inquiry_status": "pending_inquiry"
}

Webhooks​

WEBHOOK TYPE
laas.private_payroll.employment_relationships_rollover_inquiry_status_change

Retorno da consulta dos vínculos empregatícios:

STATUS
completed
Webhook Body
{
    "key": "<Employment Relationships Rollover Inquiry Key>",
    "status": "completed",
    "webhook_type": "laas.private_payroll.employment_relationships_rollover_inquiry_status_change",
    "event_datetime": "2025-03-24T15:28:31Z",
    "data": {
        "employment_relationships": [
            {
                "document_number": "47812365409",
                "registration_number": "99999999999-A", 
                "employer_document_number": "12345678000173"
            },
            {
                "document_number": "47812365409",
                "registration_number": "11111111111-B",
                "employer_document_number": "43211234000189"
            }
        ]
    }
}
STATUS
failed
Webhook Body
{
    "key": "<Employment Relationships Inquiry Key>",
    "status": "failure",
    "webhook_type": "laas.private_payroll.employment_relationships_rollover_inquiry_status_change",
    "event_datetime": "2025-03-24T15:28:31Z"
}

3 - Chamada de tombamento do contrato legado:​

Caso a operação original tenha sido emitida pela QI Tech, deve ser informada a chave da operação e o vencimentário atualizado da operação, caso contrário, também é necessário preencher os objetos borrower e financial.

TOMBAMENTO

Request​

POST
/external_debt
Request Body
{
    "borrower": {
        "name": "Nome devedor",
        "role_type": "issuer",
        "person_type": "natural",
        "individual_document_number": "14471835092",
    },
    "collaterals": [
        {
            "percentage": 1,
            "collateral_type": "private_payroll",
            "collateral_data": {
                "legacy_contract_number":"109230148",
                "operataion_category" :"legacy_contract_rollover",
                "employer_document_number": "07940839000159",
                "registration_number": "99999999999-A"
            }
        }
    ],
    "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
            }
        ]
    },
    "financial": {
        "interest_type": "pre_price_days",   
        "disbursement_date": "2024-11-07",
        "fine_configuration": {
            "monthly_rate": 0.0166,
            "interest_base": "calendar_days",   
            "contract_fine_rate": 0
        },
        "credit_operation_type": "ccb",   
        "total_iof": 120.00,
        "amount": 2000.00,
        "disbursed_amount": 1880.00,
        "monthly_cet": 0.015,
        "anual_cet": 2.35,
        "installment_face_value": 101.84,
        "installments" : [
            {
                "due_date":"2023-12-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2023-12-07",
                        "paid_amount": 101.84
                    }
                ]
            },
            {
                "due_date":"2024-01-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2024-01-07",
                        "paid_amount": 101.84
                    }
                ]
            },
            {
                "due_date":"2024-02-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2024-02-07",
                        "paid_amount": 101.84
                    }
                ]
            },
            {
                "due_date":"2024-03-07",
                "due_balance": 0, // data de hoje
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2024-03-07",
                        "paid_amount": 101.84
                    }
                ]
            },
            {
                "due_date":"2025-04-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2025-04-07",
                        "paid_amount": 101.84
                    }
                ]
            },
            {
                "due_date":"2025-05-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2025-04-07",
                        "paid_amount": 80.09
                    }
                ]
            },
            {
                "due_date":"2025-06-07",
                "due_balance": 148.89,
                "status": "opened",  
                "installment_payments":
                []
            },
            {
                "due_date":"2025-07-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2025-08-07",
                        "paid_amount": 140.45
                    }
                ]
            },
            {
                "due_date":"2025-08-07",
                "due_balance": 11.20,
                "status": "paid_partial",  
                "installment_payments":
                [
                    {
                        "paid_at": "2025-08-07",
                        "paid_amount": 95.00
                    }
                ]
            },
            {
                "due_date":"2025-09-07",
                "due_balance": 0,
                "status": "opened",  
                "installment_payments":
                []
            },
            {
                "due_date":"2025-10-07",
                "due_balance": 0,
                "status": "opened",  
                "installment_payments":
                []
            },
            {
                "due_date":"2025-11-07",
                "due_balance": 70.09,
                "status": "paid_partial",  
                "installment_payments":
                [
                    {
                        "paid_at": "2025-11-07",
                        "paid_amount": 20.09
                    }
                ]
            },
            {
                "due_date":"2025-12-07",
                "due_balance": 0,
                "status": "paid",  
                "installment_payments":
                [
                    {
                        "paid_at": "2025-12-07",
                        "paid_amount": 40.98
                    }
                ]
            }
        ]
    }