Consultar as linhas de crédito da Empresa

Esse endpoint permite consultar as linhas de crédito que estão disponíveis para a Empresa.

Parâmetros da URL

  • business_id (string, uuid v4): Identificador do cadastro da Empresa a ser consultada.

Parâmetros para filtros e paginação dos resultados:

  • page (integer, opcional): O nº da página para paginação.
  • size (integer, opcional): A quantidade de itens a serem retornados na paginação.
  • status (string, opcional): Status da disponibilidade.
  • application_id (uuid, opcional): Campo para filtrar o resultado por ID da Aplicação.
  • borrower_id (uuid, opcional): Campo para filtrar o resultado por ID do tomador do crédito.
  • employer_id (uuid, opcional): Campo para filtrar o resultado por ID do empregador.
  • role (string, opcional): Campo para filtrar o resultado por tipo do tomador.
  • borrower_employer_id (string/uuid, opcional): Campo para filtrar o resultado por um conjunto de empregador e tomador.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

Exemplo de JSON de resposta:

{
  "content": [
    {
      "id": "",
      "funding": {
        "id": "",
        "legal_name": "",
        "alias": "",
        "metadata": {
          "values": {
            "adipisicinga2e": {
              "value": [""],
              "sensitive": ""
            }
          }
        }
      },
      "employer": {
        "id": "",
        "legal_name": ""
      },
      "role": "",
      "status": "",
      "borrower": {
        "id": "",
        "name": ""
      },
      "condition": {
        "max_payment_number": "",
        "min_payment_number": "",
        "tac": "",
        "max_grace_period": "",
        "min_grace_period": "",
        "min_requested_amount": "",
        "schedule_based_conditions": [
          {
            "upper_limit": "",
            "interest_rate": ""
          }
        ],
        "exp_date": "",
        "line_of_credit": {
          "credit_limit": "",
          "max_payment_amount": "",
          "consumed_payment_amount": "",
          "consumed_credit_limit": ""
        },
        "due_day": "",
        "rating": {
          "identifier": "",
          "description": "",
          "display_name": "",
          "max_payment_number": "",
          "min_payment_number": "",
          "tac": "",
          "max_grace_period": "",
          "min_grace_period": "",
          "min_requested_amount": "",
          "schedule_based_conditions": [
            {
              "upper_limit": "",
              "interest_rate": ""
            }
          ],
          "created_at": "",
          "updated_at": "",
          "version": ""
        }
      },
      "application": {
        "id": "",
        "product": {
          "id": ""
        },
        "borrower": {
          "id": ""
        },
        "requested_amount": "",
        "interest_rate": "",
        "tac_amount": "",
        "finance_fee": "",
        "base_premium_amount": "",
        "additional_premium_amount": "",
        "num_payments": "",
        "first_payment_date": "",
        "disbursement_date": "",
        "issue_date": "",
        "status": "",
        "loan_details": {
          "total_processing_cost": "",
          "annual_interest_rate": "",
          "annual_effective_interest_rate": "",
          "monthly_effective_interest_rate": "",
          "total_amount_owed": "",
          "disbursement_amount": "",
          "financed_amount": "",
          "iof_daily_rate": "",
          "iof_amount": "",
          "iof_base_rate": "",
          "payment_amount": "",
          "issue_date": "",
          "schedule": [
            {
              "payment": "",
              "iof": "",
              "balance": "",
              "interest": "",
              "principal": "",
              "period": "",
              "running_day": "",
              "payment_date": ""
            }
          ],
          "last_payment_date": ""
        },
        "custom_variables": {
          "values": {
            "velitb0": "",
            "dolore_13": "",
            "sunta": ""
          }
        },
        "canceled_in": "",
        "sequential_id": "",
        "originator": {
          "id": "",
          "legal_name": ""
        },
        "funding": {
          "id": "",
          "legal_name": "",
          "alias": "",
          "metadata": {
            "values": {
              "ad42": {
                "value": [""],
                "sensitive": ""
              },
              "laborum_b": {
                "value": [""],
                "sensitive": ""
              }
            }
          }
        },
        "payment_method": "",
        "disbursement": {
          "requested_at": "",
          "processed_at": "",
          "receipt": ""
        },
        "beneficiary_account": {
          "registered_account_id": "",
          "holder": {
            "name": "",
            "taxpayer_id": ""
          },
          "external_bank_account": {
            "bank_account": "",
            "bank_account_digit": "",
            "bank_branch": "",
            "bank_code": "",
            "bank_account_type": "",
            "ispb_code": ""
          },
          "pix": {
            "key": "",
            "key_type": ""
          },
          "baas": {
            "account_number": ""
          }
        },
        "created_at": "",
        "updated_at": "",
        "version": "",
        "managed_account_for_issuer_disbursement": {
          "baas": {
            "account_number": "",
            "holder_type": ""
          },
          "product_configuration": {
            "if_existing": "",
            "type": ""
          }
        }
      },
      "borrower_employer": {
        "id": ""
      },
      "product": {
        "id": "",
        "name": "",
        "description": ""
      },
      "created_at": "",
      "updated_at": "",
      "version": ""
    }
  ],
  "total_pages": "",
  "total_elements": "",
  "has_next": ""
}

Language
URL
Click Try It! to start a request and see the response here!