InstitucionalBlogService DeskStatus Page
Back to All

Atualização da doc #31 - 07/11/2023 a 04/12/2023

5 months ago by Cristina Zordan Fraracio

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

Boleto v2

Lançamos uma nova versão do nosso produto de boleto, em parceria com o Banco BV, quinto maior banco privado do Brasil. Essa nova versão traz uma série de novidades e melhores condições comerciais, que vão tornar a sua experiência ainda mais completa e eficiente.

Consulte a documentação de boletos para obter mais informações.

FAQ

Com o objetivo de sanar dúvidas recorrentes e dar mais autonomia aos nossos parceiros no processo de integração, desenvolvemos uma FAQ para o Manual do Dev.

A FAQ conta atualmente com dez questões, porém, nosso objetivo é alimentar essa documentação com as respostas para dúvidas frequentes que possam aparecer ao longo do tempo.

Fluxograma de eventos

Na seção Eventos de webhooks, adicionamos mais três fluxogramas demonstrando a ordem em que os eventos de cada contexto ocorrem. Confira os novos fluxos:

Pix - QR Code

Acrescentamos novos exemplos dos payloads referentes à resposta do endpoint de Decodificação de QR Code estático e dinâmico. Agora, esta documentação contempla payloads para casos de decodificação de QR Code dinâmico-saque, estático-saque e dinâmico-troco.

🚀Alterações e melhorias

Alteração de mensagens de erros – consulta de chaves Pix

Na documentação Consulta de chaves para transferência, as mensagens dos erros INTERNAL_ERROR e REQUEST_TOOK_TOO_LONG_TO_RESPOND sofreram alteração.

Descrição do campo changeAmountType

Na documentação de Emissão de QR Code dinâmico (Manual do Dev e APIs), complementamos a descrição do campo changeAmountType, esclarecendo que, caso o campo seja preenchido com “ALLOWED”, não é necessário preencher o campo amount, que assumirá automaticamente o valor "0", permitindo a alteração do montante no momento da transação. Se o valor "NOT_ALLOWED" for informado, o campo amount deverá ser preenchido obrigatoriamente com o valor a ser transacionado.

Criação de análise de crédito

Na documentação de Criação de análise de crédito do Manual do dev e do API’s, alteramos/adicionamos as seguintes informações na requisição do endpoint:

  1. Adicionamos o objeto SCR (propriedades: collectedAt e authorized);

  2. No objeto phone, alteramos o nome da propriedade type para phoneType;

  3. No campo programID deverá ser inserido um valor inteiro.

Eventos de TED

Na página específica referente a eventos de TED, modificamos a descrição dos eventos TED_CASH_OUT_WAS_CANCELED e do TED_CASH_OUT_WAS_UNDONE.

Pix - DICT

Na documentação Consulta de chaves para transferência, inserimos a seguinte frase dentro de um callout preexistente de atenção:
”Para mais informações, consulte a documentação Manual Operacional do Diretório de Identificadores de Contas Transacionais (DICT)”.

Pagamento de contas

Na seção de Pagamento de contas, realizamos algumas alterações/acréscimos. Confira:

  • Agora, a subseção referente às consultas de pagamento de contas se chama Consulta do status da transação;

  • A visão geral dessa subseção contém informações extras a respeito do processo de pagamento de contas;

  • Além disso, na página de Visão geral, acrescentamos um fluxo demonstrando a ordem em que a mudança do status da transação ocorre.

Gestão de cartão - Rastreio por proxy

Na documentação Rastreio por proxy, acrescentamos um callout informando que é possível a transição do status “Created” para “InProgress” após 5 dias. O mesmo se aplica ao status “Building”.

Pagamento de contas

Na documentação Validação do título, acrescentamos/alteramos as descrições de alguns erros. São estes:

  • BAR_CODE_NOT_FOUND;

  • PARTIAL_PAYMENT_LIMIT_HAS_EXCEEDED;

  • DUPLICITY_PAYMENT;

  • PAYMENT_ALREADY_PERFORMED.

Além disso, adicionamos uma nova coluna (mensagem), com as mensagens em inglês retornadas pela API.

Rate limiting

Para tornar mais clara a política de rate limiting do Bankly, reestruturamos a documentação sobre esse tema.

Simulação de reconhecimento de pedido de reivindicação

Disponibilizamos novamente o endpoint de simulação de reconhecimento de pedido de reivindicação (acknowledgement) para que o parceiro possa simular o fluxo completo de reivindicação de posse ou portabilidade de chaves.

Limitação de caracteres para campo assertedIncome.value

Nas documentações Registro de pessoa física e Atualização cadastral, informamos que o campo value (propriedade do objeto assertedIncome) aceita como mínimo o valor: 0.00 e o como máximo o valor: 99999999999999.99.

🚧Problemas resolvidos

Campo faltante em eventos de Pix

A documentação de eventos Pix e DICT apresentava alguns eventos que não descreviam o campo value (propriedade do objeto amount), embora ele estivesse presente nos payloads . Acrescentamos a descrição desse campo nas tabelas.

Adição do erro 429 em transferência via TED, Pix e Pagamento de contas

Na documentação de Transferência via TED, Transferência via Pix e Pagamento de contas acrescentamos o erro 429- TOO_MANY_REQUESTS, referente ao excesso de requisições permitidos para o endpoint (rate limiting).

📘

Nota

O erro não foi acrescentado nas respectivas páginas do Manual do Dev, pois se trata de um erro comum.

Eventos de webhooks - Visão geral

Na documentação Visão geral da seção Eventos de webhooks, acrescentamos alguns contextos faltantes, com informações gerais sobre o contexto e seus respectivos eventos. São estes:

  • DICT;
  • Pocket;
  • Partner.

Além disso, acrescentamos eventos que faltavam em contextos existentes, como Pix, crédito, boleto e pagamento de contas.

Atenciosamente,

Time de Tech Writers