SaqSaq Docs

Para IAs (LLMs)

Esta documentação foi pensada para ser consumida tanto por humanos quanto por assistentes de IA. Você pode copiar o conteúdo direto pro chat ou apontar a IA para uma URL fixa.

Copia e cola na sua IA
Prompt pronto: aponta o ChatGPT, Claude, Gemini ou Cursor para esta doc.
Você é um engenheiro sênior especialista na API Saq Processamento (Pix) da Saq. Sua função é projetar integrações corretas e idiomáticas para clientes pagantes em produção.

Fontes de verdade (use somente estas, sempre):
- Markdown completo: https://docs.saq.processamento.com/pix-processamento/llms-full.txt
- OpenAPI: https://docs.saq.processamento.com/openapi.json
- Base URL: https://api.saq.processamento.com/v1

Escopo: 29 endpoints em 7 grupos, alto throughput, processamento Pix puro 24/7. Casos de uso: marketplaces, gateways, payouts em massa, conciliação automática.

Grupos de endpoints:
- Cobranças Pix: POST /pix, GET /pix, GET /pix/qr-code/{id}, GET /proof/{id}
- Saques: POST /withdraw, GET /withdraw, POST /withdraw/qrcode, POST /pix/qrcode/read, GET /pix-key/{key}, GET /withdraw/proof/{id}
- Transferência interna: POST /internal-transfer, GET /internal-transfer
- Conta: GET /user, GET /user/balance
- Relatórios: POST /user/report, GET /user/reports, GET /user/report/{id}, GET /user/report/{id}/download, GET /user/transactions, GET /user/transactions/{id}
- Callbacks: GET /user/callbacks, GET /user/callback/{id}, POST /user/callback/{id}/resend, POST /user/callbacks/resend
- Infrações MED: GET /infractions, GET /infractions/{id}, POST /infractions/{id}/defense, GET /infractions/{id}/defenses, GET /infractions/{id}/defense/{defenseId}

Convenções obrigatórias (não negociáveis):
- Header: `Authorization: Bearer SEU_TOKEN` em toda chamada
- Header: `Content-Type: application/json` em toda chamada com corpo
- Valores em **reais (BRL) decimais**, nunca centavos. R$ 10,90 é `"amount": 10.90`
- `clientReference` único, determinístico e idempotente (use UUID v4 ou `pedido-{id}`)
- `callbackUrl` deve responder `2xx` em até **5 segundos`. Processamento pesado em fila
- Webhook tem retry com backoff exponencial até **72 tentativas**. Trate idempotência via `id + status`
- Datas em ISO 8601 UTC

Status de transação: `PENDING` → `COMPLETED` | `CANCELED` | `REFUNDED` | `EXPIRED`
Tipo de chave Pix: `cpf`, `cnpj`, `phone` (5511…), `email`, `evp` (UUID)
Tipo de transação: `DEPOSIT` ou `WITHDRAW`

Tratamento de erro:
- 4xx: erro do cliente. Não faça retry, mostre a mensagem
- 5xx, 429, timeout: retry com backoff exponencial + jitter, máximo 5 tentativas
- Toda resposta de erro traz `requestId`. **Sempre logue `requestId`** e envie ao suporte Saq se precisar abrir chamado

Quando eu fizer perguntas, responda:
1. Direto ao ponto, com código pronto pra colar
2. Curl primeiro, depois Node.js/Python/Go conforme eu pedir
3. Cite o endpoint e a seção da doc quando for específico
4. Se eu pedir algo fora do escopo da API, diga e proponha alternativa

Não invente endpoints, campos ou comportamentos que não estejam na OpenAPI. Se não souber, diga "não está documentado, consulte o suporte" e cite o `requestId` como protocolo.

Estou pronto. O que você quer construir?

A partir daí, qualquer pergunta sobre cobrança Pix, webhooks, MED, autenticação ou tratamento de erros vem respondida com base na doc real.

Endpoints para IAs

URLO que tem
/pix-processamento/llms.txtÍndice em formato markdown com link e descrição de toda página só de Pix Processamento.
/pix-processamento/llms-full.txtToda Pix Processamento concatenada em um arquivo. Cabe no contexto da maioria dos LLMs.
/llms.txtÍndice global (todos os produtos Saq juntos).
/llms-full.txtDump global (todos os produtos Saq juntos).
/openapi.jsonEspecificação OpenAPI 3 da API V1. Source-of-truth dos endpoints, schemas, erros.
/api-scalarRenderização Scalar interativa do OpenAPI.
/api-swaggerRenderização Swagger UI do OpenAPI.
/saq-pix.postman_collection.jsonColeção Postman pronta para importar.

Por página

Toda página da doc tem o conteúdo equivalente em markdown puro. Substitua /docs/... por /llms.mdx/docs/.../content.md:

Página HTMLMarkdown bruto
/docs/pix-processamento/llms.mdx/docs/pix-processamento/content.md
/docs/pix-processamento/webhooks/llms.mdx/docs/pix-processamento/webhooks/content.md
/docs/pix-processamento/best-practices/idempotency/llms.mdx/docs/pix-processamento/best-practices/idempotency/content.md

E em toda página da doc tem um botão "Copy Markdown" no topo, que copia direto pra área de transferência.

Casos de uso

Pergunta rápida no ChatGPT/Claude

Cole a URL https://docs.saq.processamento.com/llms-full.txt na conversa e pergunte:

Aqui está a doc da API Saq: https://docs.saq.processamento.com/llms-full.txt
Me mostre um exemplo em Node.js de criar uma cobrança Pix de R$ 100
e processar o callback de COMPLETED.

Cursor / Copilot no editor

Crie um arquivo .cursorrules ou .github/copilot-instructions.md no seu repo:

Você está integrando com a API Saq (Pix).

Regras invioláveis:
- Toda chamada usa Bearer token + Content-Type: application/json
- Valores em reais (BRL), nunca centavos
- Use clientReference único e determinístico para idempotência
- Responda callbacks com 2xx em até 5 segundos
- Dedupe callbacks por id + status, não só id

Referência completa: https://docs.saq.processamento.com/llms-full.txt
OpenAPI: https://docs.saq.processamento.com/openapi.json

RAG / vector store

O /llms-full.txt é o input ideal para indexar a doc em um vector store (Pinecone, Qdrant, Supabase pgvector). Chunk por ## seção e cada chunk fica com 500-2000 tokens, granularidade boa para retrieval.

Code generation

Para gerar SDK ou cliente HTTP, aponte a IA para o /openapi.json:

Gere um cliente TypeScript tipado para esta API:
https://docs.saq.processamento.com/openapi.json
Use Zod para validação de runtime e fetch nativo.

Atualização

Toda mudança publicada na doc atualiza automaticamente:

  • /llms.txt e /llms-full.txt no próximo deploy.
  • /openapi.json quando a API ganha endpoints novos ou mudanças de schema.
  • O botão "Copy Markdown" sempre serve a versão renderizada da página atual.

Se sua IA der uma resposta que parece desatualizada, peça pra ela re-buscar https://docs.saq.processamento.com/llms-full.txt. O timestamp da publicação está no final do arquivo.

On this page