> 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/bem-vindo-a-ao-quacpay-simplificando-pagamentos-com-integracao-inteligente.md).

# ⭐ Bem-vindo(a) ao QuacPay — Simplificando pagamentos com integração inteligente

{% 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).

## 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 HTTP e formatos](/referencia/erros-http-e-formatos.md).

{% hint style="warning" %}
Em **produção**, chamadas em **`/api/...`** **sem** o prefixo **`/api/v1/`** podem responder **410** com código **`api_v1_required`**. Para integração seller, use **sempre** os caminhos **`/api/v1/...`** desta pasta.
{% 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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.quacpay.com/bem-vindo/bem-vindo-a-ao-quacpay-simplificando-pagamentos-com-integracao-inteligente.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.