> ## Documentation Index
> Fetch the complete documentation index at: https://docs.skalepayments.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Referência técnica dos endpoints públicos da API SkalePayments.

> [!NOTE]
>
> **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.

> [card] [Especificação OpenAPI](https://github.com/mariodev-black/docs/blob/main/openapi.yaml)
>
> 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`:

```http theme={null}
X-API-Key: sk_sua_chave_aqui
```

> [!WARNING]
>
> 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

> [card] [Criar transação](https://docs.skalepayments.com.br/referencia/criar-transacao.md)
>
> Crie uma cobrança PIX e receba o QR Code para pagamento.

> [card] [Consultar transação](https://docs.skalepayments.com.br/referencia/consultar-transacao.md)
>
> Consulte uma transação pelo UUID ou identificador externo.

> [card] [Dados da empresa](https://docs.skalepayments.com.br/referencia/dados-da-empresa.md)
>
> 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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.