获取结算文件
请求方式和路径
POST /payin/v1/getSettlementFiles
请求头
| 字段名 | 类型 | 必传 | 描述 |
|---|
| content-type | string | 是 | application/json |
| x-api-key | string | 是 | Paydify提供,跟appId相同 |
| x-api-timestamp | string | 是 | 时间戳,单位毫秒 |
| x-api-signature | string | 是 | 签名,具体参看签名算法 |
请求体
| 字段名 | 类型 | 必传 | 描述 |
|---|
| settlementDate | string(10) | 是 | 结算日期(T+1),格式:yyyy-MM-dd |
| merchantId | string(64) | 否 | 结算归属商户 ID(子商户)。合作伙伴(Partner)凭据代发时必填;商户自有凭据可不传,默认归属凭据所属商户。最长 64 字符 |
| merchantAppId | string(64) | 否 | 归属商户下的应用 ID,用于归属商户存在多个已授权应用时消歧。凭据覆盖该商户多个应用时必填;仅一个授权应用时可不传,系统自动匹配。最长 64 字符 |
响应头参数
| 字段名 | 类型 | 必传 | 描述 |
|---|
| x-api-key | string | 是 | Paydify提供,跟appId相同 |
| x-api-timestamp | string | 是 | 时间戳,单位毫秒 |
| x-api-signature | string | 是 | 签名,具体参看签名算法 |
返回值
| 字段名 | 类型 | 描述 |
|---|
| code | string | 响应码,SYS_SUCCESS表示成功 |
| message | string | 响应消息 |
| messageDetail | string | 响应消息详情 |
| success | boolean | 是否成功 |
| data | array | 结算文件列表 |
data[i].batchId | string | 结算批次号 |
data[i].appId | string | 应用 ID |
data[i].merchantId | string | 商户 ID |
data[i].merchantName | string | 商户名称 |
data[i].settlementDate | string | 结算日期(T+1),格式:yyyy-MM-dd |
data[i].summaryFileUrl | string | 汇总文件下载地址(S3 预签名链接,60 分钟有效,过期请重新调用本接口获取) |
data[i].summaryFileName | string | 汇总文件名 |
data[i].detailFileUrl | string | 明细文件下载地址(S3 预签名链接,60 分钟有效,过期请重新调用本接口获取) |
data[i].detailFileName | string | 明细文件名 |
示例
// 请求
{
"settlementDate": "2025-12-12"
}
// 成功返回值
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": [
{
"batchId": "BATCH_20251212_001",
"appId": "APP_123456",
"merchantId": "MCH_789012",
"merchantName": "示例商户",
"settlementDate": "2025-12-12",
"summaryFileUrl": "https://files.paydify.com/settlement/summary/BATCH_20251212_001.csv",
"summaryFileName": "settlement_summary_20251212.csv",
"detailFileUrl": "https://files.paydify.com/settlement/detail/BATCH_20251212_001.csv",
"detailFileName": "settlement_detail_20251212.csv"
}
],
"success": true
}
// 失败返回值
{
"code": "SYS_ERROR",
"message": "System error",
"messageDetail": "Error details",
"data": null,
"success": false
}
// 未查询到结算文件
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": [],
"success": true
}