Atualização da doc #37 - 07/05/2024 a 03/06/2024

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

🆕O que há de novo

• Possíveis status do cartão: novo status

• DICT: novo evento, status e erro

• Boleto v1: novo evento e campo

🚀Alterações e melhorias

• Criação de pocket: remoção de valor no campo useCase

• Consulta de saldo bloqueado: objeto obsoleto

• Correção no fluxo de eventos de autorização

• Eventos de Boleto v1: descontinuação

• Mensagens de erros em inglês

• Descrição do campo documentNumber

🚧Problemas resolvidos

• Ajuste em payload de geração de token

🆕 O que há de novo

Possíveis status do cartão: novo status

Na página Possíveis status do cartão, adicionamos um novo status reversível, chamado LockedByATC, que pode ser alterado exclusivamente pelo Bankly. Confira!

DICT: novo evento, status e erros

O contexto de Pix e Dict passou pelas seguintes alterações:

• Na página de eventos, adicionamos um novo evento: PIX_CONCLUSION_DATE_WAS_COMPLETED.
• Nas páginas que tratam dos status de um pedido de portabilidade e reivindicação, acrescentamos um novo status : WAITING_VALIDATION. Navegue pela seção e confira a atualização.
• Em relação aos erros na subseção Diretório de Chaves Pix :
  • O erro INVALID_STATUS_TO_CANCEL_CLAIM foi alterado para INVALID_STATUS_TO_CANCEL_PORTABILITY_CLAIM.
  • Foram adicionados os erros INVALID_STATUS_TO_CANCEL_OWNERSHIP_CLAIM e CLAIM_COMPLETION_PERIOD_NOT_ENDED.
  • O erro INVALID_STATUS_TO_COMPLETE_CLAIM foi removido, e foram acrescentados dois novos: INVALID_STATUS_TO_COMPLETE_PORTABILITY e INVALID_STATUS_TO_COMPLETE_OWNERSHIP.

Boleto v1: desativação de rotas, novo evento e campo

O contexto de boleto v1 passou pelas seguintes alterações:

• Na página de eventos de boleto v1 foi acrescentamos o novo evento de cancelamento de boleto: BOLETO_WAS_CANCELLED;

• Incluímos o campo digitable nos seguintes eventos de boleto v1: BOLETO_WAS_REGISTERED, BOLETO_CASH_IN_WAS_RECEIVED e BOLETO_CASH_IN_WAS_CLEARED;

• Todas as rotas de endpoints referentes ao boleto V1 foram desativadas. Dessa forma, a seção Boleto não existe mais na versão 1 do Manual do dev.

🚀Alterações e melhorias

Criação de pocket: remoção de valor no campo useCase

Na documentação do APIs referente ao endpoint de Criação de pocket, removemos a opção ACCOUNT_FOR_UNDER_AGE a ser inserida no campo useCase. Agora somente é possível inserir os valores: CORPORATE_EXPENSES, FLEXIBLE_BENEFITS ou BALANCE_SEGREGATION.

Consulta de saldo bloqueado: objeto obsoleto

Nas documentações Consulta de Saldo bloqueado do Manual do dev e do APIs, informamos que o objeto balance.blocked está obsoleto e, portanto, deve ser desconsiderado, pois sempre retornará o valor zero.

Recomendamos que, para obter os dados do saldo bloqueado, o parceiro deve abrir um chamado no Service Desk ou utilizar os eventos de Webhook de bloqueio de saldo.

Correção no fluxo de eventos de autorização

Na documentação de eventos de autorização e confirmação, acrescentamos a informação de que o evento TRANSACTION_WAS_PROCESSED, assim como o evento VOUCHER_WAS_PROCESSED, pode ser disparado isoladamente.

Esta informação consta na descrição do evento e no callout abaixo do fluxo.

Descrição do campo documentNumber

Na documentação do endpoint de Abertura de conta, reformulamos a descrição do campo documentNumber. Esclarecemos que esse campo deve conter o número do CNPJ da empresa aprovado previamente no processo de Onboarding/KYC.

Eventos de Boleto v1: descontinuação

Na página de eventos de boleto v1, removemos os eventos BOLETO_WAS_CANCELLED_BY_RECIPIENT e o BOLETO_WAS_CANCELLED_BY_DEADLINE.

Mensagens de erros em inglês

Adicionamos as mensagens em inglês retornadas nos erros de todos os endpoints da seção de Pix.

🚧Problemas resolvidos

Ajuste em payload de geração de token

Na documentação de Geração de token, corrigimos o response de sucesso da requisição, que era indicado como um array de objetos, quando na verdade se trata de um objeto único.

Atenciosamente,

Time de Tech Writers