/basicOpen/finance/shopee/payout/list{
"operation": {
"method": "POST",
"path": "/basicOpen/finance/shopee/payout/list"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/finance/shopee/payout/list?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"compareLogic\": \"AND\",\n \"currencyCode\": \"USD\",\n \"startDate\": \"2026-03-01\",\n \"endDate\": \"2026-03-17\",\n \"length\": 20,\n \"offset\": 0,\n \"searchType\": \"1\",\n \"searchSingleValue\": \"PAY001\",\n \"sids\": [10001,10002],\n \"sites\": [\"SG\",\"MY\"],\n \"storeType\": 1\n}'",
"responseExample": {
"code": 0,
"message": "success",
"error_details": [],
"request_id": "ccafcc7d9a72484fac5a3889b5db2986.231.17611516492143035",
"response_time": "2025-10-23 00:47:29",
"data": {
"totalCount": 2,
"totalSum": {
"difference": "12.35",
"fromAmount": "980.50",
"fromCurrency": "USD",
"fromCurrencyIcon": "$",
"payoutAmount": "992.85",
"payoutCurrency": "USD",
"payoutCurrencyIcon": "$",
"settlementAdjustmentTotal": "52.35",
"settlementIncomeTotal": "940.50",
"settlementTotal": "992.85",
"totalCount": 2
},
"list": [
{
"uniqueNo": "SHOPEE-PAYOUT-001",
"payoutAmount": "520.30",
"payoutCurrencyIcon": "$",
"settlementAdjustmentTotal": "20.00",
"settlementTotal": "520.30",
"fromCurrencyIcon": "$",
"payoutCurrency": "USD",
"payoutTime": "2026-03-17 12:30:00",
"settlementIncomeTotal": "500.30",
"exchangeRate": "1.0000",
"payService": "Payoneer",
"storeName": "Shopee-SG",
"fromCurrency": "USD",
"id": 1001,
"payeeId": 99887766,
"originalPayoutTime": 1742198400,
"storeType": 1,
"fromAmount": "500.30",
"siteDisplay": "新加坡",
"storeId": 10001,
"encryptedPayoutId": 1234567890,
"site": "SG",
"storeTypeDisplay": "跨境店",
"difference": "6.20",
"platformCode": "shopee"
}
]
}
}
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | compareLogic | 字段比较条件逻辑关系 | string | — | Optional | 字段比较条件逻辑关系: AND 所有条件都满足 OR 满足任一条件 默认 AND |
| 2 | currencyCode | 目标货币代码(为空则使用原币种 | string | — | Optional | 目标货币代码(为空则使用原币种,切换后按打款时间汇率换算) |
| 3 | endDate | 结束时间(拨款时间) | string | — | Optional | 结束时间(拨款时间),格式 yyyy-MM-dd,默认当前日期 |
| 4 | envKey | 环境标识 | string | — | Optional | 环境标识 |
| 5 | exportFields | 导出字段值 | array<any> | — | Optional | 导出字段值 |
| 6 | fieldCompares | fieldCompares | array<any> | — | Optional | 字段比较条件列表(多个条件之间的逻辑关系由 compareLogic 指定) |
| 7 | length | 分页大小 | number | — | Required | 分页大小,默认 20,最大不超过 200 |
| 8 | offset | 分页偏移 | number | — | Required | 分页偏移,默认 0 |
| 9 | platformCode | 平台码 | string | — | Optional | 平台码 |
| 10 | searchExactly | 是否精确匹配 | boolean | — | Optional | 是否精确匹配 |
| 11 | searchMultiValue | 多个搜索值(精确匹配) | array<any> | — | Optional | 多个搜索值(精确匹配) |
| 12 | searchSingleValue | 单个搜索值(支持模糊匹配 | string | — | Optional | 单个搜索值(支持模糊匹配,多个值用逗号分隔) |
| 13 | searchType | 搜索类型 | string | — | Optional | 搜索类型: 1 付款ID |
| 14 | sids | 店铺 ID 数组 | array<any> | — | Optional | 店铺 ID 数组 |
| 15 | sites | 站点数组 | array<any> | — | Optional | 站点数组 |
| 16 | sortField | 排序字段 | string | — | Optional | 排序字段 |
| 17 | sortType | 排序方向 | string | — | Optional | 排序方向: 1 升序/ASC 0 降序/DESC 默认 0 |
| 18 | startDate | 开始时间(拨款时间) | string | — | Optional | 开始时间(拨款时间),格式 yyyy-MM-dd,默认当前月份第一天 |
| 19 | storeType | 店铺类型 | number | — | Optional | 店铺类型: 1 跨境店(CB) |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 状态码 | number | 0 | Required | 状态码,0:成功 |
| 2 | message | 消息提示 | string | success | Required | 消息提示 |
| 3 | error_details | 数据校验失败时的错误详情 | array<any> | [] | Required | 数据校验失败时的错误详情 |
| 4 | request_id | 请求链路id | string | ccafcc7d9a72484fac5a3889b5db2986.231.17611516492143035 | Required | 请求链路id |
| 5 | response_time | 响应时间 | string | 2025-10-23 00:47:29 | Required | 响应时间 |
| 6 | data | 响应数据 | object | — | Required | 响应数据 |
| 6.1 | totalCount | 总记录数 | number | 2 | Required | 总记录数 |
| 6.2 | totalSum | 汇总数据 | object | — | Required | 汇总数据 |
| 6.2.1 | difference | 差额汇总 | string | 12.35 | Required | 差额汇总 |
| 6.2.2 | fromAmount | 结算金额汇总 | string | 980.50 | Required | 结算金额汇总 |
| 6.2.3 | fromCurrency | 结算币种代码 | string | USD | Required | 结算币种代码 |
| 6.2.4 | fromCurrencyIcon | 结算币种图标 | string | $ | Required | 结算币种图标 |
| 6.2.5 | payoutAmount | 拨款金额汇总 | string | 992.85 | Required | 拨款金额汇总 |
| 6.2.6 | payoutCurrency | 拨款币种代码 | string | USD | Required | 拨款币种代码 |
| 6.2.7 | payoutCurrencyIcon | 拨款币种图标 | string | $ | Required | 拨款币种图标 |
| 6.2.8 | settlementAdjustmentTotal | 总调整金额汇总(Adjustment) | string | 52.35 | Required | 总调整金额汇总(Adjustment) |
| 6.2.9 | settlementIncomeTotal | 总结算金额汇总(Income) | string | 940.50 | Required | 总结算金额汇总(Income) |
| 6.2.10 | settlementTotal | 结算明细总和汇总 | string | 992.85 | Required | 结算明细总和汇总 |
| 6.2.11 | totalCount | 总记录数 | number | 2 | Required | 总记录数 |
| 6.3 | list | 列表数据 | array<object> | — | Required | 列表数据 |
| 6.3.1 | uniqueNo | 业务唯一键 | string | SHOPEE-PAYOUT-001 | Required | 业务唯一键 |
| 6.3.2 | payoutAmount | 拨款金额(拨款币种) | string | 520.30 | Required | 拨款金额(拨款币种) |
| 6.3.3 | payoutCurrencyIcon | 拨款币种图标 | string | $ | Required | 拨款币种图标 |
| 6.3.4 | settlementAdjustmentTotal | 总调整金额(Adjustment) | string | 20.00 | Required | 总调整金额(Adjustment) |
| 6.3.5 | settlementTotal | settlementTotal | string | 520.30 | Required | 结算明细总和(Income + Adjustment) |
| 6.3.6 | fromCurrencyIcon | 结算币种图标 | string | $ | Required | 结算币种图标 |
| 6.3.7 | payoutCurrency | 拨款币种 | string | USD | Required | 拨款币种 |
| 6.3.8 | payoutTime | 拨款时间 | string | 2026-03-17 12:30:00 | Required | 拨款时间 |
| 6.3.9 | settlementIncomeTotal | 总结算金额(Income) | string | 500.30 | Required | 总结算金额(Income) |
| 6.3.10 | exchangeRate | 汇率 | string | 1.0000 | Required | 汇率 |
| 6.3.11 | payService | 收款渠道 | string | Payoneer | Required | 收款渠道 |
| 6.3.12 | storeName | 店铺名 | string | Shopee-SG | Required | 店铺名 |
| 6.3.13 | fromCurrency | 结算币种 | string | USD | Required | 结算币种 |
| 6.3.14 | id | 主键 ID | number | 1001 | Required | 主键 ID |
| 6.3.15 | payeeId | 付款ID | number | 99887766 | Required | 付款ID |
| 6.3.16 | originalPayoutTime | 原始拨款时间戳 | number | 1742198400 | Required | 原始拨款时间戳 |
| 6.3.17 | storeType | 店铺类型 | number | 1 | Required | 店铺类型:1-跨境店(CB) |
| 6.3.18 | fromAmount | 结算金额(结算币种) | string | 500.30 | Required | 结算金额(结算币种) |
| 6.3.19 | siteDisplay | 站点中文展示 | string | 新加坡 | Required | 站点中文展示 |
| 6.3.20 | storeId | 店铺 ID | number | 10001 | Required | 店铺 ID |
| 6.3.21 | encryptedPayoutId | 付款加密ID | number | 1234567890 | Required | 付款加密ID |
| 6.3.22 | site | 站点代码 | string | SG | Required | 站点代码 |
| 6.3.23 | storeTypeDisplay | 店铺类型展示 | string | 跨境店 | Required | 店铺类型展示 |
| 6.3.24 | difference | 差额(总拨款金额(结算)-总订单收入-总调整费) | string | 6.20 | Required | 差额(总拨款金额(结算)-总订单收入-总调整费) |
| 6.3.25 | platformCode | 平台码 | string | shopee | Required | 平台码 |
The 回款明细 - ShopeePayout API (/basicOpen/finance/shopee/payout/list) of 领星ERP is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 领星ERP version updates.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.