Skip to main content

​
Esquema

Rotas de negócio sob /api/pix, /webhook, /organization, entre outras, exigem: 
Authorization: Bearer <seu_api_token>
Inclua também Content-Type: application/json em corpos POST/PUT quando aplicável.

​
Obter credencial (geração de chave de API)

curl -X POST https://api.clearpago.com.br/api-key/generate \
  -H "Authorization: Bearer <token_admin>" \
  -H "Content-Type: application/json"
Resposta típica (200/201 — formato conforme implementação): 
{
  "apiKey": "ok_live_xxxxxxxxxxxxxxxxxxxxxxxx",
  "createdAt": "2026-04-01T12:00:00Z"
}
O campo de token retornado é referido no guia de origem como apiKey; use-o como valor do Bearer nas chamadas subsequentes.

​
Armazenamento e rotação

  • Guarde o token em segredo (por exemplo, variável de ambiente ou cofre de credenciais).
  • Não versionar o token em repositório.
  • Evite logar o token em claro. Em vazamento ou suspeita de comprometimento, gere novas chaves e desative as antigas conforme o processo da sua operação.
  • Toda a comunicação de produção deve ocorrer em HTTPS (TLS).

​
Erros comuns

HTTPCausa provávelAção
401Authorization ausente ou inválidoConferir prefixo Bearer e valor completo.
401Token de admin incorreto em /api-key/generateRevalidar o token administrativo.
Mensagens exatas e códigos adicionais: Tratamento de erros.

​
Referência