Pular para o conteúdo principal

2.1.5. Contrato com Multiprodutos

Na modalidade Criação de contratos com multiprodutos, ocorre a formalização de uma nova operação de crédito que pode contemplar diferentes composições, conforme a necessidade do cliente e a estratégia comercial da instituição financeira. Essa modalidade permite estruturar contratos nas opções Novo, Portabilidade, Refinanciamento ou Portabilidade + Refinanciamento, podendo envolver a inclusão de troco, unificação de saldos ou migração de dívida, de acordo com as regras vigentes.

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
        }
    }
}

2.1.1.6. Calcular Simulação por Produto​

Selecione abaixo o produto desejado para acessar o endpoint de cálculo correspondente. Cada operação possui parâmetros e regras específicas.

ProdutoDescriçãoEndpoint
NovoConcessão de novo crédito consignadoVer endpoint →
PortabilidadePortabilidade de contrato de outra instituiçãoVer endpoint →
RefinanciamentoRefinanciamento de contrato ativoVer endpoint →
Portabilidade + RefinanciamentoPortabilidade com refinanciamento do saldoVer endpoint →

POST Criar simulação com mais de um produto​

/v3/loan-inss-simulations

Cria uma simulação contendo múltiplos produtos em uma única requisição. Útil para apresentar ao cliente diferentes opções de crédito simultaneamente.

Quando usar?

Use este endpoint quando quiser criar simulações com mais de um produto (ex: Novo + Portabilidade + Port. Refinanciamento) em uma única chamada, enviando os dados do tomador apenas uma vez.

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.benefitStatestringSimUF do benefício
borrower.benefitStartDatestring (ISO 8601)SimData de início do benefício
borrower.benefitPaymentMethodnumberSimForma de pagamento (1 = Cartão Magnético, 2 = Conta Corrente)
borrower.benefitTypenumberSimCódigo do tipo de benefício
borrower.birthDatestring (ISO 8601)SimData de nascimento
borrower.incomenumberSimRenda mensal do tomador
borrower.phonestringSimTelefone com DDD
borrower.emailstringSimE-mail do tomador
borrower.addressobjectSimEndereço completo
borrower.documentobjectSimDocumento de identificação
itemsarraySimLista de produtos a simular (ver tabela de produtos acima)
items[].ruleIdstring (UUID)SimID da tabela de produto
items[].termnumberSimPrazo em meses
items[].ratenumberSimTaxa de juros mensal
items[].installmentValuenumberSimValor da parcela
items[].loanValuenumberSimValor total do empréstimo
items[].hasInsurancebooleanNãotrue para incluir seguro
items[].originContractobjectCondicionalObrigatório para Portabilidade e Port. + Refinanciamento
items[].refinancingobjectCondicionalObrigatório para Portabilidade + Refinanciamento
items[].referenceCodestring | nullNãoCódigo de referência externo
creditBankAccountobjectSimDados bancários para crédito
filesarraySimDocumentos anexados (doc_front, doc_back)
step.codenumberSimEtapa atual da proposta
notestring | nullNãoObservação livre
brokerIdstring | nullNãoID do agente vinculado
accessIdstring | nullNãoIdentificador de acesso do operador

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": "{{portRuleId}}",
            "term": 66,
            "rate": 1.3,
            "installmentValue": 344.24,
            "loanValue": 14913.97,
            "originContract": {
                "lenderCode": 341,
                "contractNumber": "1234565",
                "term": 84,
                "installmentsRemaining": 66,
                "installmentValue": 350,
                "dueBalanceValue": 14913.97
            },
            "referenceCode": null
        },
        {
            "ruleId": "{{newRuleId}}",
            "term": 84,
            "rate": 1.66,
            "installmentValue": 100,
            "loanValue": 4438.74,
            "hasInsurance": false,
            "referenceCode": null
        },
        {
            "ruleId": "{{portRefinRuleId}}",
            "term": 66,
            "rate": 1.2993,
            "installmentValue": 300,
            "loanValue": 13000,
            "originContract": {
                "lenderCode": 237,
                "contractNumber": "213623",
                "term": 84,
                "installmentsRemaining": 66,
                "installmentValue": 300,
                "dueBalanceValue": 13000
            },
            "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": "d8556388-d8a9-46ad-8a30-ac729de0222b",
            "type": "doc_front"
        },
        {
            "id": "d8556388-d8a9-46ad-8a30-ac729de0222b",
            "type": "doc_back"
        }
    ],
    "note": null,
    "brokerId": null,
    "accessId": null
}

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}}'