查询批量提现
请求方式和路径
POST /payout/v1/batch/query
请求头
| 字段名 | 类型 | 必传 | 描述 |
|---|
| content-type | string | 是 | application/json |
| x-api-key | string | 是 | Paydify提供,跟appId相同 |
| x-api-timestamp | string | 是 | 时间戳,单位毫秒 |
| x-api-signature | string | 是 | 签名,具体参看签名算法 |
请求体
| 字段名 | 类型 | 必传 | 描述 |
|---|
| batchId | string | 否 | Paydify批次号,与 mchBatchId 二选一,优先使用 batchId |
| mchBatchId | string | 否 | 商户批次号,与 batchId 二选一 |
| detailStatus | string | 否 | 按明细状态过滤,不传则返回全部明细 |
| merchantId | string | 否 | 批次归属商户 ID(子商户)。合作伙伴(Partner)凭据代发时必填;商户自有凭据可不传,默认归属凭据所属商户 |
| merchantAppId | string | 否 | 归属商户下的应用 ID,用于归属商户存在多个已授权应用时消歧。凭据覆盖该商户多个应用时必填;仅一个授权应用时可不传,系统自动匹配 |
batchId 和 mchBatchId 至少传一个,否则返回参数错误。
响应头参数
| 字段名 | 类型 | 必传 | 描述 |
|---|
| 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.batchId | string | Paydify批次号 |
| data.mchBatchId | string | 商户批次号 |
| data.batchName | string | 批次名称 |
| data.status | string | 批次状态:CREATED/PROCESSING/COMPLETED/PARTIAL_SUCCESS/FAILED |
| data.currency | string | 币种 |
| data.totalAmount | string | 批次总金额 |
| data.totalCount | int | 批次总笔数 |
| data.successCount | int | 成功笔数 |
| data.failedCount | int | 失败笔数 |
| data.successAmount | string | 成功总金额 |
| data.failedAmount | string | 失败总金额 |
| data.createTime | string | 创建时间戳,单位毫秒 |
| data.finishTime | string | 完成时间戳,单位毫秒,批次未完成时为空 |
| data.transferDetailList | array | 明细列表 |
transferDetailList 明细
| 字段名 | 类型 | 描述 |
|---|
| detailId | string | Paydify明细号 |
| mchDetailId | string | 商户明细号 |
| status | string | 明细状态:INIT/PROCESSING/SUCCESS/FAILED |
| transferAmount | string | 转账金额 |
| mchFee | string | 商户手续费 |
| network | string | 链网络 |
| address | string | 收款地址 |
| txnHash | string | 链上交易Hash,链上确认后返回 |
| remark | string | 备注 |
| errorCode | string | 错误码,仅失败时返回 |
| errorMsg | string | 错误信息,仅失败时返回 |
| finishTime | string | 明细完成时间戳,单位毫秒 |
示例
# 请求
{
"batchId": "1236740866224164865",
"mchBatchId": "",
"detailStatus": ""
}
# 成功返回值
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": {
"batchId": "4956970611319809537",
"mchBatchId": "BATCH_20260313154751_9",
"batchName": "Auto Test Batch 002",
"status": "COMPLETED",
"currency": "USDT",
"totalAmount": "3.360000000000000000",
"totalCount": 3,
"successCount": 3,
"failedCount": 0,
"successAmount": "3.360000000000000000",
"failedAmount": "0.000000000000000000",
"createTime": "1773388072000",
"finishTime": "1773392144000",
"transferDetailList": [
{
"detailId": "4956970611319809538",
"mchDetailId": "DETAIL_20260313154751_001",
"status": "SUCCESS",
"transferAmount": "1.110000000000000000",
"mchFee": "0.112000000000000000",
"network": "BSC",
"address": "0x1111111111222222222233333333334444444444",
"txnHash": "0xaaaaaaaaaaaabbbbbbbbbbbbccccccccccccddddddddddddeeeeeeeeeeee1111",
"remark": "bsc transfer 1",
"errorCode": "",
"errorMsg": "",
"finishTime": "1773392110000"
},
{
"detailId": "4956970611319809539",
"mchDetailId": "DETAIL_20260313154751_002",
"status": "SUCCESS",
"transferAmount": "1.120000000000000000",
"mchFee": "0.113000000000000000",
"network": "BSC",
"address": "0x1111111111222222222233333333334444444444",
"txnHash": "0xaaaaaaaaaaaabbbbbbbbbbbbccccccccccccddddddddddddeeeeeeeeeeee2222",
"remark": "bsc transfer 2",
"errorCode": "",
"errorMsg": "",
"finishTime": "1773392144000"
},
{
"detailId": "4956970611319809540",
"mchDetailId": "DETAIL_20260313154751_003",
"status": "SUCCESS",
"transferAmount": "1.130000000000000000",
"mchFee": "0.113100000000000000",
"network": "TRON",
"address": "TXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"txnHash": "ff078df57d8e5a92fc44f5683d5f988a3d20b5f28c4e764a6c25dea9a8e10a35",
"remark": "bsc transfer 3",
"errorCode": "",
"errorMsg": "",
"finishTime": "1773392110000"
}
]
},
"success": true
}
# 失败返回值
{
"code": "SYS_ERROR",
"message": "System error",
"messageDetail": "Error details",
"data": null,
"success": false
}