Atualização da doc #29 - 04/09/2023 a 29/09/2023

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

🆕 O que há de novo

• Consulta de eventos (/events)

• Conta pocket

• Fluxograma de eventos de TED

• Novos campos em eventos de Crédito

🚀Alterações e melhorias

• Abertura de conta pessoa física e jurídica

• Eventos de Crédito

• Pix - Consulta de chave para transferência

• Pagamento de contas: validação do título

• Exclusão de erros de Registro de LTDA, S.A. e TS

• Nova orientação para envio de fotos

• ID ONE - Consulta do status/resultado da análise

• Eventos de Envio de imagens para Onboarding

🚧Problemas resolvidos

• Emissão de segunda via do cartão

• Evento de Pagamento de contas

• Encerramento de contas

• Registro de MEI, EI, EIRELI ou SLU e Registro de LTDA, S.A. e TS

• Offboarding

• Eventos de envio de imagens Onboarding

• Pagamento de contas: consulta por código de autenticação

🆕 O que há de novo

Consulta de eventos (/events)

Atendendo às necessidades de nossos parceiros, elaboramos uma nova documentação para o endpoint de Consulta de eventos. Confira a seguir:

• Consulta de eventos;
• Eventos:
  • Boletos;
  • Cartões;
  • Contas;
  • Pagamento de contas;
  • Pix;
  • TED/Transferência interna.

Conta pocket

Lançamos a documentação das contas pocket, a nova funcionalidade para a gestão de contas do Bankly. Para mais informações, acesse o conteúdo a seguir:

Manual do Dev:

• Visão geral;
• Criação de conta;
• Consulta dos dados de todas as pockets;
• Consulta dos dados de uma conta pocket;
• Consulta de saldo de uma conta pocket;
• Alteração do usuário;
• Depósito em uma conta pocket;
• Resgate de um valor da conta pocket;
• Consulta de uma transação;
• Associações de cartões a contas pockets;
• Encerramento de conta pocket;
• Eventos.

APIs:

• Criação de conta pocket
• Consulta dos dados de todas as contas pockets;
• Consulta dos dados de uma conta pocket;
• Consulta do saldo de uma conta pocket;
• Alteração do usuário;
• Depósito em uma conta pocket;
• Resgate de um valor da conta pocket;
• Consulta de uma transação;
• Encerramento de uma conta pocket.

Novos campos em eventos de Crédito

CREDIT_CARD_LIMIT_INCREASE_APPROVED

Adicionamos novos campos no evento CREDIT_CARD_LIMIT_INCREASE_APPROVED. Confira:

• newLimitEffectiveAt (string);

• previousLimit (object): previousLimit.value (number) e previousLimit.currency (string);

• incresedLimit (object): incresedLimit.value (number) e incresedLimit.currency (string);

CREDIT_CARD_LIMIT_REDUCTION_APPLIED

Adicionamos novos campos no evento CREDIT_CARD_LIMIT_REDUCTION_APPLIED. Confira:

• newLimitEffectiveAt (string);

• previousLimit (object): previousLimit.value (number) e previousLimit.currency (string);

• reducedLimit (object): reducedLimit.value (number) e reducedLimit.currency (string);

🚀Alterações e melhorias

Abertura de conta pessoa física e jurídica

Na documentação de Abertura de conta pessoa física e jurídica, acrescentamos na descrição do campo Idempotency-key que o tempo para a sua expiração é de 6 minutos.

Eventos de Crédito

Realizamos as seguintes atualizações na documentação de eventos de crédito:

CREDIT_CARD_LIMIT_CREATED

• Campo excluído:

  • holder.birthDate

• Campos incluídos:

  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_APPROVED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_REPPROVED

• Campo excluído:

  • holder.birthDate

• Campos incluídos:

  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_ANALYSIS_COMPLETED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_ANALYSIS_EXPIRED

• Campos excluídos:

  • program

  • program.id

  • holder.birthDate

• Campos incluídos:

  • holder.companyKey

  • policy

  • bankLicense: bankLicense.value e bankLicense.name

  • designatedFunding

CREDIT_CARD_CONTRACT_ACCEPTED

• Campo excluído:

  • holder.birthDate

• Campos incluídos:

  • holder.companyKey
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_CONTRACT_BLOCKED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_CONTRACT_CANCELLED

• Campo excluído:

  • holder.birthDate

• Campo incluído:

  • holder.companyKey
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_CONTRACT_UNBLOCKED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_INCREASE_REQUESTED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_INCREASE_APPROVED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_INCREASE_ACCEPTED

• Campos excluídos:

  • program

  • program.id

• Campos incluídos:

  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_INCREASE_REFUSED

• Campos excluídos:

  • credit

  • credit.value

  • credit.currency

• Campos incluídos:

  • holder.companyKey
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_REDUCTION_REQUESTED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CREDIT_CARD_LIMIT_REDUCTION_APPLIED

• Campos incluídos:
  • bankLicense: bankLicense.value e bankLicense.name
  • designatedFunding

CUSTOMER_BAD_CREDIT_APPLY_REQUESTED

• Campo incluído:
  • designatedFunding

CUSTOMER_BAD_CREDIT_REMOVE_REQUESTED

• Campo incluído:
  • designatedFunding

CUSTOMER_BILLING_CREATED

• Campo incluído:
  • designatedFunding

Pix - Consulta de chave para transferência

No retorno da requisição de Consulta de chave para transferência, acrescentamos mais um payload exemplificando o retorno para consulta de chave Pix pessoa jurídica. Pois, o payload referente à pessoa jurídica retorna o tradingName, enquanto o payload referente à pessoa física retorna o socialName.

Essa especificação também foi informada na descrição dos respectivos campos.

Pagamento de contas: validação do título

Na documentação Validação do título, na descrição do campo id, esclarecemos que o valor retornado neste campo somente será válido por 30 minutos. Após esse tempo, será necessário gerar outro id.

Exclusão de erros de Registro de LTDA, S.A. e TS

Atualizamos a documentação do endpoint de Registro de LTDA, S.A. e TS, pois ele não apresenta mais os erros a seguir:

• 422- INVALID_CORPORATION_BUSINESS_BOARD_LEVEL
• 422- INVALID_CORPORATION_BUSINESS_OWNERS

Nova orientação para envio de fotos

A documentação Orientações para envio de fotos possui um novo item, solicitando ao parceiro que instrua seu cliente a tirar a foto com o documento fechado.

ID ONE - Consulta do status/resultado da análise

Na documentação Consulta do status da análise, especificamente no retorno referente à selfie, excluímos dois campos: liveness.confidence e liveness.threshold.

Essa exclusão também ocorreu na documentação do API’s: Consulta do resultado da análise de imagens.

Eventos de Envio de imagens para Onboarding

No evento DOCUMENT_WAS_PROCESSED, especificamente na tabela de campos referente à selfie, excluímos dois campos: liveness.confidence e liveness.threshold.

🚧Problemas resolvidos

Emissão de segunda via do cartão

Para melhor compreensão, ajustamos a descrição de todos os erros retornados na documentação de Emissão de segunda via.

Evento de Pagamento de contas

Dois campos foram retirados do payload do evento BILL_PAYMENT_WAS_REFUSED: recipiente.document.value e o recipiente.name.

Encerramento de contas

• Na seção de erros da documentação Encerramento de conta, removemos o erro 409 -(ACCOUNT_IS_NOT_ACTIVE) e adicionamos o código ACCOUNT_NOT_FOUND ao erro 422 (A conta não foi encontrada).
• Corrigimos o parâmetro da rota do endpoint de Encerramento de conta, que constava na documentação como accountNumRequest, quando o correto é accountNumber.

Registro de MEI, EI, EIRELI ou SLU e Registro de LTDA, S.A. e TS

Nas documentações Registro de MEI, EI, EIRELI ou SLU e Registro de LTDA, S.A. e TS, acrescentamos na descrição dos campos businessName e tradingName a informação de que eles não aceitam caracteres especiais. Esse acréscimo também foi realizado nas documentações Registro de MEI, EI, EIRELI ou SLU e Registro de LTDA, S.A. e TS da seção API’s.

Offboarding

• Na documentação Offboarding pessoa jurídica, corrigimos a URL da chamada HTTP para PATCH https://api-mtls.sandbox.bankly.com.br/business/{{document_number}}/cancel. Além disso, retiramos a obrigatoriedade do campo reason, enviado no body.
• Na documentação Offboarding pessoa física retiramos a obrigatoriedade do campo reason, enviado no body.

Eventos de envio de imagens Onboarding

Na doc de eventos Envio de imagens para Onboarding, no payload de selfie reprovada, excluímos o valor “COULD_NOT_DETECT_FACE" como possiblidade de retorno no objeto liveness.status, pois esse objeto só retorna os valores “LIVENESS” ou “NO_LIVENESS”.

Pagamento de contas: consulta por código de autenticação

Na documentação Consulta por código de autenticação, na descrição do objeto charges, informamos que seus campos retornarão nulos em caso de pagamentos desfeitos.

Atenciosamente,

Time de Tech Writers