Novidades da doc
InstitucionalBlogService DeskStatus Page
Back to All

Atualização da doc #8 - de 27/06/22 a 08/07/22

over 2 years ago by Tech Writers

Olá, hoje estamos recheados de atualizações na nossa documentação. Confira!

🆕 O que há de novo

API de Tarifas

Disponibilizamos a documentação da API de Tarifas, serviço que permite criar tarifas para produtos que nossos parceiros oferecem aos seus clientes. A API também possui um endpoint que possibilita a consulta das tarifas aplicadas aos produtos de uma determinada conta.

Webhook

Disponibilizamos a documentação do evento de Envio de Imagens para Onboarding, que comunica ao destinatário o recebimento e o processamento de imagens para Onboarding de pessoa física.

Novos status

Agora, alguns produtos apresentam novos status em seu processo:

  • Gestão de Cartões > Consultas: LockedByPendingPayment (bloqueado por pagamento pendente);

  • Gestão de Cartões > Rastreio de cartões: Building (possuindo três razões: “Card was embossed", “Building completed" e “Sent to ship company" para informar sobre o processo de fabricação do cartão);

  • Boletos > Consulta por authenticationCode:

    • BlockedForPayment (o boleto está bloqueado para pagamento);

    • UnfitBeneficiary (o beneficiário do boleto está inapto).

Documentação

  • A seção de API’s agora tem uma página introdutória, que orienta nossos parceiros a respeito do conteúdo que eles encontrarão nessa documentação! 😊

🌎Traduções em inglês

A seguir, as documentações traduzidas nessa quinzena:

🚀Alterações e melhorias

Onboarding

  • Movemos o processo de criação de contas da documentação de Onboarding completo para uma página separada, chamada Abertura de conta, dentro da seção Gestão de contas. Esta mudança foi necessária para uma melhor compreensão do processo, pois a criação de conta não é feita automaticamente após o cadastro do cliente;

  • Na documentação Orientação para envio de fotos, informamos que o documento deve ocupar pelo menos 60% da imagem na hora de tirar a foto para Onboarding, a fim de evitar erro na análise OCR;

  • Informamos que não é permitido enviar caracteres especiais nos campos businessName e tradingName do endpoint Registro dos dados de cliente pessoa jurídica (MEI, EI e EIRELI);

  • Na documentação de Onboarding completo de pessoa física, acrescentamos um aviso informando que, se as imagens enviadas não estiverem aprovadas, não será possível continuar com o cadastro do cliente.

Webhooks e eventos

  • Melhoramos a forma como o conteúdo é exibido na documentação de webhook de autorizador base1 e base2: agora, temos uma página mãe (chamada Autorização e Confirmação) e duas páginas filhas, uma com o foco nos eventos relacionados à autorização de transações e outra com o foco nos eventos referentes à confirmação da transação;

  • Incluímos uma descrição sobre o entityId de cada contexto de webhook. Por exemplo, no contexto Document o entityId referente a ele é o token.

Pagamento de contas

Na documentação Processo de pagamento de conta, acrescentamos:

  • Um exemplo para esclarecer o funcionamento do campo settleDate e dueDate;

  • A informação de que o valor máximo permitido para pagamento de um boleto é de R$249.999,99, para fichas de compensação, e R$950.000,00, para concessionária, tributos e convênio.

Boletos

  • Na documentação de Emissão de boletos, orientamos como o parceiro pode converter linha digitável em código de barras;

  • Acrescentamos um exemplo de simulação de pagamento de boleto, para pagamento de baixa efetividade, em sandbox.

Outras melhorias

  • Na documentação Transferência via TED, especificamos que o campo accountType pode receber o tipo Checking (Conta corrente) ou Savings (Conta poupança);

  • Para facilitar o entendimento dos status de pagamento do PIX, adicionamos uma imagem ilustrando-os;

  • Na documentação Onboarding completo de pessoa física, adicionamos exemplos de CPFs que seriam reprovados em ambiente sandbox, de forma a facilitar o desenvolvimento.

🚧Problemas resolvidos

  • Na documentação Consulta de cartões, alteramos o status de retorno que informa que não há cartões cadastrados. O status 204 foi modificado para 404;

  • Corrigimos a descrição do campo createdAt, na documentação de pagamento de contas, para informar que é retornada a data e a hora do momento em que recebemos a requisição.

Ufa! 😅

Atenciosamente,

Time de Tech Writers