Consultar Margem

Consulta a margem consignável disponível de um trabalhador. O valor retornado representa o máximo que pode ser descontado mensalmente da folha de pagamento para quitação de parcelas.

Parâmetros

Parâmetro	Local	Tipo	Descrição
cpf	path	string	CPF do employee (11 dígitos, sem pontuação)

Respostas

Código	Significado	Ação
200	Margem disponível	Prossiga para a simulação
202	Em processamento	Aguarde e consulte novamente
404	Employee não encontrado	Verifique o CPF informado

A margem é consultada diretamente no Dataprev e pode levar alguns segundos para ser retornada. Se receber 202, aguarde e tente novamente.

Próximo passo

Com a margem disponível, prossiga para Criar Simulação.

Consultar Margem

get

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

/api/v1/originator/employees/{cpf}/margin

Consulta margem consignável de um employee

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

cpfstringObrigatório

CPF do employee (11 dígitos)

Pattern: ^\d{11}$

Respostas

200

Margem retornada com sucesso

application/json

statusstring · enumOpcional

Status da consulta de margem no convênio.

Valor	Significado
OK	Margem disponível e elegível
PENDING	Consulta em análise
PROCESSING	Processando dados no convênio
EXPIRED	Margem expirada (prazo Dataprev)
TERM_EXPIRED	Prazo do contrato expirado
NO_BONDS	Sem vínculos ativos
NOT_ELIGIBLE	Não elegível às regras do produto
NO_MARGIN	Sem margem disponível
ERROR	Erro na consulta

Valores possíveis:

reasonstringOpcional

202

Consulta em processamento

application/json

401

Não autenticado

403

Permissão insuficiente

404

Employee não encontrado

get

/api/v1/originator/employees/{cpf}/margin

HTTPcURLJavaScriptPython

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

{
  "status": "OK",
  "reason": null,
  "employmentRelationships": [
    {
      "id": 7,
      "registrationNumber": "12345678901",
      "employerTaxId": "12345678000199",
      "employerName": "Empresa Exemplo Ltda",
      "admissionDate": "2020-03-15",
      "status": "ACTIVE",
      "totalEarnings": 4850.73,
      "marginBase": 4850.73,
      "availableMargin": 1697.76,
      "usableMargin": 1697.76,
      "isEligible": true
    }
  ]
}

Central de Atendimento | Giro.TechGiro.Tech