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": "QITECH"
  }
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": "bfa23ba1-be95-40b6-9a65-0696fca3be86",
      "document": "06561646541",
      "name": "JOÃO SILVA",
      "employer": {
        "name": "EMPRESA XYZ LTDA",
        "document": "89412850",
        "cnae": "6201"
      },
      "available_balance": 500.0,
      "utilizable_balance": 400.0,
      "base_margin_value": 4500.0,
      "total_gross_salary": null,
      "birth_date": "1985-07-20",
      "gender": {
        "code": 1,
        "description": "Masculino"
      },
      "mother_name": "MARIA DA SILVA",
      "admission_date": "2020-03-15",
      "worker_category_code": "101",
      "job_code": {
        "code": "2515",
        "description": "Analista de Sistemas"
      },
      "can_continue": true,
      "restrictions": [],
      "selected_fund_id": 2
    }
  }