Atualização da doc #41 - 03/09/24 a 04/10/24

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

Open Finance: segunda fase

Para orientar o parceiro na implementação da segunda fase do Open Finance, disponibilizamos a seguinte documentação:

🚧

Importante

O parceiro deverá adequar seu sistema até 30 de outubro de 2024. Essa fase é crucial para garantir a conformidade com as normas regulatórias e assegurar a continuidade das nossas operações em conjunto.

Consulta de senha com criptografia

Publicamos a documentação referente à Consulta de senha criptografada, que permite que o cliente do parceiro Bankly consulte a senha do seu cartão por meio de comunicação criptografada. Confira:

Endpoint de Simulação de antecipação de parcelas

Agora, a seção Gestão de faturas contém uma nova subseção chamada Antecipação de Parcelas. Todas as informações relacionadas à antecipação de parcelas estão disponíveis nessa seção.

Atualizamos a Visão geral da seção e a documentação do endpoint de Confirmação de antecipação de parcelas. Além disso, incluímos a documentação de um novo endpoint para a Simulação de antecipação de parcelas.

As alterações no endpoint de confirmação, bem como o novo endpoint, também já estão disponíveis nas APIs. Confira: Simulação de antecipação de parcelas.

Eventos de fatura

No Manual do Dev, adicionamos novos eventos do contexto “Invoice”, conforme segue:

Endpoint v2: Consulta de fatura por ID

Na seção Gestão de faturas, da aba v2 do Manual, adicionamos a documentação referente a nova versão do endpoint de Consulta de fatura por ID.

Evento v2: INVOICE_CLOSED

Na página de eventos do contexto de “Invoice”, acrescentamos as informações referentes a nova versão do evento INVOICE_CLOSED.

Sistema de Liquidação de Cartões (SLC)

No Manual do Dev, adicionamos uma nova seção chamada Sistema de Liquidação de Cartões (SLC), contendo a visão geral do produto.

Além disso, o produto de SLC, contém uma página de eventos de webhook – SLC e outra página para a seção Feed de eventos – SLC. Confira!

🚀Alterações e melhorias

Acréscimo de motivo de reprovação Pix

Na documentação de eventos de Pix e DICT, adicionamos um novo motivo de reprovação que pode retornar no campo channel.refusalReason dos eventos PIX_CASHOUT_WAS_CANCELED e PIX_CASHOUT_WAS_UNDONE: BE17- QR Code rejeitado pelo participante do usuário recebedor.

Número de caracteres para ISPB

Para evitar erros nas requisições que requerem o envio do ISPB, campo que deve conter oito caracteres, orientamos aos parceiros que, em caso de ISPB com menos dígitos, sejam adicionados zeros à esquerda. Exemplo: o ISPB de um banco que contenha apenas seis dígitos deverá ser enviado do seguinte modo: "00123456".

Inclusão de erro em alteração de status de cartão

Na documentação Alteração do status do cartão (Manual do Dev e APIs), adicionamos o seguinte erro mapeado: 409 – CARD_CANCELED - O cartão informado já se encontra cancelado permanentemente.

Atualização da introdução do APIs

Atualizamos o conteúdo da página introdutória do APIs.

Consulta de fatura aberta e por ID

As documentações Consulta de fatura aberta e Consulta de fatura por ID foram atualizadas (Manual do Dev e APIs) da seguinte maneira:

Evento INVOICE_CLOSED v1

Na aba v1 do Manual do Dev, atualizamos o evento INVOICE_CLOSED e adicionamos o objeto nextStatement. Confira!

🚧Problemas resolvidos

Transferência via TED: ajuste na descrição de erro

Na documentação sobre o endpoint de Transferência via TED, ajustamos a descrição do erro 400 - CASHOUT_LIMIT_NOT_ENOUGH para “O pagador não tem limite de saque suficiente.”

Tipagem de campo do feed de eventos

Na documentação do Feed de eventos (Manual do Dev e APIs), corrigimos o tipo do campo eventName, que constava como string, quando, na verdade, se trata de um array of strings.

Descrição de campos nas documentações de emissão de cartões

Nas documentações referentes à emissão de cartões físicos, adicionamos a descrição dos seguintes campos faltantes:

  • x-bkly-license, que deve ser enviado nos headers das requisições (exceto para emissão de segunda via);
  • metadata, que deve ser enviado nos bodies das requisições (exceto para emissão de cartão múltiplo).

Evento PIX_CASHOUT_WAS_UNDONE

No exemplo de payload do evento PIX_CASHOUT_WAS_UNDONE, o tipo do valor exibido na propriedade metadata.requestedAt estava como string, porém o correto é number.

Evento CREDIT_CARD_CONTRACT_CANCELLED

Acrescentamos os campos faltantes na documentação do evento CREDIT_CARD_CONTRACT_CANCELLED: objeto credit, e os campos address.complement e status.

Cadastro de chaves - campo account.type

Na documentação do endpoint de Cadastro de Chaves, retiramos a obrigatoriedade do campo account.type, pois o seu envio é opcional.

Atenciosamente,

Time de Tech Writers