InstitucionalBlogService DeskStatus Page
Back to All

Atualização da doc #30 - 30/09/2023 a 06/11/2023

6 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

Visão geral para documentação de registro do cliente e feed de eventos

Seguindo o padrão das seções de produtos do Manual do Dev, desenvolvemos uma página destinada à visão geral para a documentação de registro do cliente e para a documentação do feed de eventos.

Novo objeto para valor da renda declarada do cliente

Atualizamos as documentações de registro de pessoa física (Manual do Dev e APIs) e de eventos de pessoa física incluindo o novo objeto assertedIncome, que irá substituir o campo declaredIncome a partir de 27/11/2023.

Esse objeto permite que os seus clientes incluam o valor da renda declarada/renda mensal no momento do cadastro, em vez da faixa de renda. Isso se deve a uma melhoria nos nossos processos de PLDFTT (Prevenção a Lavagem de Dinheiro e Financiamento ao Terrorismo), monitoramento de riscos, prevenção a fraude e atividades ilícitas.

Novo status nos eventos de reivindicação de chave Pix

Os eventos PIX_CLAIM_WAS_CONFIRMED e PIX_CLAIM_WAS_COMPLETED agora apresentam o staus ACCOUNT_CLOSED (encerramento de conta), que pode ser retornado no campo confirmReason.

Consulta de cartões

No Manual do dev, desenvolvemos as páginas dos endpoints referentes à nova seção Consulta de cartões, que anteriormente existia somente no API’s. As páginas são:

Eventos de habilitação/desabilitação de features

Documentamos os novos eventos do contexto de Partner, que disparam mensagens sempre que houver indisponibilidade em um ou mais serviços de uma feature, seja por motivo de manutenção, seja por algum problema interno em nosso sistema.

Canais de transmissão Pix

Disponibilizamos a documentação dos canais de transmissão do Pix. Esses canais são estruturas por onde as ordens de pagamento trafegam, de acordo com o tempo para a liquidação de cada transação.

Novo objeto na criação de análise de crédito

Documentamos o novo objeto scr, que deve ser enviado na requisição de criação de análise de crédito. Esse objeto de envio obrigatório contém informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito).

🚀Alterações e melhorias

QR Code dinâmico

Na documentação Emissão de QR Code dinâmico, acrescentamos um destaque informando que o campo expiresAt permite a definição do horário de expiração do QR Code, porém, a expiração efetiva ocorrerá somente no dia seguinte ao especificado.

Consulta de chave para transferência

Nas documentações Consulta de chave para transferência do Manual do dev e do API’s, acrescentamos o erro 408 - REQUEST_TOOK_TOO_LONG_TO_RESPOND - Request took too long to respond, wait 1 minute to try again.

Consulta de dados de uma conta

No campo code, no path da requisição do endpoint de Consulta de dados de uma conta, acrescentamos a informação de que o valor default é 332.

Também acrescentamos essa informação na documentação Consulta de dados de uma conta da seção API’s.

Transferência via Pix

Na documentação Transferência via Pix do Manual do dev e do API’s, especificamente na requisição referente ao Pix Manual, informamos que o campo recipient.name não aceita caracteres especiais.

Ambiente de SDB x PROD

Acrescentamos um destaque na documentação referente aos ambientes de Sandbox e Produção, informando que, em situações excepcionais, caso ocorra alguma discrepância entre os ambientes, a documentação adotará o ambiente de produção como referência para assegurar a integração adequada ao produto.

Novo erro mapeado em transferência via Pix

Na documentação sobre transferência via Pix, acrescentamos um novo erro mapeado, referente à data de expiração do QR Code:

  • 400 - INVALID_PARAMETERS - The QR Code is expired. Payment after its expiration date is not allowed.

Emissão de segunda via do cartão

Na documentação Emissão de segunda via do cartão, incluímos uma tabela relacionando os motivos para solicitação de segunda via e o status que o cartão antigo passará a ter após a requisição.

Além disso, acrescentamos os erros abaixo:

  • 400 – 008 - Card does not belong to this customer!

  • 400 – 011 - Invalid password!

  • 400 - WRONG_PASSWORD_ATTEMPT_LOCKED - Wrong Password Attempt Locked.

  • 400 - DUPLICATE_CARD_AWAIT_BUILDING - Duplicate Card Await Building.

  • 400 - GET_BANKLYTOKEN_ERROR - Error while getting Bankly's token.

  • 409 – 024 - No duplicate for canceled card.

  • 409 – 025 - No duplicate for card under construction.

LTDA, S.A. e TS

Na documentação LTDA, S.A. e TS da seção Onboarding, acrescentamos um destaque informando que em sandbox não há uma análise manual de documentos. Para simular esse fluxo, estabelecemos a seguinte regra: os CNPJs finalizados em números pares são aprovados e aqueles terminados em números ímpares, reprovados.

Tempo de resposta das APIs

Agora, a documentação de Convenções e a visão geral de cada produto da documentação apresentam um destaque informando que o tempo máximo de resposta de nossas APIs é de 30 segundos.

Campo adicionado no evento PIX_CLAIM_WAS_CANCELED

Na documentação do evento PIX_CLAIM_WAS_CANCELED, adicionamos o campo confirmReason, que retorna o motivo da confirmação do pedido de portabilidade ou posse. No evento de cancelamento de solicitação de posse (OWNERSHIP), os valores retornados podem ser: “DONOR_REQUEST” (solicitação do doador) ou “DEFAULT_OPERATION” (operação padrão). Para eventos de cancelamento de solicitação de portabilidade (PORTABILITY), os valores retornados podem ser: “DONOR_REQUEST” (solicitação do doador) ou NULL.

Chaves Pix no contexto de Offboarding

Na visão geral da documentação de Offboarding, destacamos que, após solicitar o encerramento da conta, todas as chaves Pix vinculadas a ela serão excluídas automaticamente. Além disso, todos os processos de disputa por pedido de portabilidade ou reivindicação de posse atrelados às chaves excluídas serão encerrados.

Novos erros mapeados na criação de análise de crédito

Foram registrados os seguintes novos erros na documentação de criação de análise de crédito:

  • 400 - SCR_MUST_BE_ACCEPTED - SCR authorization must be accepted.

  • 404 - CREDIT_CONFIG_NOT_FOUND - Credit config with program ID ${programId} and company key ${companyKey} was not found.

  • 500 - FAILURE_TO_FETCH_CREDIT_CONFIG - An internal failure occurred while fetching the credit config. Try again later.

🚧Problemas resolvidos

Campo de QR Code estático

Nas documentações abaixo, passamos a indicar o campo location.zipCode como obrigatório, pois anteriormente era apresentado como opcional:

Consulta do status da transação

Na documentação Consulta do status da transação, corrigimos o path da requisição. O path incorreto estava da seguinte forma: “https://api-mtls.sandbox.bankly.com.br/pix/cash-out/accounts/{{accountNumber}}/authenticationCode/{{authenticationCode}}”.

Entretanto, o path correto é “https://api-mtls.sandbox.bankly.com.br/pix/cash-out/accounts/{{accountNumber}}/authenticationcode/{{authenticationCode}}”.

Transferência via Pix

Na documentação Transferência via Pix, especificamente na seção “Por chave Pix”, retiramos a opção de envio do campo addressKey.

Eventos de TED

Nos eventos a seguir, corrigimos a localização dos objetos sender e recipient. Acesse os links para conferir:

Correção em formato de campos na consulta de mensagens enviadas

Corrigimos o formato dos campos startDate e endDate, da documentação do endpoint de consulta de mensagens enviadas, de YYYY-MM-DDTHH:mm:SS.MMMZ para YYYY-MM-DD.

Atenciosamente,

Time de Tech Writers