Atualização da doc #45 - 06/01/2025 a 03/02/2025

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

🆕O que há de novo

• Adição do objeto cancellation em eventos de cartão
• Adição do objeto currentBalance em endpoints de fatura
• Novo endpoint de fatura: Consulta de transações por cartão
• Novos eventos de fatura
• Novo erro no endpoint de simulação de parcelamento
• Novo campo no evento INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED

🚀Alterações e melhorias

• Inclusão de eventos de Pix QR Code na seção de eventos dos endpoints
• [Fatura v2] Alteração no nome de campos
• Inserção de seções v2 na v1
• Inclusão de cabeçalho em endpoint de Exclusão de chaves
• Alteração no menu de Cartões
• Alterações na documentação de Emissão de segunda via de cartão

🚧Problemas resolvidos

• Transferência de documentação da aba v1 para v2: Consulta do sumário da fatura
• Correções em tipagem de campos - mTLS

🆕 O que há de novo

Adição do objeto cancellation em eventos de cartão

Atualizamos a documentação dos eventos de cartão para incluir informações sobre o novo objeto cancellation, agora presente como uma propriedade do objeto existente previousCard.

Confira abaixo os eventos que passaram a conter esse novo objeto:

• CARD_WAS_ISSUED;
• CARD_WAS_EMBOSSED.

Adição do objeto currentBalance em endpoints de fatura

Atualizamos os endpoints de fatura para incluir o novo campo currentBalance, que fornece informações detalhadas sobre o saldo atual da fatura.

Confira abaixo os endpoints que passaram a conter esse novo campo:

• Consulta de fatura aberta V1
  • Manual do dev: Consulta de fatura aberta;
  • APIs: Consulta de fatura aberta.
• Consulta de fatura por ID V1
  • Manual do dev: Consulta de fatura por ID;
  • APIs: Consulta de fatura por ID.
• Consulta de fatura por ID V2
  • Manual do dev: Consulta de fatura por ID;
  • APIs: Consulta de fatura pelo ID.

Novo endpoint de fatura: Consulta de transações por cartão

Adicionamos um novo endpoint para permitir a consulta detalhada das transações associadas a um cartão específico dentro de uma fatura.

• Manual do dev: Consulta de transações por cartão;
• APIs: Consulta de transações por cartão.

Novos eventos de fatura

Atualizamos a documentação de eventos de fatura com a adição de dois novos eventos, que trazem mais transparência sobre o ciclo de vida das faturas:

• INALLMENTS_PLAN_WAS_INACTIVATED – indica que um plano de parcelamento foi desativado;
• STATEMENT_DUE_DATE_WAS_UPDATED – notifica a alteração da data de vencimento de uma fatura.

Novo erro no endpoint de simulação de parcelamento

Adicionamos um novo código de erro ao endpoint de Simulação de parcelamento de uma fatura, melhorando a transparência sobre restrições de juros - ALL_SIMULATIONS_ABOVE_INTEREST_RATE_CELLING .

Novo campo no evento INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED

Incluímos o novo campo reasons[] no evento INVOICE_INSTALLMENT_PLAN_ACTIVATION_WAS_FAILED, permitindo capturar detalhes sobre os motivos de falha na ativação do parcelamento de fatura.

🚀Alterações e melhorias

Inclusão de eventos de Pix QR Code na seção de eventos dos endpoints

Atualizamos a documentação para garantir que o evento PIX_QRCODE_WAS_CREATED esteja corretamente associado às páginas relevantes, facilitando sua localização pelos desenvolvedores.

• Evento anteriormente documentado em: Pix e DICT
• Agora também vinculado às páginas:
  • Emissão QR Code dinâmico
  • Emissão de QR Code estático

[Fatura v2] Alteração no nome de campos

Atualizamos a nomenclatura de alguns campos na documentação de Consulta de limite de crédito v2. Confira!

Inserção de seções v2 na v1

Para aprimorar a navegação, adicionamos referências às documentações da aba v2.0 do Manual do Dev no menu da aba v1.0:

• Criamos a página Primeiros Passos – Versões de APIs, detalhando quais documentações estão disponíveis exclusivamente na aba v2 e como acessá-las;
• Adicionamos seções e páginas da v2 ao menu da v1, sem informações detalhadas sobre endpoints ou contextos, apenas com uma breve descrição e um link redirecionando para a documentação completa na aba v2;
• Incluímos um callout na primeira página da documentação de APIs v1, informando que as documentações de endpoints como boleto e pocket estão disponíveis na aba v2, com um link direto para a nova versão.

Inclusão de cabeçalho em endpoint de Exclusão de chaves

Para atender às especificações de segurança do Pix, foi adicionado um novo campo obrigatório ao cabeçalho da requisição de exclusão de chaves: o x-bkly-pix-user-id, no qual deve ser informado o número do documento do usuário que está fazendo a requisição.

Alteração no menu de Cartões

A página Configuração do contactless se encontrava na seção "Gestão de status". Para classificá-la de modo mais adequado, ela foi incluída na seção "Configuração do cartão”.

Alterações na documentação de Emissão de segunda via de cartão

A documentação Emissão de segunda via, sofreu as seguintes alterações:

• Foram adicionados os seguintes novos motivos de solicitação de segunda via: CustomerOrder, CardWasBroken, CardHasDefect e CardWasRobbed;
• Corrigimos os status que o cartão antigo passará a ter em casos de UnrecognizedOnlinePurchase e CardWasDamaged;
• O campo cancellationMode deixa de ser obrigatório;
• Foi adicionado o erro 409 - LATE_CANCEL_ERROR.

🚧Problemas resolvidos

Transferência de documentação da aba v1 para v2: Consulta do sumário da fatura

Migramos para a aba v2.0 a documentação do endpoint v2 de Consulta do Sumário da Fatura, que anteriormente estava localizada na aba v1.0 do Manual do Dev.

Correções em tipagem de campos - mTLS

• Na documentação Token para gerar certificado mTLS, corrigimos o tipo do campo expires_in de string para integer;
• Na documentação Registro dinâmico de client (credencial), corrigimos o tipo do campo client_id_issued_at de de string para number.

Atenciosamente,

Time de Tech Writers