Atualização da doc #38 - 03/06/2024 a 01/07/2024

Olá! Confira as atualizações da documentação ocorridas no mês passado! 😉

🆕O que há de novo

🚀Alterações e melhorias

🚧Problemas resolvidos

🆕 O que há de novo

Feedback para a documentação do Bankly

A partir de agora, nosso parceiro pode registrar observações e sugestões sobre a documentação do Bankly diretamente na plataforma, por meio do botão feedback.

Para isso, dentro da página que deseja avaliar, siga o passo a passo:

  1. Do lado direito da tela, clique no botão azul feedback;
  2. Escolha o emoji que corresponde ao seu sentimento em relação ao conteúdo;
  3. Deixe um comentário e, se desejar, utilize a ferramenta que destaca a parte do texto sobre a qual quer comentar.

Sua opinião é muito importante para a evolução do nosso conteúdo!

Cartão - Acréscimo do objeto funcionalities nos endpoints de consulta

Na seção Gestão de cartão do Manual do dev e do APIs, adicionamos o objeto funcionalities no response dos seguintes endpoints:

Essa adição visa aprimorar a resposta dos endpoints, pois fornece mais informações sobre as modalidades vinculadas ao cartão consultado.

Crédito - Novo evento de desbloqueio de contrato CRELIQ

Na documentação sobre eventos de Crédito, adicionamos um novo evento chamado CREDIT_CONTRACT_CRELIQ_CANCELMENT_REQUESTED, que notifica o início do cancelamento do contrato de crédito por meio do processo CRELIQ.

Essa adição modificou o fluxo de eventos no cenário de inadimplência. Confira!

Além disso, incluímos um callout no início da documentação de eventos de crédito explicando o funcionamento do processo CRELIQ.

Gestão de fatura v1 e v2 - Adição de novos erros

No Manual do dev, adicionamos novos erros relacionados ao processo de CRELIQ. Confira as documentações:

Gestão de crédito - Nova seção e evento de Pré-análise

Na documentação Gestão de crédito, adicionamos mais uma subseção referente ao processo de pré-análise. Confira as novas documentações:

Além disso, adicionamos novos eventos relacionados à pré-análise:

Devido à adição de novos eventos, também criamos um fluxo de eventos específicos para demonstrar a ordem em que eles ocorrem. Confira!

Período para emissão de boletos

Na documentação do endpoint de Emissão de boletos, informamos que não é possível realizar a emissão de boletos das 5h25 às 6h05, pois este é o período de sincronização de nosso sistema com o fornecedor. Caso haja tentativa de emissão dentro desse intervalo, será retornado o erro 400 - ISSUANCE_BANKSLIPS_CLOSED - Bankslip issuance is not allowed at this time.

🚀Alterações e melhorias

Alterações em eventos de crédito

Na documentação sobre os eventos de crédito, no evento CONTRACT_CREDIT_BLOCK_REQUEST_CREATED, adicionamos o campo reason (que pode retornar os valores “PRE_CRELIQ” ou “LACK_OF_PAYMENT”) .

No evento CONTRACT_CREDIT_CANCELLMENT_REQUESTED, incluímos os campos daysInDelay e paymentDeadline.

TED - Especificações para TED interno

Na documentação Recebimento de valores via TED, informamos que o TED interno ocorre quando a conta remetente e a conta destino pertencem à licença 332. Essas transações podem ser realizadas 24/7 pelos clientes.

Entretanto, a devolução (refund) só ocorre para transações de TED externo, ou seja, quando a conta destino pertence a outras instituições.

Gestão de cartão - Novo callout

Na documentação Definições, no espaço dedicado à explicação das modalidades de um cartão, adicionamos um callout informando que cada modalidade pode ser vinculada a um programa específico.

Eventos de autorização e confirmação

Adicionamos um callout nos eventos CONFIRMATION_WAS_PROCESSED e CANCELATION_WAS_PROCESSED, informando que, para identificar se a transação descrita no evento se trata de uma entrada (cash-in) ou saída (cash-out) de dinheiro, o parceiro deverá consultar o campo channel.transactionType.description.

Já no evento TRANSACTION_WAS_REVERTED, inserimos um destaque informando que, por meio do entityId do evento, o parceiro consegue identificar a transação que foi revertida.

Além disso, sinalizamos no fluxo de eventos quais são os eventos de base 1 e base 2. Confira!

Pagamento de contas – Novo erro

Na documentação Validação do título, incluímos o erro 400 - ASSIGNOR_NOT_AUTHORIZED, que significa que a linha digitável não está autorizada no convênio correspondente.

Onboarding - Atualização do diagrama de sequência

Atualizamos o diagrama de sequência que descreve todo o processo de Onboarding de pessoa física.

Status de aprovação de imagens

Na Visão geral sobre o ID One, adicionamos uma seção que descreve os status que indicam a aprovação de uma imagem.

Tempo para conclusão do Onboarding

Na Visão geral sobre o ID One, esclarecemos que a selfie deve ser enviada ao Bankly dentro do intervalo máximo de 10 minutos, contando a partir do momento da captura da foto, devido ao tempo de expiração do token JWT. Porém, após o envio da selfie, não há limite de tempo para finalizar o Onboarding.

🚧Problemas resolvidos

Gestão de cartão - Consulta de transação por cartão

Na tabela Status da transação, corrigimos a descrição do status TransactionVoucherWasCreated para: “O voucher (crédito) foi lançado na conta do cliente”.

Registro de LTDA, S.A. e TS – Valores do campo businessSize

Na documentação Registro de LTDA, S.A. e TS, corrigimos os possíveis valores do campo businessSize para: SMALL (faturamento até R$ 4,8 milhões por ano), MEDIUM (faturamento acima de R$ 4.8 milhões até R$ 20 milhões por ano) e LARGE (faturamento acima de R$ 20 milhões no ano).

Descrição de campo em eventos de cartão

Nos eventos CARD_WAS_EMBOSSED e CARD_WAS_ISSUED, adicionamos o campo program.name, que ainda não tinha havia descrito nessa documentação. Esse campo também foi adicionado nos eventos de carteiras digitais, no entanto, informamos que cartões antigos podem não ter essa informação armazenada em seus dados.

Descrição do campo functionalities[].status

Na documentação de eventos de cartões, corrigimos a descrição do campo functionalities.status para “Situação da modalidade, a qual pode ser Enabled (ativado), Disabled (desativado), Blocked (bloqueado) e BlockedByContract (bloqueado por contrato).

Atenciosamente,

Time de Tech Writers