PayZuPayZu Docs

Postman

PayZu Pix 官方 collection 已发布在 dev.payzu.com.br(Postman),包含 29 个 endpoint,分为 7 个 folder,通过 {{token}} 使用 Bearer Auth,并提供 3 个预配置环境(Mock、Sandbox、Production)。

导入 collection

Run in Postman

或在 Postman 中通过 URL 导入:Import → Link

https://docs.payzu.com.br/payzu-pix.postman_collection.json

3 步完成设置

导入到您的 workspace

点击上方的 Run in Postman。Collection 会被 fork 到您的个人 workspace,包含完整结构:folder、认证、示例。

配置 token

在 PayZu Pix collection → Variables 标签页:

变量
baseUrlhttps://api.payzu.processamento.com/v1(默认)
token您的 PayZu Bearer token

Token 会自动出现在全部 29 个请求的 Authorization: Bearer {{token}} header 中。

测试调用

打开 Cobranças Pix → POST /pixSend。示例已预填 amountclientReferencecallbackUrl。返回的 qrCodeText 可用于任何支持 Pix 的银行进行测试。

Mock Server

为了在无需真实 token 的情况下进行开发,collection 提供了一个公共 mock server,使用 OpenAPI 中的示例进行响应。也可用于绕过 web 工具中的 CORS

https://a8aa4f94-6b53-4994-bc60-7b2347f008e1.mock.pstmn.io

在开发前端时,用它替代 https://api.payzu.processamento.com/v1

RequestMock 响应
POST /pix{ id, qrCodeText, status: "PENDING", ... }
GET /pix?clientReference=order-1{ status: "COMPLETED", ... }
GET /user/balance{ available: 12450.75, blocked: 0, ... }

Mock 基于 OpenAPI 的 examples 进行响应。不会在多次调用间保留状态,但格式与真实 API 完全一致。

最佳实践

  • 创建 fork 而不是编辑原始 collection。Fork 会接收上游更新。
  • 使用 environment 在 dev/prod 之间切换 baseUrlapi.payzu.processamento.com/v1 与 mock)。
  • 代码片段:点击任意 request 右上角的 </> 即可导出为 curl、Node、Python、Go、PHP 等格式。
  • Monitor:启用 Postman Monitor 每 5 分钟测试一次 API,故障时接收告警。

与其他可视化工具对比

功能PostmanScalarSwagger
带 CORS 的 Try-it是(无需浏览器)否(CORS 拦截)否(CORS 拦截)
公共 mock server
Environment
定时 Monitor
代码片段
浏览器内 Try-it否(Postman Web 支持)
免安装Postman Web

On this page