Pular para o conteúdo principal

Listar empréstimos

GET 
/v1/loans

Retorna todos os empréstimos, ordenados por data de criação, com os mais recentes primeiro.

Request​

Query Parameters

    expand string

    Expanda uma ou várias referências retornadas, separadas por vírgula. Para referências externas como installments, use installments:40 para definir o limite (padrão é 10).

    Examples:

    Valor único

    Example: employment

    customer string

    Filtre por customer do empréstimo usando uma string ou uma lista separada por vírgula.

    Examples:

    Valor único

    Example: cust_62ec27447e6959ce3872ecd6

    id string

    Filtre por id do empréstimo usando uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: loan_62ec27447e6959ce3872ecd6

    company string

    Filtre por company do empréstimo usando uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: comp_62ec27447e6959ce3872ecd6

    attachment string

    Filtre por attachments.file no empréstimo com uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: file_62ec27447e6959ce3872ecd6

    status string

    Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

    Filtre por status do empréstimo usando uma string ou uma lista separada por vírgula.

    Examples:

    Valor único

    Example: void

    created_at_start date

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

    created_at_end date

    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.

    contract_number string

    Filtre por contractNumber usando uma string ou lista separada por vírgula.

    Examples:

    Valor único

    Example: AB123456789

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

    Example: 2019-08-24
    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.

    Example: obj_5f92f01728e009f403d8502e
    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.

    Example: obj_5f92f01728e009f403d8502e
    limit integer

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

    Default value: 10
    Example: 10
    fields string

    Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

    Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

    Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

    deleted boolean

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

    Example: true

Responses​

Retorna um objeto com data contendo itens Loan a partir de starting_after. Se não houver mais itens, o array estará vazio. A solicitação nunca falha.

Schema

    hasMoreboolean

    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 empréstimos

  • Array [

    • idstring

    Identificador exclusivo para o objeto.

    Example: loan_5f92f01728e009f403d8502e
    statusstring[]

    Status do empréstimo

    Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

    Default value: draft
    Example: draft
    externalIdstring
    Example: 4eeb7525-40c6-45fe-8236-2b731d740fad
    employmentstring

    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.

    customerstring

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

    companystring

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

    contractNumberstring

    Número do contrato

    Example: AB123456789

    cashout

    object[]

  • Array [

    • anyOf

    Especificação para desembolso em conta bancária

    amountdoublerequired
    paymentMethodstringrequired
    typestringrequired
    Default value: payment_method

  • ]

    • offer

    object

    anyOf

    Este objeto representa uma oferta de um empréstimo.

    idstring

    Identificador exclusivo para o objeto.

    Example: offr_5f92f01728e009f403d8502e
    customerstring

    Identificador do cliente.

    Example: cust_5f92f01728e009f403d8502e
    employmentstringrequired

    Identificador do funcionário.

    Example: empl_5f92f01728e009f403d8502e
    companystringrequired

    Identificador da empresa.

    Example: comp_5f92f01728e009f403d8502e
    disbursementAmountdoublerequired

    Valor solicitado

    installmentAmountdouble

    Valor da parcela.

    totalAmountdoublerequired

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

    interestAmountdouble

    Valor total dos Juros.

    iofAmountdouble

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

    iofAdditionalAmountdouble

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

    monthlyCETdouble

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

    Example: 0.02
    yearlyCETdouble

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

    Example: 0.12
    monthlyFeedouble

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

    Example: 0.02
    yearlyFeedouble

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

    Example: 0.12

    insurance

    object

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

    amountdouble
    feedouble

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

    Example: 0.02
    typestring

    Possible values: [required, optional, uninsured]

    numberstring
    insurerstring
    interestTypestring

    Tipo de juros aplicado na dívida.

    creditOperationTypestring

    Tipo de operação de crédito

    expectedDisbursementDatedate

    Data de desembolso no padrão ISO 8601

    interestGracePeriodinteger
    principalGracePeriodinteger
    numberOfInstallmentsintegerrequired
    firstDueDatedaterequired

    Data do primeiro vencimento

    fundstringrequired

    Identificador que faz referência a um fundo.

    Example: fund_637b85aaa8e91c82fd053aac
    productstringrequired

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

    Example: prod_637cf14e316408250c0bd067
    descriptionstring

    rebates

    object[]

  • Array [

    • feeTypestring

    Tipo da tarifa.

    all_loans: utilizado para indicar tarifas ou taxas de manutenção em cada contratação. first_loan: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC). except_first_loan: utilizado para representar taxas de manutenção em cada contratação, exceto a primeira. insurance_premium: utilizado para representar tarifas de seguro.

    Possible values: [all_loans, first_loan, except_first_loan, insurance_premium]

    Example: first_loan
    amountTypestring

    Tipo do valor a ser cobrado.

    Possible values: [absolute]

    Example: absolute
    amountdouble

    Porcentagem da tarifa a ser cobrado sobre o valor do empréstimo.

    Example: 0.2
    descriptionstring

    Descrição para a tarifa.

    Example: Tarifa de cadastro

  • ]

    • fine

    object

    Definição de multa.

    fineRatedouble

    Valor percentual fixo da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

    Example: 0.02
    interestBasestring

    Contagem do tempo para multa (calendar para dias corridos)

    Possible values: [calendar_days]

    monthlyRatedouble

    Valor percentual mensal da multa. O valor deve ser definido em base decimal, por exemplo, defina 0.02 para representar 2%.

    Example: 0.02

    cashout

    object[]

  • Array [

    • anyOf

    Especificação para desembolso em conta bancária

    amountdoublerequired
    paymentMethodstringrequired
    typestringrequired
    Default value: payment_method

  • ]

    • creditPolicystring

    Política de crédito utilizada para a oferta

    Example: crpl_637b85aaa8e91c82fd053aac
    metadataobject

    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.

    createdAtdate-time

    Data de criação do objeto

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

    transactions

    object[]

  • Array [

    • amountdoublerequired
    descriptionstring
    createdAtdate

  • ]

    • attachments

    object[]

  • Array [

    • filestring
    Example: file_6307b6c39f5d3d917009b631
    linkedAtdate-time

  • ]

    • context

    object

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

    ipstring
    headersobject
    fingerprintstring
    geolocationstring[]

    history

    undefined[]

  • Array [

    • descriptionstring
    statusstring[]

    Status do empréstimo

    Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

    Default value: draft
    Example: draft
    metadataobject

    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.

    createdAtdate-time

    Data de criação do objeto

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

  • ]

    • signatures

    object[]

  • Array [

    • signerstring

    Signatário do empréstimo. Pode ser um customer ou operator.

    context

    idstring

    Identificador exclusivo para o objeto.

    Example: sign_5f92f01728e009f403d8502e
    signedAtdate
    metadataobject

    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.

    context

    object

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

    ipstring
    headersobject
    fingerprintstring
    geolocationstring[]

  • ]

    • insurance

    object

    proposalIdstring

    Identificador da proposta do seguro.

    saleIdstring

    Identificador da venda do seguro.

    cancellationIdstring

    Identificador do cancelamento do seguro.

    amountRemainingdouble

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

    Example: 1500
    amountForPaymentdouble

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

    Example: 1487.9
    isRefinancingstring

    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.

    Example: false
    metadataobject

    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.

    createdAtdate-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAtdate-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z
    deletedboolean

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

    Default value: false
    Example: false

    createdBy

    object

    clientIdstring

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientIdstring

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    appstring

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientIdstring

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientIdstring

    Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

    appstring

    Nome da aplicação que criou a assinatura.

    Example: backoffice

  • ]