Baixar (.md)OpenAPI

Changelog

A versão está no caminho (/v1). Campo novo numa resposta, evento novo ou código de erro novo não quebram a v1 — ignore o que você não conhece. Qualquer mudança incompatível vira /v2, com aviso e período de convivência.

1.0.0 — 26/09/2026

Primeira versão pública.

  • Caixas: ativar com código (POST /pontos-de-venda/ativar), listar, consultar, desligar.
  • Cobranças: criar com Idempotency-Key, consultar com espera (?aguardar=), listar, cancelar.
  • Eventos: GET /eventos (30 dias) e webhooks assinados (HMAC-SHA256, t=…,v1=…).
  • Ambiente de testes com dados fictícios, celular de teste, cenários automáticos e simulações da loja.
  • Homologação automática com 9 itens e pedido de produção pelo portal.
  • Repetir POST /cobrancas com a mesma Idempotency-Key e o mesmo corpo responde 200 com Idempotent-Replayed: true e a cobrança no estado de agora (a criação responde 201).
  • O nome do caixa tem até 60 caracteres e não aceita endereço de site nem e-mail: ele aparece para o gerente da loja nos avisos da Moeda Nobre.
  • Rota que não existe responde 404 RECURSO_NAO_ENCONTRADO no mesmo envelope de erro, com requestId.