Atualização da doc #35 - 04/03/2024 a 02/04/2024

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

🆕O que há de novo

• Eventos ACCOUNT_HOLDER_WAS_CREATED e ACCOUNT_HOLDER_WAS_CANCELED

• Novo callout na documentação de contas

• Novo endpoint: Alteração de data de vencimento da fatura do cartão

• Gestão de cartão: Novas tags

• Transações bandeiradas: Visão geral e novo fluxo

🚀Alterações e melhorias

• Novos payloads de eventos

• Doc ocultada no APIs: Envio de documentos com IDOne

• Mensagens de erros em inglês

• Confirmação do desafio 3DS: Novo callout

• Consulta de eventos em SDB

• Tabela de entryMode

• Alteração de status do cartão

🚧Problemas resolvidos

• Tipos de documento nos eventos de envio de imagens

• Criação de conta pocket

• Encerramento legal

• Transferência via TED: Descrição de campo e obrigatoriedade

• Eventos de Pix e Dict: objeto pixInitializationType

• Gestão de fatura: Consulta de fatura por ID

🆕 O que há de novo

Eventos ACCOUNT_HOLDER_WAS_CREATED e ACCOUNT_HOLDER_WAS_CANCELED

Disponibilizamos a documentação dos eventos ACCOUNT_HOLDER_WAS_CREATED e ACCOUNT_HOLDER_WAS_CANCELED, que comunicam, respectivamente, a criação do titular de uma conta e o encerramento do vínculo do titular da conta com a instituição financeira.

Novo callout na documentação de contas

Nas documentações de abertura de conta pessoa física e abertura de conta pessoa jurídica, adicionamos um callout informando nosso parceiro de que o evento ACCOUNT_HOLDER_WAS_CREATED confirma a conclusão do registro do cliente (pré-requisito para realizar a abertura de conta).

Novo endpoint: Alteração de data de vencimento da fatura do cartão

Na seção Gestão de cartões (subseção Configuração do cartão), adicionamos o endpoint de Alteração de data de vencimento, que permite que o cliente do parceiro Bankly altere a data de vencimento da fatura de seu cartão.

Confira a documentação disponível no Manual do dev e no Apis 😉.

Gestão de cartões: Novas tags

Na seção Gestão de cartões do Manual do dev, incluímos tags que indicam a usabilidade dos endpoints para cartões pré-pagos, pós-pagos ou ambos.

Transações bandeiradas: Visão geral e novo fluxo

Na seção de Transações Bandeiradas do Manual do Dev, adicionamos:

• Uma Visão Geral, fornecendo um panorama do conteúdo abordado na seção e explicando resumidamente o conceito da autenticação 3DS;

• A página de Autorização e Liquidação, que aborda os dois tipos de autorização, Base 1 e Base 2. Nesta documentação, explicamos essas etapas, as entidades envolvidas e outras características relevantes.

Possíveis status do cartão: novos status

Na documentação Possíveis status do cartão do Manual do dev, acrescentamos os seguintes status: LockedByPendingPayment (Bloqueio por falta de pagamento de fatura ou evento de bloqueio de crédito) e CanceledByDefaultingPayment (Cancelamento do contrato de crédito).

🚀Alterações e melhorias

Novos payloads de eventos

Alguns eventos apresentam variação nos campos retornados, de acordo com o contexto que os gerou (exemplo: tipo de transação, modalidade de cartão etc.). E, para que nosso parceiro possa conhecer todas as possibilidades de payloads que podem retornar para um mesmo evento, acrescentamos os exemplos nas seguintes documentações:

• Autorização e confirmação;

• Contas;

• Fatura.

Doc ocultada no APIs: Envio de documentos com IDOne

Devido a uma limitação na plataforma de hospedagem das documentações de APIs, não é viável exibir a documentação referente ao envio de documentos com IDOne diretamente nesta seção.

Portanto, a documentação desse endpoint está disponível exclusivamente no Manual do dev.

Mensagens de erros em inglês

Adicionamos as mensagens em inglês retornadas nos erros de todos os endpoints das seções:

• Gestão de cartões;

• Registro do cliente;

• Gestão da conta.

Confirmação do desafio 3DS: Novo callout

Na documentação Confirmação do desafio, acrescentamos um callout informando que o prazo máximo para responder ao desafio 3DS é de 5 minutos para transações web e 10 minutos para transações não web (por exemplo, aplicativos).

Consulta de eventos em SDB

Na documentação Ambiente de Sandbox X Produção, informamos que, ao fazer uma requisição no endpoint de consulta de eventos em ambiente de produção, o parceiro poderá informar o valor do proxy para obter informações sobre os eventos de cartão. Já em sandbox, a consulta por proxy não retornará eventos, visto que nesse ambiente não ocorrem movimentações reais com cartão.

Tabela de entryMode

Na documentação dos eventos de autorização e confirmação, acrescentamos uma lista com códigos do modo de entrada que podem ser retornados no campo entryMode.

Já na documentação de consulta de fatura por ID, acrescentamos a descrição de cada código de entryMode que já estava listado.

Alteração de status do cartão

Na documentação de possíveis status do cartão, separamos quais status o próprio parceiro Bankly pode alterar por meio do endpoint Alteração do status do cartão e quais são alterados exclusivamente pelo Bankly.

Como parte dessa atualização, revisamos a lista de opções disponíveis para o campo status na documentação do endpoint de Alteração do status do cartão, garantindo que apenas os status que podem ser modificados pelo parceiro sejam exibidos.

🚧Problemas resolvidos

Tipos de documento nos eventos de envio de imagens

Acrescentamos todos os valores que podem retornar no campo documentType dos eventos de envio de imagens para Onboarding (RG, SELFIE, CNH, CRNM, RNE e DNI).

Criação de conta pocket

A documentação sobre criação de conta pocket sofreu com instabilidades, mas já se encontra no ar novamente.

Encerramento legal

Ajustamos o texto que descreve o processo de encerramento legal de uma conta, informando que a comunicação ao CCS (Cadastro de Clientes do Sistema Financeiro) do Bacen pode ocorrer em até 30 dias após o encerramento técnico.

Transferência via TED: descrição de campo e obrigatoriedade

Na documentação Transferência via TED do Manual do Dev e do APIs , realizamos correções na descrição e removemos a obrigatoriedade do campo accountType. Agora, esclarecemos que o tipo de conta deve ser exclusivamente "CHECKING" ou "SAVINGS", e o campo tornou-se opcional. Se não for especificado, será automaticamente assumido o valor "CHECKING".

QR Code Dinâmico: limitação de caracteres

Na documentação Emissão de QR Code dinâmico , retiramos o número máximo de caracteres do campo payment.adress.city e inserimos a seguinte informação na descrição: “Obrigatório. Nome da cidade. Importante: Embora seja permitido ultrapassar 15 caracteres, ao ser decodificado, nomes de cidades com mais de 15 caracteres não serão exibidos integralmente.”

Adicionalmente, corrigimos o limite máximo de caracteres do campo payer.name, que anteriormente estava definido como 15, para o valor correto de 25.

Eventos de Pix e Dict: objeto pixInitializationType

Corrigimos alguns valores retornados no campo pixInitializationType da documentação de eventos de Pix e DICT que estavam escritos incorretamente (minúscula para maiúscula etc.).

Gestão de fatura: consulta de fatura por ID

Na documentação Consulta de fatura por ID do APIs, incluímos no response o objeto summary, que anteriormente estava disponível apenas no Manual do dev.

Atenciosamente,

Time de Tech Writers