Atualização da doc #34 - 06/02/2024 a 04/03/2024

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

🆕O que há de novo

• Documentações disponíveis nos Manual do Dev

• Erros – Mensagens em inglês

🚀Alterações e melhorias

• Evento de fatura – INVOICE_CLOSED

• Motivos de reprovação de registro

• Cartão - Consulta dos próximos status

• Informe de rendimentos v2

🚧Problemas resolvidos

• Parâmetro eventName

• Correção de nome de campo

• Correção do número máximo de caracteres

• Boleto V2

• Motivos de reprovação de registro

• Evento de fatura – licenseUuid

🆕 O que há de novo

Documentações disponíveis nos Manual do Dev

Lançamos as documentações dos endpoints de consulta de transações por cartão e consulta de chaves de uma conta no Manual do Dev. Anteriormente, elas estavam disponíveis apenas no APIs.

Erros – Mensagens em inglês

A nossa documentação está em constante evolução e uma das melhorias em andamento é o acréscimo das mensagens em inglês, retornadas nos erros, nas tabelas de erros de todas as páginas de endpoints.

Agora, mais seis seções possuem a coluna de mensagem em inglês. São elas:

• Gestão de crédito (V1);

• Offboarding;

• TED;

• Transações bandeiradas com cartões;

• Boletos V2;

• Pagamento de contas.

🚀Alterações e melhorias

Evento de fatura - INVOICE_CLOSED

Realizamos algumas alterações na documentação referente ao evento INVOICE_CLOSED. Confira:

• O que foi adicionado

O campo designatedFunding foi adicionado na tabela e no payload de exemplo e o objeto amountMinimal foi adicionado somente no payload de exemplo, pois já existia na tabela.

• O que foi retirado

Agora, no objeto paymentOptions[].paymentType, somente poderá ser retornado o tipo “CASH” ou “PARTIAL”. Nesse caso, o objeto paymentOptions[].refinancingCondition não será mais retornado e foi retirado da tabela e do payload de exemplo.

Motivos de reprovação de registro

Na página sobre os motivos de reprovação de registro, realizamos uma melhoria nos textos da coluna “Descrição” e “O que fazer?” referente ao motivo “DOCUMENT_RECUSED”.

Cartão - Consulta dos próximos status

Na documentação Consulta dos próximos status, do API’s e do Manual do Dev, incluímos a informação de que em casos de cancelamento, não será retornado nenhum valor no response (status code 204), pois, após cancelado, o cartão não possui próximos status.

Informe de rendimentos v2

Na documentação Informe de rendimentos v2, do API’s e do Manual do Dev, acrescentamos a informação de que o objeto netIncome somente será retornado caso a conta possua rendimentos.

🚧Problemas resolvidos

Parâmetro eventName

Na documentação do endpoint do Feed de eventos, adicionamos o campo opcional eventName, que era descrito apenas no Manual do Dev.

Correção de nome de campo

Na documentação Consulta por authenticationCode (v2), corrigimos o nome do campo Conciliation para a forma correta retornada, que é Conciliated.

Correção do número máximo de caracteres

Na documentação Emissão QR Code dinâmico, corrigimos para 35 o número máximo de caracteres que podem ser enviados no campo conciliationId.

Boleto v2

Na documentação Emissão de boleto v2, do API’s e do Manual do Dev, acrescentamos os seguintes campos: branch, number, documentNumber, amount, minimumAmount, createAt e updatedAt.

Além disso, retiramos o campo document e os objetos account, minimumAmount, amount e recipientOrigin.

Motivos de reprovação de registro

Na documentação Motivos de reprovação de registro, corrigimos a idade mínima para que ocorra a reprovação de um cliente no processo de Onboarding. Anteriormente estava como 16, mas o correto é 18 anos.

Evento de fatura - licenseUuid

Na documentação referente aos eventos de fatura, retiramos o campo licenseUuid dos seguintes eventos:

• TRANSACTION_CREATED;

• INVOICE_CLOSED;

• INVOICE_PAYMENT_OPTION_CREATED.

Atenciosamente,

Time de Tech Writers