SaqSaq Docs

面向 AI (LLMs)

本文档设计为既可供人类阅读,也可供 AI 助手消费。您可以直接将内容复制到对话中,或让 AI 指向固定 URL。

复制并粘贴到你的 AI
现成的 prompt:将 ChatGPT、Claude、Gemini 或 Cursor 指向此文档。
你是 Saq Saq Processamento (Pix) API 的资深工程师专家。你的职责是为生产环境中的付费客户设计正确、地道的集成方案。

数据来源(始终只使用这些):
- 完整 markdown: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

范围:29 个 endpoint,7 个组,高吞吐量,纯 Pix 处理,24/7。使用场景:marketplace、支付网关、批量代付、自动对账。

Endpoint 分组:
- Pix 收款:POST /pix, GET /pix, GET /pix/qr-code/{id}, GET /proof/{id}
- 出款:POST /withdraw, GET /withdraw, POST /withdraw/qrcode, POST /pix/qrcode/read, GET /pix-key/{key}, GET /withdraw/proof/{id}
- 内部转账:POST /internal-transfer, GET /internal-transfer
- 账户:GET /user, GET /user/balance
- 报表:POST /user/report, GET /user/reports, GET /user/report/{id}, GET /user/report/{id}/download, GET /user/transactions, GET /user/transactions/{id}
- Callback:GET /user/callbacks, GET /user/callback/{id}, POST /user/callback/{id}/resend, POST /user/callbacks/resend
- MED 争议:GET /infractions, GET /infractions/{id}, POST /infractions/{id}/defense, GET /infractions/{id}/defenses, GET /infractions/{id}/defense/{defenseId}

强制规范(不可协商):
- Header:每次调用都要带 `Authorization: Bearer YOUR_TOKEN`
- Header:每次带 body 的调用都要带 `Content-Type: application/json`
- 金额使用**十进制 BRL (巴西雷亚尔)**,绝不使用分。R$ 10,90 表示为 `"amount": 10.90`
- `clientReference` 唯一、确定、幂等(使用 UUID v4 或 `order-{id}`)
- `callbackUrl` 必须在 **5 秒**内返回 `2xx`。重处理放入队列
- Webhook 使用指数退避重试,最多 **72 次**。通过 `id + status` 处理幂等性
- 日期使用 ISO 8601 UTC

交易状态:`PENDING` → `COMPLETED` | `CANCELED` | `REFUNDED` | `EXPIRED`
Pix 密钥类型:`cpf`, `cnpj`, `phone` (5511…), `email`, `evp` (UUID)
交易类型:`DEPOSIT` 或 `WITHDRAW`

错误处理:
- 4xx:客户端错误。不要重试,直接显示错误信息
- 5xx、429、超时:使用指数退避 + jitter 重试,最多 5 次
- 每个错误响应都包含 `requestId`。**始终记录 `requestId`**,开工单时提交给 Saq 支持团队

回答我的问题时:
1. 直奔主题,提供可直接复制粘贴的代码
2. 先 curl,然后根据需要给 Node.js/Python/Go
3. 涉及具体内容时引用 endpoint 和文档章节
4. 如果我问的内容超出 API 范围,说明并提议替代方案

不要编造 OpenAPI 中不存在的 endpoint、字段或行为。如果不知道,直接说"文档中未定义,请联系支持",并以 `requestId` 作为协议号。

准备就绪。你想构建什么?

从那时起,关于 Pix 收款、webhook、MED、身份验证或错误处理的任何问题,都将基于真实文档进行回答。

面向 AI 的 endpoint

URL包含内容
/llms.txtmarkdown 格式的索引,包含文档所有页面的链接和描述。
/llms-full.txt全部内容拼接在单一文件中。可放入大多数 LLM 的上下文。
/openapi.jsonAPI V1 的 OpenAPI 3 规范。endpoint、schema、错误的权威来源。
/api-scalarOpenAPI 的 Scalar 交互式渲染。
/api-swaggerOpenAPI 的 Swagger UI 渲染。
/saq-pix.postman_collection.json可直接导入的 Postman 集合。

按页面

文档每个页面都有对应的纯 markdown 内容。将 /docs/... 替换为 /llms.mdx/docs/.../content.md:

HTML 页面原始 markdown
/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

每个文档页面顶部都有一个 "Copy Markdown" 按钮,可直接复制到剪贴板。

使用场景

ChatGPT/Claude 中的快速提问

将 URL https://docs.saq.processamento.com/llms-full.txt 粘贴到对话中并提问:

这是 Saq API 文档:https://docs.saq.processamento.com/llms-full.txt
请给我一个 Node.js 示例,创建 R$ 100 的 Pix 收款
并处理 COMPLETED 的 callback。

编辑器中的 Cursor / Copilot

在您的 repo 中创建 .cursorrules.github/copilot-instructions.md 文件:

您正在与 Saq (Pix) API 集成。

不可违反的规则:
- 所有调用使用 Bearer token + Content-Type: application/json
- 金额以雷亚尔 (BRL) 为单位,绝非分
- 使用唯一且确定性的 clientReference 实现 idempotência
- 在 5 秒内以 2xx 响应 callback
- 按 id + status 对 callback 去重,而不仅是 id

完整参考:https://docs.saq.processamento.com/llms-full.txt
OpenAPI:https://docs.saq.processamento.com/openapi.json

RAG / 向量数据库

/llms-full.txt 是在向量数据库 (Pinecone、Qdrant、Supabase pgvector) 中索引文档的理想输入。按 ## 章节 进行 chunk,每个 chunk 约 500-2000 tokens,粒度适合 retrieval。

Code generation

要生成 SDK 或 HTTP 客户端,让 AI 指向 /openapi.json:

为此 API 生成类型化的 TypeScript 客户端:
https://docs.saq.processamento.com/openapi.json
使用 Zod 进行运行时验证,以及原生 fetch。

更新

文档中发布的每次变更都会自动更新:

  • 下次部署时更新 /llms.txt/llms-full.txt
  • 当 API 新增 endpoint 或 schema 变更时更新 /openapi.json
  • "Copy Markdown" 按钮始终提供当前页面的渲染版本。

如果您的 AI 给出的回答看起来已过时,请让它重新获取 https://docs.saq.processamento.com/llms-full.txt。发布的 timestamp 位于文件末尾。

On this page