Atualização da doc #42 - 05/10/2024 a 04/11/2024

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

🆕O que há de novo

• Novas documentações sobre Open Finance

🚀Alterações e melhorias

• Pagamento de contas - status code de erros
• Alterações em eventos de crédito
• Publicação da documentação de limites transacionais

🚧Problemas resolvidos

• Simulação de parcelamentos de fatura - datas
• Pagamento de contas - status code de erros
• Eventos de fatura - version e metadata
• Correção em códigos de erros em documentação de cartões
• Simulação de parcelamento de fatura - correção de link

🆕 O que há de novo

Novas documentações sobre Open Finance

Lançamos as documentações referentes aos novos endpoints do sistema Open Finance:

• Geração do ticket de acesso ao WebView;
• Gestão de consentimentos.

Além disso, realizamos melhorias nas documentações anteriormente publicadas. Não deixe de conferir!

🚀Alterações e melhorias

Pagamento de contas - status codes de erros

Atualizamos os status codes de erro em alguns endpoints da documentação de pagamento de contas. Confira as mudanças abaixo:

• Validação do título
  Os erros TRANSACTION_NOT_FOUND e BAR_CODE_NOT_FOUND, que anteriormente retornavam o status code 400, agora retornam 404.
• Confirmação do pagamento
  Os erros QUERY_ID_NOT_FOUND e TRANSACTION_NOT_FOUND passaram de 400 para 404.
• Consulta de transação por conta
  O erro NOT_FOUND_BILL_PAYMENTS, que antes retornava 400, agora retorna 404.
• Consulta de transação por código de autenticação
  O erro NOT_FOUND_BILL_PAYMENT_BY_AUTHENTICATION_CODE foi alterado de 400 para 404.

Essas mudanças alinham o retorno dos status codes com a semântica de erros específicos não encontrados, oferecendo respostas mais consistentes para os endpoints de pagamento de contas.

Alterações em eventos de crédito

• O campo reducedLimit passou a se chamar decreasedLimit no evento CREDIT_CARD_LIMIT_REDUCTION_APPLIED.
• Foram adicionados dois novos objetos no evento CREDIT_CARD_LIMIT_INCREASE_ACCEPTED: o previousLimit (objeto que contém informações sobre o limite anterior do cartão, antes de ser alterado) e o increasedLimit (objeto que contém informações sobre o valor que foi adicionado ao limite anterior).

Publicação da documentação de limites transacionais

A documentação de limites transacionais, antes disponível apenas no APIs, agora também se encontra no Manual do Dev:

• Visão Geral;
• Consulta de limite por feature;
• Criação e atualização de limite personalizado.

🚧Problemas resolvidos

Simulação de parcelamentos de fatura - datas

Na documentação de Simulação de parcelamentos de fatura, atualizamos todos os exemplos de datas para o formato: "2025-04-28T00:00:00+00:00". Além disso, simplificamos a descrição do formato de data, especificando apenas "ISO 8601" em vez de "ISO 8601 - UTC".

Pagamento de contas - Status code de erros

Realizamos atualizações nas documentações dos endpoints de pagamento de contas para garantir que os erros apresentados reflitam exatamente os retornos atuais do sistema. Veja as alterações realizadas:

• Validação do título
  • Removido:
    • Status code 404 - NOT_FOUND: "Bill Payment transaction not found for supplied Id".
• Confirmação do pagamento
  • Adicionado:
    • Status code 404 - NOT_FOUND: "Bill Payment transaction not found for supplied Id".
• Consulta de transação por conta
  • Adicionado:
    • Status code 400 - MISSING_COMPANY_KEY: "A company key was not provided for this request.".
• Consulta de transação por código de autenticação
  • Adicionado:
    • Status code 400 - MISSING_COMPANY_KEY: "A company key was not provided for this request.".

Eventos de fatura - version e metadata

Realizamos ajustes nos payloads contidos na documentação de eventos de fatura para corrigir o tipo do campo version e o valor exibido no campo metadata.closed.

Alteramos o tipo de todos os valores em version de integerpara string, e também atualizamos as datas de metadata.closed para o formato sem GMT, como em "2024-07-27T00:00:00".

Correção em códigos de erros em documentação de cartões

Na documentação Alteração da data de vencimento, disponível dentro da seção de cartões, corrigimos os códigos dos dois erros 409, que agora são:

Simulação de parcelamento de fatura - correção de link

Na documentação Simulação de parcelamentos de uma fatura, corrigimos o link que redireciona o usuário ao API Reference.

Atenciosamente,

Time de Tech Writers