Buscar Simulação

Retorna os detalhes completos de uma simulação específica, incluindo valor, parcelas, taxas, CET e datas de vencimento.

Parâmetros

Parâmetro	Local	Tipo	Descrição
id	path	integer	ID da simulação

Buscar Simulação

get

https://consignado.staging.giro.techhttps://consignado.giro.tech

/api/v1/originator/simulations/{id}

Retorna os detalhes de uma simulação específica por identificador.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

idinteger · int64Obrigatório

ID da simulação

Respostas

200

Simulação retornada com sucesso

application/json

idinteger · int64Opcional

Identificador interno da simulação criada.

Example: 42

employeeIdinteger · int64Opcional

Identificador interno do trabalhador associado à simulação.

Example: 15

employmentRelationshipIdinteger · int64Opcional

Identificador do vínculo empregatício usado no cálculo.

Example: 7

requestedAmountnumber · decimalOpcional

Valor solicitado em reais (decimal com 2 casas decimais).

Example: 5750

installmentCountintegerOpcional

Quantidade de parcelas calculada para a proposta simulada.

Example: 12

monthlyInterestRatenumber · decimalOpcional

Taxa de juros mensal em percentual (decimal com 4 casas decimais).

Example: 1.97

termMonthsintegerOpcional

Prazo total da operação em meses.

Example: 12

installmentAmountnumber · decimalOpcional

Parcela mensal em reais (decimal com 2 casas decimais).

Example: 593.78

totalAmountnumber · decimalOpcional

Valor total da operação em reais (decimal com 2 casas decimais).

Example: 7125.36

monthlyEffectiveCostnumber · decimalOpcional

CET mensal em percentual (decimal com 4 casas decimais).

Example: 2.43

annualEffectiveCostnumber · decimalOpcional

CET anual em percentual (decimal com 4 casas decimais).

Example: 33.18

iofAmountnumber · decimalOpcional

IOF estimado em reais (decimal com 2 casas decimais).

Example: 63.42

feesAmountnumber · decimalOpcional

Tarifas (TAC + seguro) em reais (decimal com 2 casas decimais).

Example: 122.22

statusstring · enumOpcional

Situação da simulação no ciclo de originação.

Valor	Significado
EPHEMERAL	Simulação ativa, ainda não convertida em proposta
CONVERTED_TO_PROPOSAL	Simulação já convertida em proposta
EXPIRED	Simulação expirada (prazo de validade ultrapassado)

Example: EPHEMERALValores possíveis:

expiresAtstring · date-timeOpcional

Data e hora limite de validade da simulação (UTC).

Example: 2024-02-08T10:00:00Z

sourcestringOpcional

Origem da simulação no sistema (por exemplo, ORIGINATOR).

Example: ORIGINATOR

createdDatestring · date-timeOpcional

Data e hora de criação da simulação (UTC).

Example: 2024-02-01T10:00:00Z

401

Não autenticado

403

Permissão insuficiente

404

Simulação não encontrada

get

/api/v1/originator/simulations/{id}

HTTPcURLJavaScriptPython

GET /api/v1/originator/simulations/{id} HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 42,
  "employeeId": 15,
  "employmentRelationshipId": 7,
  "requestedAmount": 5000,
  "installmentCount": 12,
  "monthlyInterestRate": 4,
  "termMonths": 12,
  "installmentAmount": 593.78,
  "totalAmount": 7125.36,
  "monthlyEffectiveCost": 2.43,
  "annualEffectiveCost": 33.18,
  "iofAmount": 63.42,
  "feesAmount": 0,
  "status": "EPHEMERAL",
  "expiresAt": "2025-01-16T10:00:00Z",
  "source": "ORIGINATOR",
  "createdDate": "2025-01-15T10:00:00Z"
}

Central de Atendimento | Giro.TechGiro.Tech