Pular para o conteúdo principal
Base URL: https://api.skalepayments.com.br

Visão geral

A API SkalePayments utiliza HTTP e JSON para criar cobranças PIX, consultar transações e acessar informações da empresa autenticada.

Especificação OpenAPI

Consulte o contrato completo e versionado da API.

Autenticação

Todos os endpoints desta referência exigem uma API Key no header X-API-Key:
Nunca exponha a API Key no navegador, em aplicativos distribuídos ou em repositórios públicos. As chamadas devem partir do seu backend.

Endpoints

Criar transação

Crie uma cobrança PIX e receba o QR Code para pagamento.

Consultar transação

Consulte uma transação pelo UUID ou identificador externo.

Dados da empresa

Consulte cadastro, permissões e saldo da conta autenticada.

Convenções

  • As requisições e respostas utilizam application/json.
  • Valores monetários são expressos em centavos, salvo quando indicado de outra forma.
  • Datas seguem o padrão ISO 8601.
  • Erros usam um envelope consistente com statusCode, message, code, path e method.
  • Requisições de criação podem usar Idempotency-Key para repetição segura.
Para uma integração guiada, consulte a aba Guias. Para testar uma operação, abra o endpoint correspondente e utilize o playground interativo.