Skip to main content

Changelog da API

Registro datado das mudanças relevantes da API pública. Mudanças aditivas (novos endpoints, campos ou parâmetros opcionais) são compatíveis e não exigem ação. Depreciações e remoções seguem a Política de Versionamento e Depreciação, com anúncio prévio e prazo de sunset.

Tipos: Adicionado · Alterado · Depreciado · Removido.

2026-09​

  • Adicionado — campo opcional pixKeyWithdraw em GET /api/v1/account e GET /api/v1/account/{accountId}, e nas respostas do saque e dos endpoints de chave Pix de saque. Vem como { pixKey, type } ou null quando a conta não tem chave de saque, e só é retornado para contas com a API de chave Pix de saque habilitada. type usa RANDOM para chaves aleatórias, não EVP. Veja Começando Campanha Usando Chave Pix.
  • Adicionado — POST /api/v1/pix-keys/withdraw e PUT /api/v1/pix-keys/withdraw, que definem a chave Pix de saque da conta ligada ao AppID. O POST cadastra uma chave nova e já a seleciona; o PUT seleciona uma chave de saque que a empresa já tem. A chave é consultada no DICT, o titular precisa ser o mesmo da conta e chaves de contas Woovi não são aceitas. Exigem os escopos PIX_KEY_WITHDRAW_POST e PIX_KEY_WITHDRAW_PUT e não vêm habilitados por padrão: peça ao suporte para habilitá-los na conta. Veja Começando Campanha Usando Chave Pix.
  • Adicionado — GET /api/v1/subscriptions/{id}/payment-book, que emite as cobranças das parcelas de uma assinatura RECURRENT até o mês/ano informados e devolve o carnê em PDF (application/pdf). month e year são obrigatórios e vão no máximo até o final do ano que vem. A chamada cria cobranças — com chargeType: BOLETO cada uma é um boleto registrado — e é idempotente por parcela, então repetir não cobra de novo. Exige o escopo SUBSCRIPTION_PAYMENT_BOOK_GET. Veja Como gerar carnê de assinatura usando a API?.

2026-08​

  • Adicionado — campo opcional fileId nos itens de documents em POST /api/v1/dispute/{id}/evidence, apontando para um arquivo já enviado em POST /api/v1/files com purpose DISPUTE_EVIDENCE. Envie url ou fileId, não os dois. Exige a feature DISPUTE_EVIDENCE_FILE_ID; sem ela a resposta é 403 com errorCode DISPUTE_EVIDENCE_FILE_ID_NOT_ALLOWED. Veja Como adicionar uma nova evidência em uma disputa?.
  • Adicionado — POST /api/v1/files, que armazena um arquivo e devolve seus metadados com uma URL de download temporária, para uso em outras APIs da Woovi. Exige o escopo FILE_POST. Veja Como fazer upload de um arquivo?.
  • Adicionado — query string opcional companyBankAccount em GET /api/v1/statement e GET /api/v1/transaction/{id}. Uma aplicação MASTER de uma empresa com a feature MASTER_APP_READ_ANY_ACCOUNT lê o extrato e a transação de outra conta da mesma empresa, sem criar um AppId por conta. Veja Controlando as contas no modo BAAS.
  • Adicionado — GET /api/v1/application/scopes, que lista os grupos de escopos que uma aplicação pode solicitar. Não exige escopo.
  • Adicionado — POST /api/v1/application/rotate-secret, que gera um novo clientSecret para uma aplicação da mesma empresa. Exige o escopo APPLICATION_ROTATE_POST e uma aplicação MASTER.

2026-04​

  • Removido — endpoints de account register (POST/PATCH), previamente depreciados, foram removidos do contrato público após o período de depreciação.

2026-02​

  • Adicionado — bloqueio de saque em subconta (subaccount withdraw block).

Este changelog passa a ser mantido de forma contínua. Mudanças aditivas entram como Adicionado; qualquer depreciação será anunciada aqui com data de sunset antes do desligamento, conforme a política.