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

# Introdução

> Bem-vindo à documentação da API da Super Pagamentos!  
Nossa API foi desenvolvida para oferecer uma integração robusta, segura e intuitiva com a nossa plataforma de intermediação de pagamentos. Através dela, é possível criar e gerenciar subcontas, processar transações, tokenizar cartões, configurar planos de assinatura, antecipar recebiveis e muito mais.  

### Estrutura por módulos

Para facilitar a navegação e a compreensão de cada parte do processo, estruturamos nossa documentação em módulos independentes, cobrindo os principais recursos disponíveis:

* **Autenticação**
* **Subcontas**
* **Contas Bancárias**
* **Clientes**
* **Tokenização de Cartões**
* **Transações**
* **Planos e Assinaturas**
* **Saldo e Transferências**
* **Antecipação de Recebíveis**
* **Webhooks**

Cada módulo contém descrições detalhadas dos endpoints, parâmetros, exemplos de requisições e respostas esperadas.

### Padrões Técnicos

Nossa API segue os princípios RESTful, com endpoints organizados por recursos e uso dos verbos HTTP padrão (`GET`, `POST`, `PUT`, `DELETE`) para manipulação dos dados. Utilizamos códigos de status HTTP para indicar o sucesso ou falha das operações, facilitando o tratamento de erros.

Todas as respostas são formatadas em **JSON**, inclusive mensagens de erro. Além disso, oferecemos suporte a CORS (Cross-Origin Resource Sharing), permitindo chamadas seguras diretamente de aplicações web hospedadas em outros domínios.

### Autenticação

O acesso à API da Super Pagamentos é protegido por um mecanismo de autenticação baseado em **JWT (JSON Web Token)**. Para gerar um token de acesso, você deverá utilizar as credenciais disponíveis em sua **Dashboard**, compostas por uma **Public Key** e uma **Secret Key**. O token gerado deverá ser incluído no header `Authorization` de cada requisição, no formato:

```
Authorization: Bearer {seu_token_aqui}
```

Essa abordagem garante que apenas usuários autorizados possam interagir com os recursos da API.

### Próximos Passos

Se esta é sua primeira vez integrando com a nossa API, recomendamos fortemente a leitura do nosso **Guia de Integração**. Ele oferece uma visão completa do fluxo de integração, com exemplos práticos e melhores práticas para cada etapa do processo.
