Atualização da doc #33 - 02/01/2024 a 05/02/2024
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
Gestão de boletos v2 - Novas páginas
Assim como os endpoints referentes à emissão de boleto, os endpoints de simulação e cancelamento de pagamento também estão na versão 2.0.
Para acessar a documentação destes endpoints, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página ou clique nos links abaixo.
-
Manual do dev (v2)
-
APIs (v2)
Rastreio de cartões - Novas reasons
Na documentação Rastreio por proxy, adicionamos duas novas reasons referentes aos status "Custody" e "Cancelled" de rastreio do cartão, sendo, respectivamente, “Returned” e “Destroyed”.
Eventos de fatura - Novos campos
Em todos os eventos de fatura, adicionamos os objetos “Program”, “contract” e “holder”.
🚀Alterações e melhorias
Realocação de eventos v2 – Contas e Pocket
Para que os eventos documentados ficassem organizados corretamente, transferimos os eventos na versão 2.0 que ainda estavam na aba v1 do Manual do dev, para a aba v2 deste Manual.
Confira abaixo os eventos v2 que foram realocados:
-
Contexto “Account”:
-
Contexto “Pocket”:
Para acessar a documentação destes eventos, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página ou clique nos links acima.
Registro de pessoa jurídica (LTDA, S.A. ou TS)
Na documentação Registro de LTDA, S.A. e TS, acrescentamos uma tabela de consulta contendo o código da natureza jurídica e sua descrição. Recomendamos utilizar a tabela para informar o valor correto no campo legalNature.
No API’s, inserimos essa informação em um enum no campo legalNature.
Além disso, tanto no Manual do dev quanto no API’s, inserimos um link para consulta na descrição do campo cnaeCode. O link deverá abrir a página do IBGE referente aos CNAES existentes e suas informações.
Informe de rendimentos v1 e v2
Na documentação de Informe de rendimentos v1, inserimos a tag “deprecated” (endpoint descontinuado) mais um callout informando sobre a nova versão da API.
Por outro lado, a documentação da nova versão (v2) do endpoint de Informe de rendimentos que antes estava localizada na aba v1 do Manual do dev e do APIs, agora se encontra na aba v2 das duas seções.
Para acessá-la, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página ou clique nos links abaixo.
Erros – Mensagens em inglês
A nossa documentação está em constante evolução e uma melhoria 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 três seções possuem a coluna de mensagem em inglês. São elas:
Gestão de boletos v1
Incluímos a tag "Deprecated" em todas as páginas da seção Gestão de Boletos, encontrada na aba v1 do Manual do dev e do APIs.
Além disso, acrescentamos um callout informando sobre a nova versão da API.
Pix troco
Na documentação Pix troco, seguindo a atualização do Bacen, alteramos o limite de valor para transações diurnas e noturnas. Confira!
Transferência via Pix
Na documentação Transferência via Pix, acrescentamos um callout informando que em caso de pessoa física, não existe limite noturno para transações entre mesma titularidade.
Pix - x-correlation-id
x-correlation-idRetiramos a obrigatoriedade do campo x-correlation-id em todas as páginas de endpoints da seção Pix.
Possíveis status do cartão
Na documentação Possíveis status do cartão, acrescentamos um callout informando que apenas o status "Active" permitirá transações com o cartão. Em todos os demais status, as modalidades do cartão (crédito, débito etc.) serão desabilitadas.
🚧Problemas resolvidos
Criação/atualização de limites personalizados
No API's, corrigimos o status code de sucesso da documentação Criação/atualização de limites personalizados. Estava como 200, mas o correto é 201.
Eventos – campo version
versionCorrigimos o tipo do campo version retornado na estrutura básica dos eventos de webhook. Em alguns payloads estava documentado como int, mas o correto é string.
Feed de eventos - Cartão
Na documentação referente aos eventos de cartão, corrigimos o nome de um dos motivos de negação da transação pela processadora. O motivo estava como "UNSAFETY_TRANSACTION_WITHOUT_VALIDATION_METHOD" e foi corrigido para "UNSAFE_TRANSACTION_WITHOUT_VALIDATION_METHOD".
Emissão de boleto v2
Na documentação Emissão de boleto (v2), ajustamos a descrição do tipo de juros percent para: Valor percentual por dia corrido (sem distinção de fins de semana e feriados).
Além disso, incluímos mais informações na coluna "Especificação" dos campos interest.value, fine.value e discount.value. Confira!
Envio de documentos com ID One
Na documentação de Envio de documentos com ID One, corrigimos o nome de um dos valores possíveis de serem informados no campo provider. Estava como UNICOCHECK, porém, o correto é UNICO_CHECK.
Eventos de webhook - Colchetes
Na documentação de todos os eventos, retiramos o colchete dos payloads de exemplo, pois eles somente são retornados em sandbox.
Importante
Reiteramos que, em situações de discrepância entre os ambientes, como o mencionado acima, a documentação adotará o ambiente de produção como referência para assegurar a integração adequada ao produto.
TOTP - Geração do hash e do código numérico
Na documentação Geração do hash e do código numérico (TOTP), corrigimos o tipo do campo data. Estava como string, porém, o correto é object.
Consulta de chaves para transferência e Transferência via Pix
Nas documentações Consulta de chaves para transferência e Transferência via Pix, corrigimos o tempo de duração do end2end, o qual é de 15 minutos.
Atenciosamente,
Time de Tech Writers