PayZuDocs
教程

每天将您的交易与我们的进行核对,实时查询流水或拉取长周期的报表,并使用您自己的引用将每笔付款与正确的订单匹配起来。

实时列表

用于实时查看交易(仪表盘、前一日对账):

curl "https://api.payzu.processamento.com/v1/user/transactions?dateFrom=2025-08-01&dateTo=2025-08-31&page=1&limit=100" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

筛选参数详情见 GET /user/transactions

列表筛选参数(clientReferencestatustypedateFrom/dateTo 时间窗口、endToEndIddocument/namevirtualAccount)记录于 分页 · 可用筛选参数

单笔交易详情

curl "https://api.payzu.processamento.com/v1/user/transactions/PAYZU2025..." \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

Schema 见 GET /user/transactions/{id}

异步报表

对于大时间窗口(月度、年度),使用三步流程。

请求生成

POST /user/report

curl -X POST https://api.payzu.processamento.com/v1/user/report \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dateFrom": "2025-01-01",
    "dateTo": "2025-12-31",
    "status": ["COMPLETED"],
    "type": ["DEPOSIT", "WITHDRAW"]
  }'

响应中包含任务的 id

跟踪状态

GET /user/report/{id}

curl "https://api.payzu.processamento.com/v1/user/report/JOB_ID" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

就绪后下载

POST /user/report/{id}/download 返回一个短时效的签名 URL,用于下载 CSV。

curl -X POST "https://api.payzu.processamento.com/v1/user/report/JOB_ID/download" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

推荐策略

  1. 使用 clientReference 标识每笔 Pix 收款/付款,这是您自己的标识符,不要仅依赖 PayZu 的 id
  2. 以 callback 作为主要数据源,不要轮询。
  3. 通过报表进行每日对账:拉取前一日的 CSV,与您的数据库交叉核对。可检测到丢失的 callback。
  4. 保存 endToEndId,在发生争议时便于在 Bacen 追踪。
  5. createdAtpaidAt 排序,绝不要按 id 排序。id 是不透明的,其中携带的日期片段精度仅到天,因此无法对同一天的两笔交易进行排序。

余额

在发起付款前查询可用余额:

curl https://api.payzu.processamento.com/v1/user/balance \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

参见 GET /user/balance

本页内容