2.4.2. Suporte

Esta seção documenta os endpoints de apoio ao processo de aprovação de saldo INSS, especificamente voltados para consulta de Tabelas Disponíveis e Detalhes da Tabela. Esses endpoints permitem listar as regras de crédito vigentes e consultar as configurações completas de uma tabela específica, incluindo limites de prazo, faixa etária, taxas permitidas e demais parâmetros aplicáveis à operação.

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.

Key	Value
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.

---

GET 2.1.2.2.1. Tabelas Disponíveis

/v3/loan-product-rules/

Retorna a lista de tabelas de crédito disponíveis, incluindo limites de prazo, idade e taxas permitidas.

Por que usar essa rota?

O campo mais importante no retorno é o recalculationRules. Ele contém uma lista de tabelas compatíveis. Se quiser fazer uma Simulação de Recálculo trocando a taxa do cliente, escolha um dos IDs listados nesse array.

Exemplo de Requisição e Resposta

cURL

Visualizar cURL

curl --location 'https://integration.ajin.io/v3/loan-product-rules/' \
--header 'apikey: {{apikey}}'

200 - Sucesso

Visualizar Response

[
  {
    "id": "a4a21e9b-5112-4e40-8fac-275da8b7c5e0",
    "name": "Tabela Padrão INSS",
    "minInstallments": 6,
    "maxInstallments": 84,
    "minRate": 1.5,
    "maxRate": 2.14,
    "recalculationRules": [
      "b3c12f8a-1234-4abc-9def-000000000001",
      "c9d45e2b-5678-4def-aaaa-000000000002"
    ]
  }
]

400 - Erro

Visualizar Response

{
  "messages": [
    {
      "code": "9001002",
      "text": "Parâmetros inválidos"
    }
  ]
}

---

GET 2.1.2.2.2. Detalhes da Tabela

/v3/loan-product-rules/:ruleId

Retorna as configurações de uma tabela de crédito específica, incluindo limites de prazo, idade e taxas permitidas.

Por que usar essa rota?

O campo mais importante no retorno é o recalculationRules. Ele contém uma lista de tabelas compatíveis. Se quiser fazer uma Simulação de Recálculo trocando a taxa do cliente, escolha um dos IDs listados nesse array.

Parâmetros de Rota (Path)

Variável	Descrição
:ruleId	UUID da regra. Pode ser obtido nos detalhes de um contrato (rule.id)

Exemplo de Requisição e Resposta

cURL

Visualizar cURL

curl --location 'https://integration.ajin.io/v3/loan-product-rules/a4a21e9b-5112-4e40-8fac-275da8b7c5e0' \
--header 'apikey: {{apikey}}'

200 - Sucesso

Visualizar Response

{
  "id": "a4a21e9b-5112-4e40-8fac-275da8b7c5e0",
  "name": "Tabela Padrão INSS",
  "minInstallments": 6,
  "maxInstallments": 84,
  "minAge": 18,
  "maxAge": 80,
  "minRate": 1.5,
  "maxRate": 2.14,
  "recalculationRules": [
    "b3c12f8a-1234-4abc-9def-000000000001",
    "c9d45e2b-5678-4def-aaaa-000000000002"
  ],
  "createdAt": "2023-06-01T00:00:00Z",
  "updatedAt": "2024-01-10T00:00:00Z"
}

400 - Erro

Visualizar Response

{
  "messages": [
    {
      "code": "9001002",
      "text": "Parâmetros inválidos"
    }
  ]
}