PayZuPayZu Docs

面向 AI(LLMs)

本文档既面向人类读者,也面向 AI 助手。你可以直接把内容复制到聊天里,或把 AI 指向一个固定 URL。

SKILL.md(推荐)

SKILL.md 是指导 AI 使用 PayZu API 最紧凑、最新的方式。包含不可违反规则、Node.js + Python 示例、enums、retry 策略和常见坑,全部装在一个约 9 KB 的文件里,可以塞进任何模型的上下文。

兼容: Claude Code、Claude Desktop、Cursor、GitHub Copilot、Codeium、Continue、ChatGPT、Gemini,以及任何接受 markdown 作为指令的工具。

使用方式:

  • Claude Code:保存到 ~/.claude/skills/payzu/SKILL.md 或项目内 /.claude/skills/payzu/SKILL.md
  • Cursor:粘贴到 .cursorrules.cursor/rules/payzu.mdc
  • GitHub Copilot:粘贴到 .github/copilot-instructions.md
  • ChatGPT/Gemini:把内容粘贴到 system prompt 或第一条消息
  • 任何方式通过 URL:指向 https://docs.payzu.com.br/SKILL.md
curl -o .claude/skills/payzu/SKILL.md https://docs.payzu.com.br/SKILL.md
复制并粘贴到你的 AI
现成的 prompt:将 ChatGPT、Claude、Gemini 或 Cursor 指向此文档。
你是 PayZu PayZu Processamento (Pix) API 的资深工程师专家。你的职责是为生产环境中的付费客户设计正确、地道的集成方案。

数据来源(始终只使用这些):
- 完整 markdown:https://docs.payzu.com.br/pix-processamento/llms-full.txt
- OpenAPI:https://docs.payzu.com.br/openapi.json
- Base URL:https://api.payzu.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`**,开工单时提交给 PayZu 支持团队

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

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

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

从此以后,任何关于 Pix 收款、webhook、MED、认证或错误处理的问题,都会基于真实文档来回答。

面向 AI 的端点

URL内容
/SKILL.md紧凑型 Skill(约 9 KB),包含不可违反规则、示例和 enums。可直接粘贴到 Claude/Cursor/Copilot。
/pix-processamento/llms.txtmarkdown 格式的索引,仅 Pix Processamento 的所有页面链接与描述。
/pix-processamento/llms-full.txt全部 Pix Processamento 内容合并为一个文件。可装入大多数 LLM 的上下文。
/llms.txt全局索引(所有 PayZu 产品合并)。
/llms-full.txt全局 dump(所有 PayZu 产品合并)。
/openapi.jsonAPI V1 的 OpenAPI 3 规范。endpoints、schemas、错误的唯一可信源。
/api-scalarOpenAPI 的 Scalar 交互式渲染。
/api-swaggerOpenAPI 的 Swagger UI 渲染。
/payzu-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.payzu.com.br/llms-full.txt 并提问:

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

编辑器里的 Cursor / Copilot

在仓库里创建一个 .cursorrules.github/copilot-instructions.md 文件:

你正在集成 PayZu Processamento API(Pix)。

不可违反规则:
- 所有调用都使用 Bearer token + Content-Type: application/json
- 金额以雷亚尔(BRL)为单位,绝不用分
- 使用唯一且确定性的 clientReference 保证 idempotência
- callback 必须在 5 秒内返回 2xx
- 按 id + status 去重 callback,不能只按 id

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

RAG / 向量库

/llms-full.txt 是把文档索引到向量库(Pinecone、Qdrant、Supabase pgvector)的理想输入。按 ## 章节 切分,每个 chunk 500-2000 tokens,对 retrieval 来说粒度刚好。

代码生成

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

为这个 API 生成一个类型化的 TypeScript 客户端:
https://docs.payzu.com.br/openapi.json
使用 Zod 做运行时校验,使用原生 fetch。

更新

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

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

如果你的 AI 给出的回答看起来过时了,让它重新拉取 https://docs.payzu.com.br/llms-full.txt。文件末尾有发布时间戳。

On this page