Autenticação

Segurança

Mantenha suas chaves de API seguras e nunca as compartilhe com partes não autorizadas. Essas chaves fornecem acesso à sua conta e serviços da plataforma.

NUNCA deixe suas chaves de API expostas diretamente no código front-end (JavaScript, HTML, aplicativos móveis, etc.). Chaves expostas podem ser facilmente acessadas por qualquer usuário, comprometendo a segurança da sua conta. Use sempre um backend/servidor para fazer as requisições com as chaves de API.

Acessando sua Chave

Sua primeira chave de API está disponível diretamente na home do painel administrativo:

Acesse o painel administrativo
No menu lateral dentro de desenvolvedores clique em Chaves de API
Clique em criar nova chave
Adicione um nome
Copie a chave e guarde A CHAVE DE API SÓ SERÁ MOSTRADA UMA VEZ

Exemplo de Chave

cpk_live_9i8h7g6f5e4d3c2b1a0j

Não existe simulação de pagamento

Toda chave de API cria cobranças PIX reais assim que criada — não existe modo de teste que simula pagamento sem mexer com dinheiro de verdade. Trate qualquer chave gerada como capaz de processar transações reais desde o primeiro uso.

Informações das Chaves

Na tela de gerenciamento, você visualiza:

Nome da chave - Identificação personalizada
Prefixo - cpk_live_
Status - Ativo/Inativo
Data de criação - Quando foi gerada
Último uso - Última atividade registrada

Utilizando as Chaves

Autenticação HTTP

Inclua a chave no header de autorização:

curl -X GET "https://api.xpaybrasil.com/v1/charge/:id" \-H "X-API-KEY: cpk_live_sua_chave_aqui" \-H "Content-Type: application/json"

Exemplo de Integração

const apiKey = 'cpk_live_sua_chave_aqui';fetch('https://api.xpaybrasil.com/v1/charge/:id', {method: 'GET',headers: {  'X-API-KEY': `${apiKey}`,  'Content-Type': 'application/json'}}).then(response => response.json()).then(data => console.log(data));