Pular para o conteúdo principal

Consulta de Margem

info

Descrição​

Este endpoint permite consultar a margem disponível para o cliente, utilizando informações como o número do documento do cliente, o CNPJ do empregador e o tipo de serviço da bancarizadora. A resposta fornece detalhes sobre a margem disponível, saldo utilizável e informações pessoais do colaborador, essenciais para a realização de simulações e propostas de empréstimo consignado.

Endpoint​

POST  /clt-loan/v1/get-margin

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
}

Payload (Body)​

  {
    "document_number": "44961167827",
    "employer_document": "98179558000180",
    "service_type": "UY3"
  }
info

Observações:

  • O campo employer_document é o CNPJ da empresa onde o cliente trabalha.
  • O campo service_type pode ser obtido no response dalistagem de bancarizadora.

Exemplo de Resposta :​

{
  "success": true,
  "message": "Margem consultada com sucesso.",
  "data": {
    "margin_key": "5ce86e4d-2902-4a19-9859-73eb6c93cb33",
    "document": "44961167827",
    "name": "IASMIN DA SILVA CRUZ",
    "employer": {
      "name": "Empresa LTDA",
      "document": "98179558000180"
    },
    "available_balance": 2635.34,
    "utilizable_balance": 1844.73,
    "base_margin_value": 8000.0,
    "birth_date": "1988-03-25",
    "gender": {
      "code": 1,
      "description": "Masculino"
    },
    "mother_name": "Catarina Inclusao Massa Extra",
    "admission_date": "2018-09-01",
    "worker_category_code": "103",
    "job_code": {
      "code": "354815",
      "description": "AGENTE DE VIAGEM"
      }
    }
}