Pular para o conteúdo principal

2.1.4. Contrato de Portabilidade com Refinanciamento

Na modalidade Portabilidade com Refinanciamento, o processo de migração do contrato externo é combinado com a renovação imediata da operação na bancarizadora de destino. A dívida é transferida e, simultaneamente, o contrato é reestruturado para permitir a liberação de capital adicional ao cliente, aproveitando a diferença entre o saldo liquidado e o novo valor financiado dentro da margem disponível.

Autenticação​

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

KeyValue
apikey{{apikey}}
aviso

Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.

POST Listar Produtos por tipo de operação​

/v3/loan-products/search/basic

Este endpoint permite listar os produtos de empréstimo disponíveis filtrando por tipo e operação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
type.code.eqnumberSimCódigo do tipo de produto a filtrar
operation.code.eqnumberSimCódigo da operação desejada

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "type": {
        "code": {
            "eq": 20
        }
    },
    "operation": {
        "code": {
            "eq": 3
        }
    }
}

POST Listar Tabelas por tipo de operação​

/v3/loan-product-rules/search/basic

Este endpoint permite listar as tabelas de regras de produtos de empréstimo filtrando por tipo de operação.

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
offsetnumberSimÍndice inicial para paginação
limitnumberSimQuantidade máxima de registros retornados (Máximo de 20 por página)
operation.code.eqnumberSimCódigo da operação desejada

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "offset": 0,
    "limit": 0, 
    "operation": {
        "code": {
            "eq":  3
        }
    }
}

POST Calcular contrato de portabilidade com refinanciamento​

/v3/loan-inss-simulations/calculation

Este endpoint permite calcular os valores de um contrato de portabilidade com refinanciamento de INSS antes de criar a simulação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
ruleIdstring (UUID)SimID da tabela de produto
termnumberSimPrazo da portabilidade em meses
ratenumberSimTaxa de juros da portabilidade
installmentValuenumberSimValor da parcela da portabilidade
loanValuenumberSimValor total do empréstimo
hasInsurancebooleanSimtrue para incluir seguro, false para remover
originContractobjectSimDados do contrato de origem a ser portado
originContract.lenderCodenumberSimCódigo do credor de origem
originContract.dueBalanceValuenumberSimSaldo devedor atual
originContract.contractDatestringSimData de contratação do contrato de origem (formato YYYY-MM-DD)
refinancing.termnumberSimPrazo do refinanciamento em meses
refinancing.ratenumberSimTaxa de juros do refinanciamento
refinancing.installmentValuenumberSimValor da parcela do refinanciamento
referenceCodestring | nullNãoCódigo de referência externo

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "ruleId": "{{portRefinRuleId}}",
    "term": 66,
    "rate": 1.2993,
    "installmentValue": 300,
    "loanValue": 13000,
    "originContract": {
        "lenderCode": 237,
        "contractNumber": "213623",
        "term": 84,
        "installmentsRemaining": 66,
        "installmentValue": 300,
        "dueBalanceValue": 13000,
        "contractDate": "2026-10-10"
    },
    "refinancing": {
        "term": 96,
        "rate": 1.70,
        "installmentValue": 300
    },
    "hasInsurance": false,
    "referenceCode": null
}

POST Criar simulação de portabilidade com refinanciamento​

/v3/loan-inss-simulations

Este endpoint permite criar uma simulação que combina portabilidade de um contrato de outra instituição com refinanciamento adicional.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
borrower.namestringSimNome completo do tomador
borrower.identitystringSimCPF do tomador
borrower.benefitstringSimNúmero do benefício INSS
borrower.incomenumberSimRenda mensal do tomador
borrower.addressobjectSimEndereço completo
borrower.documentobjectSimDocumento de identificação
items[].ruleIdstring (UUID)SimID da tabela de produto
items[].termnumberSimPrazo da portabilidade em meses
items[].ratenumberSimTaxa de juros da portabilidade
items[].installmentValuenumberSimValor da parcela
items[].loanValuenumberSimValor total do empréstimo
items[].originContractobjectSimDados do contrato de origem a ser portado
items[].refinancing.termnumberSimPrazo do refinanciamento em meses
items[].refinancing.ratenumberSimTaxa de juros do refinanciamento
items[].refinancing.installmentValuenumberSimValor da parcela do refinanciamento
items[].hasInsurancebooleanSimIndica se há seguro
creditBankAccountobjectSimDados bancários para crédito
filesarraySimDocumentos anexados (doc_front, doc_back)
step.codenumberSimEtapa atual da proposta
validatebooleanNãotrue para validar sem efetivar a proposta

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "borrower": {
        "name": "{{name}}",
        "identity": "{{identity}}",
        "benefit": "{{inss_benefit}}",
        "benefitState": "SP",
        "benefitStartDate": "1999-01-15",
        "benefitPaymentMethod": 1,
        "benefitType": 42,
        "birthDate": "1965-08-19",
        "motherName": "Maria da Silva",
        "maritalStatus": "Solteiro",
        "sex": "Feminino",
        "income": 1800.50,
        "phone": "{{phone}}",
        "email": "[email protected]",
        "address": {
            "street": "Av. Paulista",
            "number": "552",
            "complement": "Bloco A",
            "district": "Centro",
            "city": "São Paulo",
            "state": "SP",
            "zipCode": "01310930"
        },
        "document": {
            "type": {
                "code": "RG",
                "name": "Registro Geral"
            },
            "number": "12232323",
            "issuingDate": "1990-05-21",
            "issuingEntity": "SSP",
            "issuingState": "SP"
        }
    },
    "items": [
        {
            "ruleId": "{{portRefinRuleId}}",
            "term": 66,
            "rate": 1.2993,
            "installmentValue": 300,
            "loanValue": 13000,
            "originContract": {
                "lenderCode": 237,
                "contractNumber": "213623",
                "term": 84,
                "installmentsRemaining": 66,
                "installmentValue": 300,
                "dueBalanceValue": 13000,
                "contractDate": "2026-10-10"
            },
            "refinancing": {
                "term": 84,
                "rate": 1.66,
                "installmentValue": 300
            },
            "hasInsurance": false,
            "referenceCode": null
        }
    ],
    "creditBankAccount": {
        "bank": "001",
        "branch": "1234",
        "number": "123654",
        "digit": "6"
    },
    "step": {
        "code": 0,
        "name": "string"
    },
    "files": [
        {
            "id": "{{doc_front_id}}",
            "type": "doc_front"
        },
        {
            "id": "{{doc_back_id}}",
            "type": "doc_back"
        }
    ],
    "note": null,
    "brokerId": null,
    "accessId": null,
    "validate": true
}

GET Obter termo de autorização​

/v3/loan-inss-simulations/{{simulation_id}}/auth-term

Este endpoint retorna o termo de autorização para consulta do benefício INSS. O campo key retornado deve ser utilizado no próximo passo para assinatura do termo.

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loan-inss-simulations/{{simulation_id}}/auth-term' \
--header 'apikey: {{apikey}}'

PUT Assinar termo de autorização​

/v3/signer/{{auth_term_key}}/accept

Este endpoint realiza a assinatura do termo de autorização. Atenção: só deve ser executado se status.key != 'signed' no response do endpoint anterior.

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "position": {
        "latitude": "-235489",
        "longitude": "-466388"
    }
}

POST Gerar Contratos de Empréstimo​

/v3/loan-inss-simulations/{{simulation_id}}/actions

Este endpoint é responsável por transformar uma simulação aprovada em contratos efetivos, iniciando o processo de formalização e assinatura.

Exemplo de Requisição e Resposta​

Visualizar Body
{ 
  "command": "create_loans"
}

GET Consultar Contratos de Empréstimo pelo ID da Simulação​

/v3/loans/simulation/{{simulation_id}}

Este endpoint permite consultar todos os contratos de empréstimo vinculados a uma simulação específica.

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loans/simulation/{{simulation_id}}' \
--header 'apikey: {{apikey}}'