Atualização da doc #36 - 03/04/2024 a 06/05/2024
Olá! Confira as atualizações da documentação ocorridas no mês passado! 😉
🆕 O que há de novo
-
Fatura – Novo objeto em Consulta de fatura por ID e evento INVOICE_CLOSED
-
Eventos de cartão – Novo evento: CARD_WALLET_TOKENIZATION_WAS_BLOCKED
🚀Alterações e melhorias
-
Eventos de Pix - Descrições dos eventos PIX_CASHOUT_WAS_CANCELED e PIX_CASHOUT_WAS_UNDONE
-
Eventos de pessoa jurídica MEI, EI, EIRELI ou SLU e LTDA, S.A. e TS
🚧 Problemas resolvidos
🆕 O que há de novo
Boleto v2 – Novos canais de pagamento
Na documentação Consulta por AuthenticationCode (Manual do dev e APIs), acrescentamos novos canais de pagamento de boleto - "PIX", "DCC" e "DigitalCorrespondentBanking".
Boleto v2 – Novo erro em Cancelamento de boleto
Na documentação cancelamento de boleto, acrescentamos mais um erro 400: BANKSLIP_INVALID_EXPIRATION_DATE - O boleto não pode ser cancelado após a data de vencimento (dueDate) ou data limite de pagamento (closePayment)
Fatura – Novo objeto em Consulta de fatura por ID e evento INVOICE_CLOSED
Na documentação Consulta de fatura por ID e no evento INVOICE_CLOSED , acrescentamos o objeto summary, que contém informações resumidas sobre a fatura.
Eventos de cartão – Novo evento: CARD_WALLET_TOKENIZATION_WAS_BLOCKED
Na página referente aos eventos de cartão, adicionamos um novo evento chamado CARD_WALLET_TOKENIZATION_WAS_BLOCKED, que sinaliza ao parceiro o bloqueio temporário do cartão para inclusão em carteiras digitais.
Carteiras digitais – Tokenização
Na Visão geral da seção Carteiras digitais, adicionamos informações sobre o fluxo de Tokenização. Confira!
🚀Alterações e melhorias
Eventos de Pix - Descrições dos eventos PIX_CASHOUT_WAS_CANCELED e PIX_CASHOUT_WAS_UNDONE
Na página referente aos eventos de Pix e DICT, melhoramos a descrição dos eventos PIX_CASHOUT_WAS_CANCELED e PIX_CASHOUT_WAS_UNDONE, para indicar com maior clareza o que cada um significa.
Nomenclatura do formato de datas (YYYY-MM-DDTHH:mm:SS.MMMZ)
Em toda a documentação, atualizamos as referências do formato YYYY-MM-DDTHH:mm:SS.MMMZ para ISO 8601 - UTC. Apesar da mudança de nomenclatura, o significado permanece o mesmo; apenas adotamos o termo técnico correspondente.
Boleto v2 - Emissão de boleto
Na documentação Emissão de boleto, acrescentamos as especificações dos parâmetros do objeto payer: o número máximo de caracteres que poderão ser enviados na requisição.
Pagamento de contas - Erros
Nas documentações Consulta por conta e por código de autenticação, alteramos o status code dos erros NOT_FOUND_BILL_PAYMENTS e NOT_FOUND_BILL_PAYMENT_BY_AUTHENTICATION_CODE para 404. Anteriormente estava como 400.
Webhooks - Consulta de mensagens enviadas
Nas documentações Consulta de mensagens enviadas do Manual do dev e do APIs, acrescentamos que nos campos startDate e endDate, além do formato padrão YYYY-MM-DD, também aceitamos o formato MM/DD/YYYY.
Motivos de reprovação de Onboarding - Descrição dos status
Na documentação Motivos de reprovação de Onboarding, aprimoramos a descrição dos motivos AGE_RECUSED e STATUS_RECUSED para que indiquem com precisão o que ocorreu e forneçam orientações mais detalhadas sobre como corrigir o erro.
Status do cartão
Na documentação Possíveis status do cartão e Alteração do status do cartão, incluímos uma nota destacando que os status LostOrTheftCanceled, CanceledByCustomer, TemporarilyUserLocked e Active podem ser alterados sem a necessidade de informar a senha.
Adicionalmente, na descrição do campo password do endpoint de Alteração do status, enfatizamos quais status exigem a obrigatoriedade deste campo.
Pockets – Idade mínima
Atualizamos a documentação da seção de Pockets especificando que a idade mínima para abertura de contas é 18 anos, e não 16 como constava anteriormente.
ID ONE - Consulta do status da análise
Na documentação Consulta do status da análise, destacamos que o parceiro deve implementar o header cache-control em sua aplicação, para definir o intervalo de tempo de pooling, visando um melhor desempenho entre cliente e servidor. Porém, reforçamos que o pooling deve ser evitado e que a configuração de webhooks deve ser priorizada para a obtenção de informações.
Eventos de pessoa jurídica MEI, EI, EIRELI ou SLU e LTDA, S.A. e TS
Na documentação de eventos de pessoa jurídica MEI, EI, EIRELI e SLU e LTDA, S.A. e TS, corrigimos o nome do contexto de “business” para “Business”, exibido na tabela Contexto e nome do evento.
Eventos de Pix e DICT
Na documentação Pix e DICT, esclarecemos que, embora a requisição de transferência via Pix seja realizada com sucesso, é possível que o processo não seja completado. Nesses casos, o valor retornará para a conta pagadora e o parceiro receberá o evento PIX_CASHOUT_WAS_CANCELED e/ou o evento PIX_CASHOUT_WAS_UNDONE, que indicarão no campo refusalReason a razão pela qual a transferência não pôde ocorrer.
Nessa mesma documentação, acrescentamos novos motivos de reprovação que podem retornar nesse campo.
🚧Problemas resolvidos
ID ONE - Consulta do status da análise
Na documentação Consulta do status da análise, atualizamos para refletir que o exemplo de payload é um array, não um objeto.
Eventos de TED
Na documentação dos eventos de TED, corrigimos a descrição do objeto sender, que se referia equivocadamente ao recebedor, ao invés de pagador.
Eventos de Cartão - CARD_WAS_ISSUED e CARD_WAS_EMBOSSED
Na documentação do evento CARD_WAS_ISSUED, corrigimos a descrição do campo proxy, que indicava erroneamente que esse campo pertencia ao objeto card. Na documentação desse mesmo evento e também do CARD_WAS_EMBOSSED, corrigimos a descrição do campo contractNumber, limitTotal, limitiTotal.value e limitiTotal.currency, que estavam descritos de forma equivocada como propriedades do objeto credit.
Atenciosamente,
Time de Tech Writers