Pular para o conteúdo principal

APIs

Setembro 2024​

Simulações de empréstimo sem a nencessidade de atualização do vínculo empregatício

Para facilitar a vida dos operadores, que em algumas situações precisavam fazer os cálculos de simulações de empréstimos manualmente, a API de Listar produtos elegíveis foi atualizada para receber os seguintes campos:

  • netSalary
  • grossSalary
  • hiredAt
  • limitPerloan
  • limitPerInstallment

Com a inclusão desses campos, é possível realizar simulações de empréstimo automaticamente, sem a necessidade de atualizar o vínculo empregatício. Essa melhoria visa facilitar o trabalho dos operadores, eliminando a necessidade de cálculos manuais em determinadas situações.

Melhoria na configuração dos provedores de notificação

O endpoint de Atualizar configurações agora possui uma lista de opções pré-definidas (Enum) para os campos Foi adicionado um Enum na API de settings para os campos settings.notifications.(email/sms/whatsapp).provider.

Isso foi implementado para evitar erros que ocorriam quando os usuários inseriam um provedor de serviço incorreto ou cometiam erros de digitação. Anteriormente, o campo aceitava qualquer texto, o que resultava em configurações inválidas. Com essa melhoria, o usuário pode escolher apenas entre as opções disponíveis, tornando o processo mais seguro e confiável.

Agosto 2024 (2)​

Novo evento transferência de vínculo empregatício

Receba notificações via webhook sempre que ocorrer uma transferência de vínculo empregatício.

Nome do novo tipo de evento adicionado: employment.transferred.

Para ver a lista de todos os tipos de eventos que enviamos via webhook, consulte nossa documentação: Tipos de eventos.

Tempo de vida do empréstimo

Para aprimorar nossos processos de contratação e desembolso, implementamos o conceito de tempo de vida ou time-to-live (TTL) para os empréstimos.

Na prática, isso significa que todos os novos empréstimos criados terão um prazo padrão de 15 dias para serem desembolsados. Caso o desembolso não ocorra nesse período, o empréstimo será automaticamente expirado.

É possível alterar o prazo padrão de 15 dias através do parâmetro loans.expireInDays no endpoint: Atualizar configurações.

nota

Essa implementação é automática e não exige nenhuma ação por parte de nossos clientes, aplicando-se apenas aos novos empréstimos.

Julho 2024 (3)​

Recurso de granulação na criação de chaves de API

A granulação de chaves de API refere-se ao nível de controle e especificidade com que as permissões e acessos são configurados para essas chaves. A granulação pode variar de ampla a muito detalhada.

Estamos liberando uma forma de especificar ainda mais a criação de chaves de API, permitindo a restrição de recursos como leitura e escrita de maneira ainda mais detalhada!

Para saber mais sobre o recurso de granulação na criação de chaves de API e como configurá-lo para utilizá-lo, consulte nossa documentação: Chaves de API.

Obtenha uma lista de itens deletados

Para obter uma lista de itens deletados, um novo filtro deleted foi adicionado nos seguintes endpoints:

Como utizar

Nos endpoints mencionados acima, basta definir o valor do filtro deleted como true para que os itens deletados sejam retornados.

Retorne mais de um ID de empréstimo na listagem de parcelas

Agora, no endpoint de Listar parcelas é possível que o filtro loan receba um conjunto de IDs seperado por vírgula.

Image

:::noteAteriomente era permitido apenas um ID.:::

Junho 2024 (3)​

Auditoria

Para fins de auditoria os campos createdBy e updatedBy foram implementados em todas nossas APIs.

A adição desses campos significa que todas as nossas APIS agora oferecem maior controle e rastreabilidade sobre as ações executadas, proporcionando mais transparência, segurança e facilidade de auditoria.

Essa melhoria faz parte do nosso compromisso contínuo em oferecer um sistema mais seguro e eficiente para nossos clientes.

Configuração de dias mínimos para refinanciamento

Implementamos a possibilidade de configuração do número mínimo de dias necessário para que uma proposta possa ser refinanciada.

nota

Anteriomente, o número mínimo de dias considerado era apenas o padrão, que são 90 dias.

Agora, é possível alterar o número padrão de dias através das:

É importante ressaltar que as configurações feitas por meio das APIs de configuração refletem o nível hierárquico global, enquanto as configurações realizadas nas APIs de empresa se aplicam ao nível hierárquico da empresa.

dica

Para obter mais informações sobre os níveis hierárquicos de configuração, consulte nossa documentação aqui.

Identificação de parcelas com valor pago excedente

Para ajudar na identificação de parcelas com valor pago excedente, adicionamos um novo filtro, o overpaid_installments no endpoint de Listar parcelas.

Image

A identificação de parcelas com valores pagos excedentes é uma grande ajuda para os operadores que lidam com cobranças e remanejamento de dinheiro. Confira o novo filtro e comece a utilizá-lo agora mesmo!

Maio 2024 (4)​

Novo tipo de permissão para operador

Foi adicionada a permissão backoffice_automation, agora disponível para uso em situações em que um operador necessita acesso apenas ao menu de automações do Backoffice.

Anteriormente, o acesso ao menu de automações era restrito aos operadores com a permissão administrator. A introdução deste novo tipo de permissão, que concede acesso somente ao menu de automações, não só flexibiliza as permissões, mas também evita a concessão desnecessária de privilégios de administrador.

Image

Para saber mais sobre os tipos de permissões de operadores, clique aqui

Campo de descrição nos hooks

Agora, ao criar um hook (ação) nas etapas da esteira, é possível fornecer uma descrição mais detalhada do que foi realizado durante esse processo.

Por exemplo, ao criar um hook para cancelar um empréstimo, uma descrição possível seria: "O empréstimo foi cancelado devido a uma falha na validação da assinatura".

Essa descrição auxilia não apenas na compreensão das funcionalidades dos hooks, mas também nas etapas da esteira como um todo, proporcionando uma visão mais clara e completa das operações realizadas.

Para saber mais sobre hooks, clique aqui

Novo filtro de nome nos endpoint de listagem

O filtro name foi adicionado nos seguintes endpoints:

A adição do filtro por nome aprimora e agiliza a busca na listagem de fundos, produtos, operadores, empresas e grupos de empresas.

Novo tipo de feeType da política de crédito

O tipo de tarifa except_first_loan foi adicionado nos endpoints de políticas de crédito.

Image

O except_first_loan indica que uma tarifa será cobrada para todos os empréstimos, com a excessão do primeiro.

Confira o novo tipo de tarifa except_first_loan nos endpoints: Criar política de crédito e Atualizar política de crédito.

Abril 2024 (15)​

Novos tipos de taxa na política de crédito

Houve uma mudança na configuração da política de crédito com relação as taxas de cobrança. Agora, ao definir os tipos de taxas o usuário primeiramente deve optar entre os dois diferentes tipos de taxa:

  • all_loans Todos os empréstimos - Significa que a taxa será combrada em todos os empréstimos.
  • first_loans Primeiro empréstimo - Significa que a taxa será cobrada apenas no primeiro empréstimo.

Image

Novo campo de valor máximo a ser desembolsado

O campo maximumDisbursementAmount foi adicionado nas regras da política de crédito e nele pode ser configurado o valor máximo que pode ser desembolsado em uma única transação.

Image

Confira os novos campos mencionados acima nos endpoints de: Criar política de crédito e Atualizar política de crédito

Fechamento de fatura PF considerando o campo daysUntilDue

A rotina de fechamento de fatura PF agora considera a configuraçõa do campo daysUntilDue.

Por exemplo: se a data autual for 19/04 e o daysUntilDue.amount=5, seriam criadas as faturas para todas as parcelas PF que vencem dia 24/04/2024.

Remova campos da resposta através do filtro fields

Através do filtro fields, que está presente em todos os nossos endpoints, é possível remover campos da resposta.

Por exemplo, para remover o campo id, digite: -id. Caso queira remover mais de um campo acrecente ,: -id, createdAt

Image

Recálculo de oferta

O recálculo de oferta ocorre automaticamente todas as vezes em que um novo vínculo empregatício é criado para um funcionário e quando a data prevista para o desembolso for menor que o desembolso.

Para saber mais sobre o recálculo de ofertas, quando e como ele ocorre, consulte a documentação: Recálculo de oferta

Melhoria na rotina de faturas recorrentes da empresa

A rotina de fechamento da fatura recorrente da empresa foi aprimorada para ser mais resiliente e para facilitar a identificação e o tratamento de possíveis erros.

Monitoramento de requisições externas

A partir de agora, sempre que nossa plataforma realizar uma requisição externa, um evento será publicado. Isso vale tanto para casos de sucesso quanto de erros. A publicação do evento possibilita uma melhor auditoria, permitindo identificar quais endpoints foram chamados, o que foi enviado, as respostas recebidas e o tempo de duração.

Melhoria no recálculo da oferta

Durante o recálculo da oferta, se a oferta recalculada for diferente da oferta atual, o status do empréstimo será alterado para pendente pela aplicação.

Para saber mais sobre o recálculo de ofertas, consulte a documentação: Recálculo de oferta

Configuração de refinanciamento e atencipação por fundo

Essa nova funcionalidade permite que nas configurações de um fundo seja possível sinalizar se o mesmo permite a funcionalidade de refinanciamento e atencipação.

Garantir que uma oferta só esteja associada a um empréstimo

Essa melhoria impede que uma oferta esteja associada a mais de um empréstimo. Caso haja tentativa de criação de um novo empréstimo com o mesmo ID de oferta, um erro será retornado.

Flexibilidade no uso de cache

Essa nova funcionalidade permite ativar ou desativar o uso de cache em chamadas de API. Anteriormente, por padrão, o uso estava sempre habilitado. Em alguns serviços, como os relacionados aos clientes, pode ser interessante desabilitar o uso de cache. Essa nova funcionalidade proporciona maior flexibilidade no gerenciamento de cache em nossos serviços.

Melhorias na rotina de faturas recorrentes

Foram adicionadas melhorias nas rotinas das faturas recorrentes, como novos filtros e alteração das datas e horários de execução. Essas melhorias proporcionam uma rotina mais precisa, rápida e abrangente para a criação de faturas recorrentes.

Novo endpoint com idempotência

O endpoint Criar link de arquivo está disponível para ser utilizado com o recurso de idempotência. Para saber mais sobre o que é, como funciona e quando utilizar a idempotência, consulte a documentação: Idempotência

Novo campo na Fatura para indicar o propósito de criação

O campo purpose foi adicionado à entidade invoice para indicar o propósito pelo qual uma fatura foi criada. A identificação do propósito facilita a determinação da origem de uma fatura, eliminando a necessidade de rastrear transações manualmente.

Image

Clique aqui para conferir o novo campo no endpoint de criação de fatura.

Melhorias de auditoria

Para fins de auditoria os campos created-by e updated-by foram criados nas seguintes entidades:

  • invoice
  • installments
  • invoice-items

A criação dos campos permite rastrear quem criou e quem atualizou uma fatura, parcela e item de fatura respectivamente. Os campos são preenchidos e salvos automaticamente.

Março 2024 (7)​

Evento sobre assinatura

Acompanhe todos os eventos relacionados à assinatura que ocorrem em nossa plataforma. Adicionamos três novos tipos de eventos relacionados à assinatura à nossa lista, que ocorrem de acordo com as seguintes ações:

  • Ocorre quando uma assinatura é criada
  • Ocorre quando uma assinatura é atualizada
  • Ocorre quando uma assinatura é deletada

Para conferir a lista completa de eventos, consulte a documentação: Tipos de eventos

Listagem de webhooks

Agora, clientes que assinam nossos webhooks conseguem listar todos os eventos relacionados aos mesmos. Tal melhoria permite que clientes acompanhem melhor todos os eventos enviados com detalhes como erros, horários, tentativas e etc.

Confira a listagem de webhooks está disponível através do endpoint: Listar webhooks

Novo filtro de busca de parcela por empresa

Foi adicionado um novo filtro na busca por parcelas, que permite que a busca seja feita por empresa.

Melhoria nos tipos de etapas da Esteira

O campo endedAt foi adicionado nas etapas da Esteira para indicar exatamente o momento que a etapa foi finalizada. Todas as vezes que o status da etapa mudar para falha ou concluído, o novo campo endedAt é preenchido. Essa melhoria permite um maior controle e monitoramento sobre os diferentes tipo de etapa da Esteira.

Verificação de biometria

Oferecemos aos nossos clientes a possibilidade de verificar a autenticidade dos dados dos funcionários que solicitam empréstimos através da verificação de dados biométricos. A coleta e análise biométrica são realizadas através da nossa integração com a UNICO, uma IDTech brasileira líder em identidade digital no Brasil.

Image

Para saber mais sobre como funciona e como é feita nossa integração com a UNICO para verificação de dados biométricos, consulte a documentação:
UNICO

Novo campo na entidade employment

O campo houseTime foi adicionado na entidade employment, através dele é possível saber há quantos meses o funcionário está trabalhando em sua atual empresa desde a data de contratação.

Migração da criação de documentos do empréstimo

Foi desenvolvida uma nova forma de criar os documentos relacionados ao empréstimos (CCB, assinatura e seguro). Anteriomente, a criação de documentos era feita via configurações do produto e acontecia durante a etapa de desembolso do empréstimo.

A nova forma de criação ocorre via um tipo de etapa de Esteira e permite que a criação de documentos ocorra em qualquer momento do fluxo de vida de um empréstimo. Para saber mais sobre a migração e sobre o novo tipo de etapa da Esteira desenvolvido para a criação de documentos, consulte as documentações:

Fevereiro 2024 (5)​

Criação do pacote de formalização

O pacote de formalização formalization_package é um arquivo que contém os documentos que definem o contrato de um empréstimo. O pacote contém os seguintes documentos: ccb, seguro e assinatura. A criação desse pacote possibilita que a formalização de um empréstimo seja mais completa e de acordo com as melhores práticas do mercado, além de facilitar o envio de documentos para as empresas financeiras responsáveis pelo desembolso.

Novo tipo de permissão para operadores

Foi criada a permissão backoffice_financial, que é específica para o time financeiro que utiliza os portais backoffice. Através dessa permissão é possível limitar e/ou restringir algumas funcionalidades para usuários admin ou que possuam essa permissão.

Novo tipo de evento disponível via webhook

O evento de temas agora também está disponível para ser utilizado via endpoint de webhook. Essa nova funcionalidade permite que os usuários sejam notificados em tempo real todas as vezes em que a troca de tema é realizada. Para consultar a lista completa com os tipos de evento que disponibilizamos, consulte a documentação: Tipos de eventos

Revisão dos tipos de evento dos Webhooks

Uma melhoria foi realizada para revisar e atualizar a documentação dos tipos de eventos dos Webhooks. Confira a lista atulizada aqui: Tipos de eventos

Melhoria na rotina de pagamento de fatura

A entidade Invoice possui o campo paidAt porém, o mesmo não era preenchido no momento do evento invoice.paid. Agora, com essa melhoria na rotina de pagamento de fatura, todas as vezes que uma fatura for paga o campo paidAt será preenchido com a data da última inteção de pagamento (boleto) paga.

Janeiro 2024 (5)​

Parametrização de desembolso

Possibilitamos a parametrização de dados de credenciais de desembolso para um de nossos clientes.

Idempotência

Agora você pode aplicar o conceito de idempotência em operações que gostaria de cerfiticar-se que sempre produzirá o mesmo resultado, independente do número de vezes que for chamada. Isto é particularmente crucial em ambientes onde chamadas de API podem ser repetidas devido a falhas de rede, timeouts ou outros problemas. Para saber mais, consulte a documentação: Idempotência

Campos solicitados

A funcionalidade de campos solicitados oferece flexibilidade na obtenção de dados, permitindo selecionar campos específicos de retorno. Esta característica é especialmente útil ao trabalhar com campos expandidos pois permite solicitar apenas os subcampos mais relevantes. Para mais informações, consulte a documentação: Campos solicitados

Auditoria

Para auxiliar em questões de auditoria, foi desenvolvido um recurso que permite identificar quem criou ou alterou um registro. Para saber mais, consulte a documentação: Auditoria

Hooks

Introduzimos nos passos da esteira os hooks, que são um conjunto de ações extras que ocorrem depois que um passo da esteira é executado. Para saber mais sobre hooks, como eles funcionam, as opções disponíveis e exemplos de casos de uso, consulte a documentação: Hooks