Listar empréstimos

GET

loans

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

{
  "hasMore": true,
  "data": [
    {
      "id": "loan_5f92f01728e009f403d8502e",
      "status": "open",
      "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
      "employment": "<string>",
      "customer": "<string>",
      "company": "<string>",
      "contractNumber": "AB123456789",
      "cashout": [
        {
          "amount": 123,
          "paymentMethod": "<string>",
          "type": "payment_method"
        }
      ],
      "offer": {
        "id": "offr_5f92f01728e009f403d8502e",
        "disbursementAmount": 123,
        "installmentAmount": 123,
        "totalAmount": 123,
        "interestAmount": 123,
        "iofAmount": 123,
        "iofAdditionalAmount": 123,
        "monthlyCET": 0.02,
        "yearlyCET": 0.12,
        "monthlyFee": 0.02,
        "yearlyFee": 0.12,
        "insurance": {
          "amount": 123,
          "fee": 0.02,
          "type": "required",
          "number": "<string>",
          "insurer": "<string>"
        },
        "interestType": "<string>",
        "creditOperationType": "<string>",
        "expectedDisbursementDate": "2023-12-25",
        "interestGracePeriod": 123,
        "principalGracePeriod": 123,
        "numberOfInstallments": 123,
        "firstDueDate": "2023-12-25",
        "fund": "fund_637b85aaa8e91c82fd053aac",
        "product": "prod_637cf14e316408250c0bd067",
        "description": "<string>",
        "rebates": [
          {
            "feeType": "tac",
            "amountType": "absolute",
            "amount": 200,
            "description": "<string>"
          }
        ],
        "fine": {
          "fineRate": 0.02,
          "interestBase": "workdays",
          "monthlyRate": 0.02
        },
        "cashout": [
          {
            "amount": 123,
            "paymentMethod": "<string>",
            "type": "<string>"
          }
        ],
        "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
        "metadata": {},
        "createdAt": "2023-08-25T22:38:41.134Z"
      },
      "transactions": [
        {
          "amount": 123,
          "description": "<string>",
          "createdAt": "2023-12-25"
        }
      ],
      "attachments": [
        {
          "file": "file_6307b6c39f5d3d917009b631",
          "linkedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "context": {
        "ip": "<string>",
        "headers": {},
        "fingerprint": "<string>",
        "geolocation": [
          "<string>"
        ]
      },
      "history": [
        {
          "description": "<string>",
          "status": "open",
          "metadata": {},
          "createdAt": "2023-08-25T22:38:41.134Z"
        }
      ],
      "signatures": [
        {
          "signer": "<string>",
          "context": {
            "id": "sign_5f92f01728e009f403d8502e",
            "signedAt": "2023-12-25",
            "metadata": {},
            "context": {
              "ip": "<string>",
              "headers": {},
              "fingerprint": "<string>",
              "geolocation": [
                "<string>"
              ]
            }
          }
        }
      ],
      "amountRemaining": 1500,
      "amountForPayment": 1487.9,
      "isRefinancing": false,
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

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. Também é possível expandir as seguintes referências fora do contrato deste endpoint: installments. Para estes casos, é possível indicar um limite de registros a serem consultados, no seguinte formato: installments:40. Por padrão, este limite é de 10 registros.

customer

string

Um filtro com base no campo customer do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.

string

Um filtro com base no campo id do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.

company

string

Um filtro com base no campo company do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.

attachment

string

Um filtro com base no campo attachments.file do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.

status

enum<string>

Um filtro com base no campo status do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.

Available options:

open,

disbursed,

disbursing,

repaid,

void,

canceled,

expired,

pending

created_at_start

string

Um filtro com base no campo createdAt. O valor deve ser uma data.

created_at_end

string

Um filtro com base no campo createdAt. O valor deve ser um data.

external_id

string

Um filtro com base no campo external_id. O valor deve ser uma string.

payment_for

string

Campo para definir o dia de pagamento do boleto. Ao enviar este campo, será realizado um cálculo de valor presente (VP) para o dia de pagamento informado.

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:

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

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Loan` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de empréstimos.

hasMore

boolean

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

data

object[]

Uma lista de empréstimos

data.id

string

Identificador exclusivo para o objeto.

data.status

string

default:

open

Status do empréstimo

data.externalId

string

data.employment

string

Id do vinculo empregatício ou um objeto com os dados do vinculo empregatício nas operações de leitura quando usado o modo expand.

data.customer

string

Id do cliente ou um objeto com os dados do cliente nas operações de leitura quando usado o modo expand.

data.company

string

Id da empresa ou um objeto com os dados da empresa nas operações de leitura quando usado o modo expand.

data.contractNumber

string

Número do contrato

data.cashout

object[]

data.offer

object

Este objeto representa uma oferta de um empréstimo.

data.offer.id

string

Identificador exclusivo para o objeto.

data.offer.disbursementAmount

number

Valor solicitado

data.offer.installmentAmount

number

Valor da parcela.

data.offer.totalAmount

number

Valor total da dívida. Inclui tarifas, impostos, valor desembolsado, IOF, taxas e juros.

data.offer.interestAmount

number

Valor total dos Juros.

data.offer.iofAmount

number

Valor total do IOF (Imposto sobre Operações Financeiras).

data.offer.iofAdditionalAmount

number

Valor da taxa única da [alíquota adicional do IOF (Imposto sobre Operações Financeiras) (decreto 6.339/08).

data.offer.monthlyCET

number

Custo efetivo total ao mês. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

data.offer.yearlyCET

number

Custo efetivo total ao ano. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.a.

data.offer.monthlyFee

number

Taxa mensal. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2% a.m.

data.offer.yearlyFee

number

Taxa anual. O valor deve ser definido em base decimal, por exemplo, defina 0.12 para representar 12% a.m.

data.offer.insurance

object

Definição do seguro vinculado a oferta de empréstimo.

data.offer.interestType

string

Tipo de juros aplicado na dívida.

data.offer.creditOperationType

string

Tipo de operação de crédito

data.offer.expectedDisbursementDate

string

Data de desembolso no padrão ISO 8601

data.offer.interestGracePeriod

integer

data.offer.principalGracePeriod

integer

data.offer.numberOfInstallments

integer

data.offer.firstDueDate

string

Data do primeiro vencimento

data.offer.fund

string

Identificador que faz referência a um fundo.

data.offer.product

string

Identificador do produto no qual este empréstimo foi criado.

data.offer.description

string

data.offer.rebates

object[]

data.offer.fine

object

Definição de multa.

data.offer.cashout

object[]

data.offer.creditPolicy

string

Política de crédito utilizada para a oferta

data.offer.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.offer.createdAt

string

Data de criação do objeto

data.transactions

object[]

data.attachments

object[]

data.context

object

Informação do contexto da operação. Usado para segurança e formalização. IP, Headers, Fingerprint, and Geolocation

data.history

object[]

data.signatures

object[]

data.amountRemaining

number

Valor restante para pagamento, será apresentado caso seja informado o parâmetro payment_for.

data.amountForPayment

number

Valor para pagamento, será apresentado caso seja informado o parâmetro payment_for.

data.isRefinancing

string

Este campo informa se o empréstimo é um refinanciamento. Ele é preenchido automaticamente, levando em conta os dados do campo cashout, e não pode ser preenchido de forma manual.

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

data.updatedAt

string

Data de alteração do objeto

data.deleted

boolean

default:

false

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

Obter empréstimo Pesquisar empréstimos

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

{
  "hasMore": true,
  "data": [
    {
      "id": "loan_5f92f01728e009f403d8502e",
      "status": "open",
      "externalId": "4eeb7525-40c6-45fe-8236-2b731d740fad",
      "employment": "<string>",
      "customer": "<string>",
      "company": "<string>",
      "contractNumber": "AB123456789",
      "cashout": [
        {
          "amount": 123,
          "paymentMethod": "<string>",
          "type": "payment_method"
        }
      ],
      "offer": {
        "id": "offr_5f92f01728e009f403d8502e",
        "disbursementAmount": 123,
        "installmentAmount": 123,
        "totalAmount": 123,
        "interestAmount": 123,
        "iofAmount": 123,
        "iofAdditionalAmount": 123,
        "monthlyCET": 0.02,
        "yearlyCET": 0.12,
        "monthlyFee": 0.02,
        "yearlyFee": 0.12,
        "insurance": {
          "amount": 123,
          "fee": 0.02,
          "type": "required",
          "number": "<string>",
          "insurer": "<string>"
        },
        "interestType": "<string>",
        "creditOperationType": "<string>",
        "expectedDisbursementDate": "2023-12-25",
        "interestGracePeriod": 123,
        "principalGracePeriod": 123,
        "numberOfInstallments": 123,
        "firstDueDate": "2023-12-25",
        "fund": "fund_637b85aaa8e91c82fd053aac",
        "product": "prod_637cf14e316408250c0bd067",
        "description": "<string>",
        "rebates": [
          {
            "feeType": "tac",
            "amountType": "absolute",
            "amount": 200,
            "description": "<string>"
          }
        ],
        "fine": {
          "fineRate": 0.02,
          "interestBase": "workdays",
          "monthlyRate": 0.02
        },
        "cashout": [
          {
            "amount": 123,
            "paymentMethod": "<string>",
            "type": "<string>"
          }
        ],
        "creditPolicy": "crpl_637b85aaa8e91c82fd053aac",
        "metadata": {},
        "createdAt": "2023-08-25T22:38:41.134Z"
      },
      "transactions": [
        {
          "amount": 123,
          "description": "<string>",
          "createdAt": "2023-12-25"
        }
      ],
      "attachments": [
        {
          "file": "file_6307b6c39f5d3d917009b631",
          "linkedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "context": {
        "ip": "<string>",
        "headers": {},
        "fingerprint": "<string>",
        "geolocation": [
          "<string>"
        ]
      },
      "history": [
        {
          "description": "<string>",
          "status": "open",
          "metadata": {},
          "createdAt": "2023-08-25T22:38:41.134Z"
        }
      ],
      "signatures": [
        {
          "signer": "<string>",
          "context": {
            "id": "sign_5f92f01728e009f403d8502e",
            "signedAt": "2023-12-25",
            "metadata": {},
            "context": {
              "ip": "<string>",
              "headers": {},
              "fingerprint": "<string>",
              "geolocation": [
                "<string>"
              ]
            }
          }
        }
      ],
      "amountRemaining": 1500,
      "amountForPayment": 1487.9,
      "isRefinancing": false,
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false
    }
  ]
}

Referências

Authorizations

Query Parameters

Response