Atualização da doc #28 - 08/08/2023 a 04/09/2023

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

🆕 O que há de novo

• Eventos de crédito
• Novos fluxos de eventos
• Nova documentação de status codes e de erros
• Novos erros relacionados ao certificado TLS
• Novos eventos de boleto

🚀Alterações e melhorias

• Fluxos de eventos
• Dados para registro de pessoa jurídica
• Objeto account nos eventos de autorização e confirmação
• Payloads dos eventos de PIX_CASH_IN_WAS_RECEIVED

🚧Problemas resolvidos

• Correção em scope de Pix
• Campo idempotencyKey no header dos eventos
• Emissão de segunda via (Cartões)
• QR Code dinâmico (Pix)
• Rastreio de cartões por proxy
• Campo paymentDate em evento de Pix

🆕 O que há de novo

Eventos de Crédito

No Manual do Dev, inserimos novos eventos na documentação de eventos de crédito. Confira a seguir:

• CREDIT_CARD_LIMIT_INCREASE_REQUESTED;

• CREDIT_CARD_LIMIT_INCREASE_ACCEPTED;

• CREDIT_CARD_LIMIT_REDUCTION_REQUESTED;

• CREDIT_CARD_LIMIT_REDUCTION_APPLIED.

Novos fluxos de eventos

A documentação de eventos de Autorização e confirmação e de eventos relacionados ao Envio de imagens para Onboarding agora possuem fluxos demonstrando a ordem em que os eventos ocorrem e qual a API que os dispara.

Nova documentação de status codes e de erros

Agora, a documentação dos status codes e dos erros apresenta uma nova disposição de informações.

Além disso, na documentação de erros, o parceiro encontrará seções destinadas a especificidades do erro 400 bem como a descrição de erros associados ao certificado TLS que podem retornar em todos os endpoints.

Novos erros relacionados ao certificado TLS

Novos erros referentes ao Download do certificado TLS foram mapeados. Por serem comuns a todos os endpoints que fazem uso do mTLS, esses erros também se encontram documentados na página que descreve os erros comuns de nossas APIs.

Novos eventos de boleto

Lançamos dois novos eventos de boletos:

BOLETO_WAS_CANCELLED_BY_RECIPIENT;

BOLETO_WAS_CANCELLED_BY_DEADLINE.

🚀Alterações e melhorias

Fluxos de eventos

Para melhor compreensão dos fluxos de eventos publicados no Manual do Dev, adicionamos o path da API que dispara cada evento (caso se aplique).

A atualização ocorreu nos seguintes fluxos publicados:

• Boletos;

• Cartão;

• Contas;

• Crédito;

• Fatura.

Dados para registro de pessoa jurídica

Acrescentamos um destaque nas documentações de registro de MEI, EI, EIRELI ou SLU e registro de LTDA, S.A. e TS para lembrar nossos parceiros de que as informações relacionadas ao CNPJ fornecido no momento do cadastro devem estar de acordo com os dados mais recentes da empresa, já que realizamos uma verificação em fontes públicas e privadas de informações. Havendo divergência, a análise será reprovada.

Objeto account nos eventos de autorização e confirmação

Realizamos a documentação do objeto account retornado em todos os eventos de Autorização e confirmação (Authorization).

Payloads dos eventos de PIX_CASH_IN_WAS_RECEIVED

Dependendo do tipo de inicialização do Pix, os eventos podem sofrer alterações em sua estrutura, apresentando ou não certos campos e objetos. Por isso, detalhamos essas alterações na documentação do evento PIX_CASH_IN_WAS_RECEIVED, especificando quais são os campos e objetos retornados exclusivamente para Pix Manual, por QR Code e por chave.

🚧Problemas resolvidos

Correção em scope de Pix

Nas documentações de Emissão de QR Code estático do Manual do Dev e do APIs, corrigimos o scope indicado para o uso desse endpoint: pix.qrcode.create. Essa informação também foi ajustada na documentação geral de scopes.

Campo idempotencyKey no header dos eventos

A documentação Visão geral da seção de eventos não trazia o header idempotencyKey, presente em todas as mensagens enviadas via webhooks. Realizamos o acréscimo dessa informação.

Emissão de segunda via (Cartões)

Na documentação Emissão de segunda via, incluímos a obrigatoriedade do campo description. A correção foi feita tanto no Manual do dev quanto no APIs.

QR Code dinâmico (Pix)

Na documentação Emissão de QR Code dinâmico do Manual do Dev, acrescentamos dois erros 400:

• QRCODE_ALREADY_EXISTS;

• INVALID_QRCODE_PAYLOAD.

Rastreio de cartões por proxy

A documentação de rastreio de cartões por proxy apresentava uma descrição imprecisa da razão Cancelled na lista de reasons. A descrição foi corrigida.

Campo paymentDate em evento de Pix

A documentação do evento PIX_CASH_IN_WAS_RECEIVED apresentava a descrição do campo paymentDate, que não retorna nesse evento. Realizamos a sua exclusão.

Atenciosamente,

Time de Tech Writers