Atualização da doc #40 - 05/08/2024 a 02/09/2024

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

🆕O que há de novo

• Fatura - Novos eventos de parcelamento
• Gestão de conta - API de acordos legais
• Acréscimo de campo em eventos Pix
• Novos campos nos eventos de Autorizador

🚀Alterações e melhorias

• Atualização da Visão geral de eventos
• Número máximo de caracteres em campos de registro de pessoa física
• Gestão de fatura - Antecipação de parcelas
• Criação de pré-análise de crédito

🚧Problemas resolvidos

• Correção de link da página de scopes
• Exclusão de erro na documentação de emissão de cartão virtual

🆕 O que há de novo

Fatura - Novos eventos de parcelamento

No Manual do Dev, adicionamos dois novos eventos do contexto de fatura (Invoice): INVOICE_INSTALLMENT_PLAN_WAS_ACTIVATED e INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED, que se referem ao processo de ativação da oferta de crédito de parcelamento.

Gestão de conta - API de Acordos legais

Adicionamos novas documentações referentes à API de Acordos legais no Manual do dev e no APIs, que abrangem dois endpoints e um evento. Confira a seguir:

• Obtenção do arquivo dos termos e condições de uso (Manual do dev e APIs);

• Envio do aceite do usuário da conta (Manual do dev e APIs);

• Recebimento do evento LEGAL_AGREEMENT_WAS_ACCEPTED, que indica que o acordo foi aceito pelo cliente.

Acréscimo de campo em eventos Pix

O campo description foi adicionado aos eventos PIX_CASH_IN_WAS_CLEARED, PIX_CASH_IN_WAS_RECEIVED, PIX_REFUND_WAS_RECEIVED e PIX_REFUND_WAS_CLEARED. Confira na documentação de eventos Pix.

Novos campos nos eventos de Autorizador

Na documentação dos eventos de autorizador, adicionamos a descrição dos novos campos que agora retornam dentro do objeto channel nos seguintes eventos: CONFIRMATION_WAS_PROCESSED, CANCELATION_WAS_PROCESSED e VOUCHER_WAS_PROCESSED. Os campos são:

• channel.merchant
• channel.merchant.mcc
• channel.merchant.mcg
• channel.merchant.city
• channel.merchant.stateOrCountryCode
• channel.merchant.state
• channel.merchant.name
• channel.merchant.zipCode
• channel.merchant.terminalId
• channel.merchant.acquirerCode
• channel.merchant.id
• channel.transactionType
• channel.transactionType.code
• channel.transactionType.description
• channel.authorizationId
• channel.responseCode
• channel.transactionTimeStamp

Além disso, nos eventos nos eventos CONFIRMATION_WAS_PROCESSED e CANCELATION_WAS_PROCESSED, há dois novos exemplos payloads, referentes a confirmação e cancelamento em base 2 do débito, nacional e internacional.

🚀Alterações e melhorias

Atualização da Visão geral de eventos

Atualizamos a página de Visão geral da seção de eventos de webhooks, inserindo links para acesso a cada contexto de evento específico.

Número máximo de caracteres em campos de registro de pessoa física

Na documentação Registro de pessoa física, informamos que os campos registerName, socialName, motherName e email aceitam no máximo 256 caracteres.

Gestão de fatura - Antecipação de parcelas

Acrescentamos uma nova informação na documentação do endpoint de antecipação de parcelas, tanto no Manual do dev quanto no APIs. Agora, a documentação informa que é possível antecipar parcelas de um refinanciamento (parcelado ou parcelado compulsório) e de compras realizadas com cartão.

Criação de pré-análise de crédito

Na documentação do endpoint de Criação de pré-análise de crédito, tanto no Manual do dev quanto no APIs, informamos que o campo x-bkly-license enviado no header da requisição é opcional e o campo programId é obrigatório.

🚧Problemas resolvidos

Correção de link da página de scopes

A página destinada a descrever os scopes apresentava um link quebrado num destaque que traz uma dica de exemplo de uso de escope. Retiramos esse link e recomendamos que o parceiro consulte a documentação de Autenticação e autorização (mTLS / DCR) da v1.

Exclusão de erro na documentação de emissão de cartão virtual

Na documentação Emissão de cartão virtual, excluímos o erro: DUPLICATE_CARD_NAME, pois ele é retornado exclusivamente para cartões físicos.

Esse erro teve sua descrição alterada nas documentações Emissão de cartão físico, Emissão de cartão múltiplo e Emissão de segunda via, para: “Já existe um cartão com o mesmo nome cadastrado. Não é possível ter dois cartões físicos ativos com o mesmo nome para o mesmo CPF.”

Atenciosamente,

Time de Tech Writers