Listar políticas de crédito

GET

credit-policies

curl --request GET \
  --url https://api.base39.io/v1/credit-policies \
  --header 'Authorization: Bearer <token>'

{
  "hasMore": true,
  "data": [
    {
      "id": "crpl_5f92f01728e009f403d8502e",
      "status": "active",
      "name": "Consignado",
      "model": "EMPLOYMENT_LENGTH_SALARY_MULTIPLIER",
      "product": "prod_5f92f01728e009f403d8502e",
      "options": {
        "interestType": "pre_price_days",
        "creditOperationType": "ccb",
        "rebates": [
          {
            "feeType": "first_loan",
            "amountType": "percentage",
            "amount": 0.2,
            "description": "Tarifa de cadastro",
            "minAmount": 200,
            "maxAmount": 2000
          }
        ],
        "fine": {
          "fineRate": 0.02,
          "interestBase": "calendar_days",
          "monthlyRate": 0.02
        },
        "rules": [
          {
            "workingMonthsRangeStart": 6,
            "workingMonthsRangeEnd": 12,
            "salaryMultiples": 2,
            "minimumDisbursementAmount": 200,
            "maximumDisbursementAmount": 2000,
            "fund": "fund_5f92f01728e009f403d8502e",
            "monthlyFee": [
              {
                "installmentsRangeStart": 12,
                "installmentsRangeEnd": 36,
                "amount": 0.02,
                "insurance": {
                  "fee": 123,
                  "type": "uninsured",
                  "number": "<string>",
                  "insurer": "<string>"
                }
              }
            ]
          }
        ]
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

product

string

Um filtro com base no campo product.

name

string

Um filtro com base no campo name.

exclude_fields

string

Campos a remover do corpo da resposta. O valor deve ser uma string ou uma lista separada por vírgula. Campos informados que não existem na resposta serão descartados.

expand

string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

starting_after

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before

string

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

deleted

boolean

Um filtro com base no campo deleted. O valor deve ser um booleano.

string

Filtro no campo id da política de crédito, aceitando string ou lista separada por vírgula.

Response

200 - application/json

Objeto com `data` contendo array de `CreditPolicy` a partir de `starting_after`; vazio se não houver mais itens. Solicitação nunca retorna erro.

Uma lista de políticas de crédito.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de políticas de crédito

Este objeto representa uma política de crédito.

data.id

string

Identificador exclusivo para o objeto.

Example:

"crpl_5f92f01728e009f403d8502e"

data.status

enum<string>

Available options:

active,

inactive

data.name

string

Nome da política de crédito.

Example:

"Consignado"

data.model

enum<string>

Available options:

EMPLOYMENT_LENGTH_SALARY_MULTIPLIER

Example:

"EMPLOYMENT_LENGTH_SALARY_MULTIPLIER"

data.product

string

Id do produto associado a política de crédito.

Example:

"prod_5f92f01728e009f403d8502e"

data.options

object

Modelo que aplica uma taxa de juros em faixas baseado no tempo de casa em meses.

data.options.interestType

enum<string>

required

Tipo de juros aplicado na dívida.

Available options:

pre_price_days

Example:

"pre_price_days"

data.options.creditOperationType

enum<string>

required

Tipo de operação de crédito

Available options:

ccb

Example:

"ccb"

data.options.rebates

object[]

required

Detalhes das taxas de um empréstimo.

data.options.fine

object

required

data.options.rules

object[]

required

data.metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.createdBy

object

data.updatedBy

object

curl --request GET \
  --url https://api.base39.io/v1/credit-policies \
  --header 'Authorization: Bearer <token>'

{
  "hasMore": true,
  "data": [
    {
      "id": "crpl_5f92f01728e009f403d8502e",
      "status": "active",
      "name": "Consignado",
      "model": "EMPLOYMENT_LENGTH_SALARY_MULTIPLIER",
      "product": "prod_5f92f01728e009f403d8502e",
      "options": {
        "interestType": "pre_price_days",
        "creditOperationType": "ccb",
        "rebates": [
          {
            "feeType": "first_loan",
            "amountType": "percentage",
            "amount": 0.2,
            "description": "Tarifa de cadastro",
            "minAmount": 200,
            "maxAmount": 2000
          }
        ],
        "fine": {
          "fineRate": 0.02,
          "interestBase": "calendar_days",
          "monthlyRate": 0.02
        },
        "rules": [
          {
            "workingMonthsRangeStart": 6,
            "workingMonthsRangeEnd": 12,
            "salaryMultiples": 2,
            "minimumDisbursementAmount": 200,
            "maximumDisbursementAmount": 2000,
            "fund": "fund_5f92f01728e009f403d8502e",
            "monthlyFee": [
              {
                "installmentsRangeStart": 12,
                "installmentsRangeEnd": 36,
                "amount": 0.02,
                "insurance": {
                  "fee": 123,
                  "type": "uninsured",
                  "number": "<string>",
                  "insurer": "<string>"
                }
              }
            ]
          }
        ]
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Visão geral

Ingestão de dados

Consulta de dados

Listar políticas de crédito

Authorizations

Query Parameters

Response