> For the complete documentation index, see [llms.txt](https://documentation.quacpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.quacpay.com/bem-vindo/quacpay.com-documentacao-and-integracao.md).

# ⭐ QuacPay.com - Documentação & Integração

{% hint style="info" %}
**Base URL:** `https://quacpay.com` — rotas **seller** em **`/api/v1/...`**, exceto **`POST /oauth/token`** (na raiz, sem `/api`).
{% endhint %}

⭐ Aqui na QuacPay, você encontrará as rotas necessárias para integrar cobrança Pix, saques, consultas e webhooks. Use **HTTPS**, guarde credenciais **apenas no seu servidor** e envie **`Authorization: Bearer`** nas rotas autenticadas após o OAuth. ⭐

## URLs da API

| Uso                   | Caminho                                                                |
| --------------------- | ---------------------------------------------------------------------- |
| **OAuth**             | `POST https://quacpay.com/oauth/token`                                 |
| **API seller**        | `https://quacpay.com/api/v1/...`                                       |
| **Link de pagamento** | `https://quacpay.com/c/{publicCode}` — checkout hospedado (sem Bearer) |

Esta documentação descreve apenas o **contrato público** de integração (endpoints, campos e respostas expostos ao seller via **OAuth** e **`/api/v1/...`**).

{% hint style="warning" %}
Documentamos **somente rotas atuais** da API seller. Rotas antigas, endpoints de painel web ou campos internos **não** fazem parte deste guia.
{% endhint %}

## Tipos de rota

| Prefixo        | Autenticação                           | Destinatário típico                    |
| -------------- | -------------------------------------- | -------------------------------------- |
| `/oauth/token` | `client_id` + `client_secret` no JSON  | Seu servidor                           |
| `/api/v1/...`  | `Authorization: Bearer <access_token>` | Integração seller (API)                |
| `/c/:code`     | Nenhuma                                | Checkout hospedado (link de pagamento) |

Configurações do **painel web** (ex.: integrações e pixels por link) não fazem parte das rotas OAuth documentadas aqui.

## Cabeçalhos e convenções

| Cabeçalho                        | Direção             | Uso                                                                            |
| -------------------------------- | ------------------- | ------------------------------------------------------------------------------ |
| `Content-Type: application/json` | Pedido              | Corpos JSON nas rotas documentadas                                             |
| `Authorization: Bearer …`        | Pedido              | Rotas `/api/v1/...` após OAuth                                                 |
| `X-Request-ID`                   | Resposta            | Identificador público para suporte *(pode repetir-se em `request_id` no JSON)* |
| `Idempotency-Key`                | Pedido *(opcional)* | Criação de assinatura Pix Automático — evita duplicidade em reenvio            |

## Segurança e formato

* **HTTPS obrigatório** (recomenda-se TLS 1.2 ou superior).
* **`client_secret` e tokens** apenas no servidor; nunca em app público ou logs compartilhados.
* Corpos **`application/json; charset=UTF-8`** salvo indicação contrária.
* Respostas de erro podem ser envelope (`success`, `code`, `message`, `request_id`) ou só `{ "message": "…" }` — veja [Erros](/referencia/erros-http-e-formatos.md).

{% hint style="info" %}
Todas as rotas **seller** documentadas neste guia usam **`POST /oauth/token`** (autenticação) e **`/api/v1/...`** (operações). Este é o contrato oficial de integração.
{% endhint %}

## Evolução do contrato

Endpoints de listagem podem ganhar novos campos. Mantenha parsers tolerantes: trate campos desconhecidos como opcionais.

## Comece por aqui!

{% hint style="success" %}
[**Começando — Quickstart**](/bem-vindo/comecando-quickstart.md) — fluxo mínimo: token OAuth → **create-customer** (obrigatório se a Pix usar `customer`/`customerId`) → cobrança Pix → webhook → consultas.
{% endhint %}

**Também:** [Consultar saldo](/api-v1/consultar-saldo.md) · [Meta Ads no painel](/api-v1/meta-ads-na-quacpay.md) · [Rastreamento e conversões](/api-v1/rastreamento-de-campanhas-e-conversoes.md) · [Integração UTMify](/api-v1/integracao-utmify-rastreamento-de-campanha.md) · [Links de pagamento](/api-v1/links-de-pagamento-checkout-hospedado.md)