Atualização da doc #32 - 05/12/2023 a 02/01/2024
Olá! Confira as atualizações da documentação ocorridas no mês passado! 😉
🆕O que há de novo
🚀Alterações e melhorias
-
Remoção do tipo “free” das regras de juros, multas e descontos de Boleto v2
-
Número máximo de caracteres para emissão de boleto e geração de Pix QR Code
🚧Problemas resolvidos
- Visão geral- Webhook
- Correção na documentação Ambiente de sandbox X Produção
- Correção em nome de campo na documentação de boleto v2
- Ajuste na descrição de campos dos eventos de reivindicação de chaves Pix
🆕 O que há de novo
Evento de fatura
Na página de eventos de fatura do Manual do Dev, inserimos mais um evento do contexto invoice, chamado TRANSACTION_UPDATED. Além disso, também adicionamos a coluna de número máximo de caracteres nas tabelas de todos os eventos 😉
Consulta de limite de crédito v2
Agora esta funcionalidade possui uma nova versão, que não só possibilita a consulta do limite de crédito, como já era atendido na v1, mas também a consulta do limite de saque do cartão do cliente.
Em outras palavras, além do objeto invoice, contendo os campos referente ao limite de crédito do cartão, agora também é retornado o objeto withdrawal no payload de response.
A nova versão do endpoint de Consulta de limite de crédito está disponível na aba v2 do Manual do dev e no API’s. Para acessá-las, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página ou clique nos links acima.
Documentação sobre chave de idempotência (Idempotency-key)
O Manual do Dev agora conta com uma documentação específica para esclarecer o conceito de chave de idempotência (Idempotency-key), seu uso no Bankly e a lista de endpoints que utilizam esse mecanismo.
Confira a página Chave de idempotência (Idempotency-key) e obtenha mais informações!
Documentação sobre a Régua de cobrança
Lançamos a documentação Régua de cobrança, que detalha o funcionamento do mecanismo que auxilia nosso parceiro no controle do atraso de pagamentos em operações de crédito e na prevenção à inadimplência.
🚀Alterações e melhorias
Remoção do tipo “free” das regras de juros, multas e descontos de Boleto v2
Os objetos interest, fine e discount não apresentam mais o tipo (type) free, pois ele foi removido das regras de juros, multas e descontos de Boleto v2.
Consulta de limite de crédito v1
Devido ao lançamento da nova versão (v2) do endpoint Consulta de limite de crédito, inserimos um callout informando sobre as modificações realizadas na nova versão e indicando como acessar a documentação do novo endpoint.
Para mais informações, confira a documentação do endpoint de Consulta de limite de crédito v1.
Eventos de Pix
Incrementamos a descrição do objeto donor retornado no evento PIX_CLAIM_WAS_CANCELED. Agora, a descrição contém um aviso informando que, caso a reivindicação tenha sido cancelada por fraude, os campos referentes a este objeto não virão preenchidos.
Erros - Pagamento de contas
Nas documentações Validação do título e Confirmação do pagamento do Manual do dev, inserimos novos erros e atualizamos alguns existentes.
Além disso, também adicionamos a coluna “Mensagem” contendo as mensagens em inglês retornadas em cada erro. Confira!
Número máximo de caracteres para emissão boleto e geração de Pix QR Code
Atualizamos a documentação Emissão de boleto (v1 e v2), informando o número máximo de caracteres aceitos nos campos: payer.tradeName, payer.name, payer.address.addressLine e payer.address.city.
Também adicionamos o número máximo de caracteres na descrição do campo location.city nas documentações de emissão de QR Code estático e emissão de QR Code dinâmico.
Nova descrição de eventos Pix
Na documentação sobre os eventos de Pix, reelaboramos a descrição dos eventos PIX_CASHOUT_WAS_CANCELED e PIX_CASHOUT_WAS_UNDONE para tornar mais clara a diferença entre eles.
Limitações do ambiente de sandbox
Agora, a documentação Ambiente de sandbox X Produção conta com a tabela Limitações do ambiente de sandbox, que descreve todas as features que não podem ser testadas nesse ambiente e informa se há uma alternativa para a realização de testes.
🚧Problemas resolvidos
Visão geral - Webhooks
Na documentação Visão geral da seção Webhooks, corrigimos a ISO indicada no campo timestamp. A correta é ISO-8601.
Correção na documentação Ambiente de sandbox X Produção
A documentação Ambiente de sandbox X Produção apresentava duas URLs incorretas referentes ao ambiente de produção. Realizamos a sua correção e reformulamos a tabela de correspondência de URLs entre os ambientes, com o objetivo de facilitar a consulta e obtenção de informações.
Correção em nome de campo na documentação de boleto v2
Realizamos a correção da grafia do campo discount nas documentações Emissão de boleto e Consulta por authenticationCode, que trazia o nome desse campo no plural.
Ajuste na descrição de campos dos eventos de reivindicação de chaves Pix
Na documentação de eventos Pix, todos os eventos referentes à reivindicação de posse ou portabilidade tiveram a descrição dos campos conclusionLimitDate e ResolutionLimitDate ajustados.
Agradecemos a parceria no ano que passou e desejamos um maravilhoso e feliz 2024🎆,
Time de Tech Writers