Pular para o conteúdo principal

Autenticação

A API PayerScan utiliza autenticação por API Key. Cada loja possui sua própria API Key exclusiva, que deve ser incluída em todas as requisições.

Header da requisição​

Todas as requisições da API devem incluir o header x-api-key:

x-api-key: YOUR_API_KEY

Exemplo de requisição​

curl -X POST https://api.payerscan.com/payment/crypto \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"merchant_id": "YOUR_MERCHANT_ID", "amount": 10, "callback_url": "https://your-server.com/webhook"}'

Obtendo sua API Key​

  1. Faça login no Painel do comerciante.
  2. Acesse a página Stores.
  3. Encontre sua loja na tabela — as colunas API Key e Merchant ID são exibidas diretamente.
  4. Clique no botão Copy para copiar. Use o botão Regenerate se precisar de uma nova chave.
Aviso de segurança
  • Nunca exponha sua API Key no código do lado do cliente (navegador, aplicativo móvel).
  • Faça chamadas da API apenas do seu servidor backend.
  • Altere sua API Key imediatamente se suspeitar de comprometimento.

Como funciona​

Cliente → Seu backend → PayerScan API
                         ↑
                    x-api-key header
  1. Seu backend recebe uma solicitação de pagamento do cliente.
  2. Seu backend chama a API PayerScan com o header x-api-key.
  3. PayerScan verifica a API Key e confirma que a loja e a conta do comerciante estão ativas.
  4. Se válido, a requisição é processada e uma resposta é retornada.

Formato de resposta de erro​

Quando a autenticação falha, a API retorna um JSON:

{
  "status": "error",
  "message": "Invalid API key. Please check your API key and try again.",
  "error_code": "INVALID_API_KEY"
}

Códigos de erro de autenticação​

Status HTTPCódigo de erroDescrição
401MISSING_API_KEYO header x-api-key está ausente ou vazio.
401INVALID_API_KEYA API Key está incorreta ou não pertence a nenhuma loja ativa.
403ACCOUNT_INACTIVEA conta do comerciante foi desativada. Entre em contato com o suporte.
403STORE_INACTIVEA loja foi desativada. Entre em contato com o suporte.
500AUTHENTICATION_FAILEDErro interno do servidor durante a autenticação. Tente novamente mais tarde.
dica

Se você receber ACCOUNT_INACTIVE ou STORE_INACTIVE, entre em contato com o suporte em payerscan.com para reativar sua conta.