用途:指导开发者查询 Payroc 卡交易结算批次数据。结算批次是按日归集的卡交易分组,通过 Reporting API 的两个只读接口获取:GET /v1/batches 按日期列出批次(可选按商户过滤),GET /v1/batches/{batchId} 按 ID 获取单个批次详情。
主要能力:列出某日全部批次、按 merchantId 过滤、游标分页、读取批次金额与交易数等字段。金额为最小货币单位整数(如 saleAmount 100 表示 1.00 美元),展示时需按最小单位换算。batchId 为整数,路径中不要加引号。merchant.merchantId 始终为字符串,merchant.processingAccountId 为数值类型。
使用方式:先调用身份服务换取 Bearer 令牌,UAT 为 POST https://identity.uat.payroc.com/authorize,生产为 POST https://identity.payroc.com/authorize,请求头 x-api-key: $PAYROC_API_KEY,响应含 access_token、expires_in(3600 秒)与 token_type。随后请求示例:curl "https://api.uat.payroc.com/v1/batches?date=2024-07-02" -H "Authorization: Bearer $ACCESS_TOKEN"。date 为必填,格式 YYYY-MM-DD,缺失返回 400。分页使用顶层 response.links 中的 after/before 游标,不要用 data[n].links,也不要同时传 after 与 before。API 密钥须来自环境变量,不得硬编码。
适用场景:对账、结算数据展示、按商户或日期核对批次金额与交易笔数。
限制:接口为只读,不覆盖批次内已结算交易、ACH 存款、争议与授权(分别由其他技能处理),也不支持写入或修改批次。UAT 环境会定期清空数据,GET /v1/batches/{batchId} 可能对早先存在的批次返回 404,属预期行为;生产环境批次记录会保留。字段名、类型与参数须以本地 references/api-schema.md 等参考文件为准,不应凭记忆猜测。若缺少 API 密钥,应提示开发者向 Payroc Integrations 团队申请,而非阻断流程。