Atualização da doc #26 - 13/06/23 a 11/07/23

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

O que você irá encontrar aqui:

🆕 O que há de novo

• Pix
• Scopes
• Gestão de faturas
• Boleto

🚀Alterações e melhorias

• Navegação
• Erros (APIs)
• Encerramento de conta
• Eventos de Webhooks
• Pagamento de contas

🚧Problemas resolvidos

• Atualização do conteúdo
• Autenticação e autorização (mTLS/DCR)
• Eventos

🆕 O que há de novo

Pix

Na documentação Transferência via pix, adicionamos uma nova coluna (Mensagem) contendo a mensagem em inglês referente ao status de erro retornado.

Scopes

A página de scopes, a qual reúne todos os scopes do Bankly, sofreu algumas modificações. Confira:

• Scopes adicionados:

  • card.pci.token.create;
  • customer.update;

• Scope alterado:

  • Dekyc.document.write para kyc.document.deepface.write.

Gestão de faturas

Adicionamos um novo código na tabela Códigos dos tipos de transação, o CREDIT_VOUCHER_INTER ( Voucher de Crédito para transações Internacionais), na página Consulta de fatura aberta do Manual do Dev.

Boleto

Na documentação dos endpoints Consulta por authenticationCode e Consulta por data, adicionamos um novo campo retornado barcode, que traz o número do código de barras do boleto.

🚀Alterações e melhorias

Navegação

• Com o objetivo de melhorar a navegação do parceiro pelas diferentes seções do Portal do desenvolvedor, agora, todas as páginas do API Reference possuem links para a sua respectiva documentação no Manual do Dev, na qual é possível encontrar as regras de negócio relativas ao endpoint consultado.
• Nas páginas do Manual do Dev, adicionamos links que direcionam o usuário para os eventos correspondentes ao endpoint documentado.
• Agora, a página referente ao endpoint de rastreio de cartões por proxy, presente no Manual do dev, se encontra em uma página separada chamada Por proxy, que está contida na seção Rastreio de cartão.
• A seção de Onbording encontra-se mais concisa, com foco no passo a passo sobre como realizar esse processo para pessoas física e jurídica. O parceiro encontrará os links para as documentações dos endpoints necessários para cada etapa.
• O ID One agora possui um menu exclusivo para detalhar as características e funcionalidades que o produto oferece.

Erros (APIs)

Com o objetivo de melhorar a compreensão, alteramos o nome dos erros exibidos na lateral direita das páginas contidas no APIs. Exemplo: O erro 404 – ERRO COMUM agora é 404 – RECURSO NÃO ENCONTRADO.

Encerramento de conta

Na página Encerramento de conta, inserimos um callout informando que, caso todas as contas sejam encerradas, o cliente será descadastrado automaticamente.

Eventos de Webhooks

Para melhorar a visualização dos exemplos de payloads dos eventos de webhooks, inserimos uma informação antes do botão de expandir.

Pagamento de contas

Na documentação Confirmação de pagamento, adicionamos um novo erro 400 (PAYMENT_AMOUNT_CANNOT_BE_CHANGED), que sinaliza que o valor do pagamento não pode ser alterado.

🚧Problemas resolvidos

Atualização do conteúdo

A seção APIs foi revisada e atualizada, de acordo com as informações presentes no Manual do Dev. Agora, as seções não apresentam divergências de conteúdo.

Autenticação e autorização (mTLS/DCR)

• Na página Registro dinâmico de client, corrigimos a descrição do campo registration_access_token_expires_in, informando que ele retorna o tempo (em segundos) após o qual o token de acesso do registro de client que foi criado irá expirar.
• A documentação Registro dinâmico de client (credencial) informava que era necessário enviar os campos certificate, key e passphrase no header das requisições. Excluímos essa orientação, porque esses campos estão embarcados no mTLS.

Eventos

Corrigimos o tipo dos campos metadata e data, de string para object, na Visão geral dos eventos de webhooks.

Atenciosamente,

Time de Tech Writers