Changelog da API Mepagg

1.1.6

Novo webhook público para mudança de status de links de pagamento, com documentação completa do payload e sincronização dos exemplos operacionais.

• Novo evento público payment_link.status_changed documentado para notificar expiração por vencimento, desativação manual e limite de usos atingido.
• ReDoc, referência Markdown e llms.txt agora explicam status_code, status_reason_code e o snapshot completo de payment_link enviado no webhook.
• Exemplos de cadastro de endpoint e coleção pública do Postman foram sincronizados para incluir o novo evento no catálogo de subscribed_events.
• OpenAPI pública passou a expor modelo dedicado do payload payment_link.status_changed para facilitar homologação e integração.

1.1.5

Clarificação pública do contrato de origem de emissão para evitar override por payload em integrações externas.

• issued_via, issued_via_code e issued_via_label passaram a ficar explicitamente documentados como campos somente de resposta e webhook.
• A documentação pública agora reforça que a origem da emissão é calculada internamente pela Mepagg conforme o canal real da operação, sem aceitar controle do integrador no payload.
• ReDoc, referência Markdown e llms.txt foram sincronizados para remover ambiguidade operacional sobre esse trio de campos.

1.1.4

Sincronização pública do contrato de links de pagamentos com suporte restaurado a links sem vencimento e regra explícita para o vencimento das faturas geradas.

• Links de pagamentos passaram a documentar 5_days na validade do link e none para o cenário Sem vencimento em painel e API.
• Quando due_option=none, a documentação agora exige invoice_due_option e, quando necessário, invoice_custom_due_days para definir o vencimento de cada cobrança criada pelo checkout.
• A opção 20_days foi documentada somente para invoice_due_option, sem aparecer como validade do link.
• Exemplos públicos, ReDoc, referência Markdown, llms.txt e coleção do Postman foram sincronizados com validity_display, invoice_due_option_label e invoice_due_summary.
• A leitura humana de invoice_due_option=today passou a aparecer como No mesmo dia na documentação pública.

1.1.3

Ajuste público do recurso de links de pagamentos para refletir o contrato atual e reforço do fluxo obrigatório de manutenção da documentação.

• O recurso público de Links de pagamentos passou a expor apenas as operações de listar, criar e detalhar em /api/v1/payment-links/.
• Operações públicas de edição e remoção deixaram de aparecer no OpenAPI, no ReDoc, na referência Markdown e na coleção pública do Postman.
• Fluxo interno de manutenção documental reforçado para exigir atualização explícita da versão pública exibida no topo do ReDoc sempre que houver mudança publicada.
• Checklist interno também passou a exigir sincronização do changelog.html junto com a atualização pública da documentação.

1.1.2

Publicação completa da API de links de pagamentos com contrato canônico, exemplos operacionais e origem de emissão propagada até a fatura gerada.

• Novo recurso público de Links de pagamentos documentado com operações de listar, criar, detalhar, substituir, atualizar parcialmente e remover em /api/v1/payment-links/.
• OpenAPI, ReDoc, referência Markdown, llms.txt e coleção pública do Postman sincronizados com exemplos profissionais de payload, respostas e filtros de listagem.
• Links criados pela API agora persistem origem API, e as faturas geradas depois pelo checkout público desse link passam a sair com type_code=payment_link e issued_via_code=api.
• Documentação de webhooks reforçada para orientar integrações a acompanhar invoice.* quando a cobrança nascer de um link, já que não existe evento público dedicado payment_link.* no catálogo atual.
• Listagem operacional de links ajustada para exibir Sem valor quando o checkout não tiver valor pré-definido.

1.1.1

Normalização do contrato público de faturas para separar tipo da cobrança e origem de emissão.

• Faturas da API pública deixaram de expor API como tipo de cobrança; o tipo canônico permanece Avulsa com type_code=oneoff.
• Novo trio de campos issued_via, issued_via_code e issued_via_label documentado para identificar se a fatura foi emitida via painel ou API.
• Exemplos de webhooks e referência técnica atualizados para refletir a nova separação entre type e origem de emissão.
• Legado de faturas antigas normalizado para manter compatibilidade de leitura sem reaproveitar API como tipo.

1.1.0

Expansão pública da API de planos com documentação completa, exemplos operacionais e catálogo de webhooks sincronizado.

• Novo recurso público de Planos documentado no ReDoc com operações de listar, criar, detalhar, atualizar e remover em /api/v1/subscription-plans/.
• OpenAPI, referência Markdown, llms.txt e coleção pública do Postman sincronizados com exemplos de payload para criação e manutenção de planos.
• Novo catálogo público de eventos plan.created, plan.updated e plan.deleted incluído na documentação de webhooks.
• Backend público passou a disparar webhooks de planos para refletir criação, atualização e remoção lógica no sistema integrador.
• Fluxo público reforçado com suporte documentado a Idempotency-Key para POST, PUT, PATCH e DELETE de planos.

1.0.9

Sincronização do contrato público de tipos de fatura e endurecimento do fluxo interno de manutenção da documentação.

• Mapa público de tipos de fatura documentado na referência canônica com type, type_code e type_label.
• Exemplos de fatura e webhook corrigidos para o código real oneoff no tipo Avulsa.
• Documentação da API reforçada para explicitar que a consulta de fatura pode retornar type_display como alias de interface.
• Fluxo legado isolado em arquivo e manutenção pública consolidada diretamente no openapi.json do ReDoc.
• Fluxo de manutenção reforçado para exigir que toda mudança solicitada apareça visivelmente no ReDoc, não apenas em schema ou example interno.

1.0.8

Aprimoramentos de precisão operacional na OpenAPI, documentação pública e exemplos de integração.

• Assinaturas documentadas com payment_methods obrigatório na criação pública e limite de cycles entre 0 e 120.
• Faturas e carnês reforçados com a regra operacional de bloqueio para vencimento no mesmo dia a partir das 20h e sem data retroativa.
• Carnês ampliados na documentação para expor o payload opcional de schedule e sua validação por quantidade de parcelas.
• Webhooks atualizados para explicitar HTTPS público, exceção de localhost e suporte a * em subscribed_events.
• OpenAPI regenerada com schemas mais fiéis ao contrato público e samples JavaScript corrigidos nos endpoints afetados.

1.0.7

Correções de consistência entre documentação pública, exemplos operacionais e contrato real da API.

• Exemplos públicos de carnê corrigidos para refletir a regra atual de item único em items.
• Collection pública do Postman sincronizada com o contrato de carnês.
• Documentação de webhooks ajustada para usar event_id com prefixo real wh_evt_, status reais de entrega e max_attempts=6.
• Política pública de retry de webhooks expandida com a sequência real de backoff.
• Resumo para IA em llms.txt alinhado com as regras atuais de carnês.

1.0.6

Alinhamento entre contrato público da API, regras operacionais de cobrança e versionamento da documentação.

• API de carnês ajustada para aceitar apenas um item em items na criação, refletindo a regra operacional atual.
• Documentação de faturas e assinaturas reforçada para deixar explícito que ambas aceitam um ou vários produtos/serviços.
• Valor mínimo total de criação documentado e padronizado em R$ 5,00 para faturas, assinaturas e carnês.
• Especificação openapi.json atualizada para expor as novas regras de items, limites mínimos e recorrência de assinaturas.
• Versionamento da OpenAPI sincronizado para evitar novas publicações com a versão parada em 1.0.0.

1.0.5

Padronização da documentação de itens em cobranças, recorrências e carnês.

• Documentação de faturas reforçada para deixar explícito que é possível enviar um ou vários itens com descrições e valores diferentes.
• Documentação de assinaturas reforçada com estrutura completa de itens recorrentes e formação do total_amount.
• API de carnês ampliada para aceitar items detalhados na criação, calcular o valor total pela soma dos itens e distribuir esse valor entre as parcelas.
• Compatibilidade adicionada para aceitar qty ou quantity nos itens, com qty como campo canônico de resposta.

1.0.4

Ampliação dos recursos públicos de cobrança para impressão e montagem de layouts próprios por sistemas conectados.

• API de faturas passou a expor public_url, public_boleto_url, boleto.* e pix.*.
• API de carnês passou a expor public_url do carnê e a reutilizar os links públicos das parcelas.
• Novo link público do carnê com todas as parcelas em visualização pronta para impressão na Mepagg.
• Documentação pública atualizada com orientações para usar o modelo Mepagg ou montar boleto e carnê próprios, incluindo os campos sugeridos e a identificação da intermediação Mepagg LTDA - CNPJ 05.098.228/0001-80.

1.0.3

Expansão do catálogo de webhooks com foco em eventos financeiros de saída e compra operacional de créditos.

• Webhook transfer.created e transfer.completed reforçados na documentação pública com payloads alinhados ao formato real entregue pela API.
• Novo webhook sms.credits_purchased documentado e incluído no catálogo oficial de eventos suportados.
• Compra de pacote de SMS agora também dispara evento público de webhook, com pacote adquirido, valor, método de compra e saldo final de créditos.
• Validação de eventos suportados reforçada no cadastro de endpoints para evitar assinaturas com nomes inválidos.

1.0.2

Acabamento profissional da documentação pública com catálogo canônico, limites operacionais, rastreabilidade e reforço de consistência entre artefatos.

• Adição das seções públicas de catálogo canônico, limites operacionais, rastreabilidade/correlação e versionamento/compatibilidade na documentação principal.
• Reforço da referência técnica em Markdown e do llms.txt com diretrizes de produção, deduplicação e conciliação financeira.
• Exemplos da seção de dados cadastrais da conta revisados para usar dados totalmente fictícios.
• Checklist interno de sincronização reforçado para impedir publicação de exemplos sensíveis em artefatos públicos.

1.0.1

Refino estrutural da documentação pública com foco em experiência do desenvolvedor, consumo por IA e padronização operacional.

• Entrada principal da documentação movida para https://documentacao.mepagg.com/, sem depender da extensão openapi.html.
• OpenAPI enriquecida com fluxo de integração em 5 minutos, fluxo financeiro, FAQ técnica, tabela padronizada de erros, webhooks e exemplos adicionais.
• Adição de operationId em todas as operações para melhorar SDKs, geração de clientes e leitura por agentes.
• Padronização das sugestões de cores de status usando as mesmas cores reais da interface principal da Mepagg.
• Sincronização de llms.txt e api-reference.md com o catálogo real de eventos e regras da API.

1.0.0

Versão pública inicial consolidada da documentação transacional da API Mepagg.

• Documentação pública consolidada em OpenAPI com foco em cobranças, conta digital e operação segura.
• Especificação pública em openapi.json e interface navegável oficial da documentação.
• Referência técnica em Markdown e arquivo llms.txt para agentes de IA.
• Documentação de webhooks com assinatura HMAC, headers e payloads principais.
• Cobranças públicas suportadas por boleto e PIX.
• Suporte a Idempotency-Key em criação de fatura, cancelamento, estorno, transferência e envio manual de SMS.

Como este changelog será usado

• Novos endpoints entram aqui antes de serem considerados estáveis na integração pública.
• Campos depreciados serão marcados explicitamente com orientação de migração.
• Breaking changes terão destaque próprio e prazo de adequação quando aplicável.