Sua conta é fixada (pinada) em uma versão de contrato da API. Isso significa que sua integração nunca muda de comportamento sem que você decida migrar — mesmo quando lançamos novas versões.
Como funciona
Cada conta possui uma versão de API associada, identificada por uma data (ex.:2025-01-01). Toda requisição é respondida de acordo com a versão da sua conta, a menos que você explicite outra versão na própria requisição.
Isso garante que:
- Integrações existentes nunca quebram quando lançamos uma mudança de contrato (formato de resposta, novos campos obrigatórios, etc.)
- Novas contas já nascem na versão mais recente
- Você pode testar uma versão nova antes de migrar sua conta para ela
Sobrescrevendo a versão por requisição
Use o headerX-Api-Version para testar uma versão diferente da qual sua conta está fixada, sem afetar as demais requisições:
Formato da resposta por versão
Na versão2025-01-01, cada endpoint responde no seu formato próprio (o corpo cru do recurso):
2026-08-16, toda resposta é envelopada em um formato único, independente do endpoint:
2026-08-16 eles também seguem esse envelope, com data: null e o detalhe do erro em errors:
Changelog de versões
Migrando sua conta para uma nova versão
A mudança da versão fixada na sua conta é feita hoje com o suporte da nossa equipe — ainda não há um botão de autoatendimento no painel administrativo para isso.
- Teste a nova versão enviando o header
X-Api-Versionem requisições de sandbox - Valide sua integração contra o novo formato de resposta
- Entre em contato com o suporte para migrar sua conta de forma definitiva
Suporte
Dúvidas sobre versionamento ou sobre qual versão sua conta está usando:- Email: contato@clickpay.app.br
- Chat: Disponível no painel de controle