Skip to main content
GET
/
v1
/
loans
Listar 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
    }
  ]
}

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.

​
id
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<date>

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

Example:

"2022-12-01"

​
created_at_end
string<date>

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

Example:

"2023-01-01"

​
external_id
string

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

Example:

"4eeb7525-40c6-45fe-8236-2b731d740fad"

​
contract_number
string

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

​
payment_for
string<date>

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

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.

​
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.

​
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. A parte de uma resposta da API que descreve a paginação

​
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
Loan · object[]

Uma lista de empréstimos