PayZuPayZu Docs

对账

实时列表

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

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

实用过滤器

过滤器描述
clientReference查找对应你订单的交易。
statusCSV:COMPLETED,PENDING。支持多个。
typeCSV:DEPOSIT,WITHDRAW,COMMISSION
dateFrom / dateTo时间窗口(ISO 8601)。
endToEndIdBacen 唯一标识符。
document, name按付款人过滤。document 仅数字(11 或 14 位)。
virtualAccount按租户过滤(多店铺)。
limit, page分页。limit 最大 100。

单笔交易详情

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

Schema 见 GET /user/transactions/{id}

异步报表

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

请求生成

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 标识每一笔收款/提现,这是你的标识符,不要只依赖 PayZu 的 id
  2. 将 callbacks 作为主要数据源,不要轮询。
  3. 每日通过报表对账:获取前一日的 CSV 并与你的数据库交叉核对。可检测遗漏的 callback。
  4. 保存 endToEndId,争议时便于在 Bacen 进行追溯。

余额

支付前查看可用余额:

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

参见 GET /user/balance

On this page