API 列表（共30个）
| 序号 | 接口名称 | 接口描述 | 版本 |
| 结算单管理（应用开发者） | |||
| 1 | 查询结算单列表 | GET: /settlement/list | V2.00.00 |
| 2 | 查询结算单详情 | GET: /settlement/get | V2.00.00 |
| 3 | 结算失败处理 | POST: /settlement/failHandle | V2.00.00 |
| 应用配置管理（应用开发者） | |||
| 4 | 开发者绑定应用 | POST: /appInfo/bindApp | V2.00.00 |
| 5 | 查看应用参数 | GET: /appInfo/getAppInfo | V2.00.00 |
| 6 | 设置应用参数 | POST: /appInfo/updateAppInfo | V2.00.00 |
| 7 | 获取开发者全部应用 | GET: /appInfo/list | V2.00.00 |
| 8 | 获取支付渠道参数 | GET: /appInfo/getPayChannels | V2.00.00 |
| 9 | 配置支付渠道参数 | POST: /appInfo/updatePayChannel | V2.00.00 |
| 支付单管理（应用开发者） | |||
| 10 | 查询支付单列表 | GET: /pay/list | V2.00.00 |
| 11 | 查询支付单详情 | GET: /pay/get | V2.00.00 |
| 基础交易管理（应用后端-外部） | |||
| 12 | 创建支付单 | POST: /trade/createPayInfo | V2.00.00 |
| 13 | 查询支付单 | POST: /trade/getPayInfo | V2.00.00 |
| 14 | 取消支付单 | POST: /trade/cancelPayInfo | V2.00.00 |
| 15 | 创建退款单 | POST: /trade/createRefundInfo | V2.00.00 |
| 16 | 查询退款单 | POST: /trade/getRefundInfo | V2.00.00 |
| 17 | 应用方确认收货 | POST: /trade/appConfirm | V2.00.00 |
| 分润模板管理（应用后端-外部） | |||
| 18 | 获取应用下所有分润模板 | GET: /royaltyTemplate/queryAppTemplate | V2.00.00 |
| 19 | 删除分润模板 | POST: /royaltyTemplate/delete | V2.00.00 |
| 20 | 审核分润模板 | POST: /royaltyTemplate/audit | V2.00.00 |
| 21 | 查询分润模板列表 | GET: /royaltyTemplate/list | V2.00.00 |
| 22 | 查询分润模板详情 | GET: /royaltyTemplate/get | V2.00.00 |
| 23 | 添加分润模板 | POST: /royaltyTemplate/create | V2.00.00 |
| 收款账户管理（个人用户-外部） | |||
| 24 | 查看用户收款账户 | GET: /settlementAccount/get | V2.00.00 |
| 25 | 设置用户收款账户 | POST: /settlementAccount/update | V2.00.00 |
| 退款单管理（应用开发者） | |||
| 26 | 查询退款单列表 | GET: /refund/list | V2.00.00 |
| 27 | 查询退款单详情 | GET: /refund/get | V2.00.00 |
| 交易通知管理（结算云后端） | |||
| 28 | ping++异步通知结算云 | POST: /notify/public/pingAsyncNotify | V2.00.00 |
| 29 | 结算云异步通知应用方（MQ） | POST: /notify/settleAsyncNotify | V2.00.00 |
| 交易统计管理（应用开发者） | |||
| 30 | 获取应用交易信息 | GET: /statistics/queryAppTradeInfo | V2.00.00 |
一、结算单管理
结算单管理（应用开发者）
查询结算单列表
基本信息
Path： /settlement/list
Method： GET
接口描述：
根据查询条件获取结算单列表。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 应用ID，长度在1~32位之间 | |
| endTime | 否 | 结算结束时间 | |
| failureDeal | 否 | 结算失败处理方式：1线下处理2未申诉暂不处理 | |
| orderNo | 否 | 商户订单号 | |
| page | 是 | 页数 | |
| size | 是 | 每页记录数 | |
| settlementStatus | 否 | 结算状态：1结算中2已结算3结算失败 | |
| startTime | 否 | 结算开始时间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| content | object | 必须 | 结算单列表 | item 类型: object | |
| ├─ createTime | string | 必须 | 结算创建时间 | ||
| ├─ failureAmount | number | 必须 | 结算失败金额 | ||
| ├─ failureDeal | string | 必须 | 失败处理 | ||
| ├─ id | string | 必须 | 结算ID | ||
| ├─ orderNo | string | 必须 | 商户订单号 | ||
| ├─ settlementAmount | number | 必须 | 待结算金额 | ||
| ├─ settlementStatus | integer | 必须 | 结算状态:1结算中2已结算3结算失败 | ||
| ├─ settlementTime | string | 必须 | 结算处理时间 | ||
| size | integer | 必须 | 每页记录数 | ||
| number | integer | 必须 | 页数 | ||
| totalElements | integer | 必须 | 总记录数 | ||
| totalPages | integer | 必须 | 总页数 |
查询结算单详情
基本信息
Path： /settlement/get
Method： GET
接口描述：
查询某个应用结算单明细。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| settlementId | 是 | 结算单ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| count | integer | 必须 | 分润笔数 | ||
| pay | object | 必须 | 支付 | ||
| ├─ amount | number | 必须 | 支付金额 | ||
| ├─ goodsDesc | string | 必须 | 商品描述 | ||
| ├─ channelCode | string | 必须 | 支付渠道 | ||
| ├─ channelRate | number | 必须 | 渠道费率 | ||
| ├─ createTime | string | 必须 | 支付单创建时间 | ||
| ├─ remark | string | 必须 | 支付单附加说明 | ||
| ├─ orderNo | string | 必须 | 商户订单号 | ||
| ├─ payNo | string | 必须 | 内部支付流水号 | ||
| ├─ payStatus | integer | 必须 | 支付状态:1未支付2已支付3已撤销 | ||
| ├─ payTime | string | 必须 | 支付时间 | ||
| ├─ refundStatus | integer | 必须 | 退款情况:1无退款2有退款 | ||
| ├─ serviceCharge | number | 必须 | 渠道手续费 | ||
| ├─ goodsName | string | 必须 | 商品名称 | ||
| ├─ transactionNo | string | 必须 | 支付渠道流水号 | ||
| settlementInfos | object [] | 必须 | 结算明细 | item 类型: object | |
| ├─ channelCode | string | 必须 | 结算渠道 | ||
| ├─ nickName | string | 必须 | 用户昵称 | ||
| ├─ remark | string | 必须 | 备注 | ||
| ├─ settlementAccount | string | 必须 | 收款账号 | ||
| ├─ settlementAmount | number | 必须 | 分润金额 | ||
| ├─ settlementPayer | string | 必须 | 付款方 | ||
| ├─ settlementReceiver | string | 必须 | 分润方 | ||
| ├─ settlementScale | string | 必须 | 分润比例 | ||
| ├─ settlementStatus | integer | 必须 | 结算状态:1结算中2已结算3结算失败 | ||
| ├─ userId | string | 必须 | 用户名 |
结算失败处理
基本信息
Path： /settlement/failHandle
Method： POST
接口描述：
结算单明细失败处理。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| failureDeal | 是 | 结算失败处理方式：1线下处理，2未申诉暂不处理 | |
| settlementId | 是 | 结算单ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
二、应用配置管理
应用配置管理（应用开发者）
开发者绑定应用
基本信息
Path： /appInfo/bindApp
Method： POST
接口描述：
当前登录用户绑定应用。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/x-www-form-urlencoded | 是 | ||
| Body |
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
| appId | text | 是 | 基础平台appId，长度在1~32位之间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
查看应用参数
基本信息
Path： /appInfo/getAppInfo
Method： GET
接口描述：
应用基本信息参数配置。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 基础平台appId，长度在1~32位之间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appId | string | 必须 | 基础平台appId | ||
| pingAppId | string | 必须 | ping++应用appId |
设置应用参数
基本信息
Path： /appInfo/updateAppInfo
Method： POST
接口描述：
应用基本信息参数配置。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/x-www-form-urlencoded | 是 | ||
| Body |
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
| appId | text | 是 | 基础平台appId，长度在1~32位之间 | |
| pingAppId | text | 是 | ping++应用appId，pingAppId是以app_开头长度为20位的字符串 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
获取开发者全部应用
基本信息
Path： /appInfo/list
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| string [] | 非必须 | item 类型: string | |||
| ├─ | 非必须 | 应用ID |
获取支付渠道参数
基本信息
Path： /appInfo/getPayChannels
Method： GET
接口描述：
获取支付渠道参数配置。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 基础平台appId，长度在1~32位之间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| object [] | 非必须 | 集合对象 | item 类型: object | ||
| ├─ appId | string | 必须 | 基础平台appId | ||
| ├─ channelGroup | string | 必须 | 支付渠道分组 | ||
| ├─ channelCode | string | 必须 | 支付渠道标识符 | ||
| ├─ channelRate | number | 必须 | 支付渠道费率（0~100） |
配置支付渠道参数
基本信息
Path： /appInfo/updatePayChannel
Method： POST
接口描述：
为该应用添加支付渠道参数配置。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appId | string | 必须 | 基础平台appId，长度在1~32位之间 | ||
| channelInfo | object [] | 必须 | 渠道配置信息 | item 类型: object | |
| ├─ channelCode | string | 必须 | 支付渠道标识符 | ||
| ├─ channelRate | number | 必须 | 支付渠道费率（0~100） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
三、支付单管理
支付单管理（应用开发者）
查询支付单列表
基本信息
Path： /pay/list
Method： GET
接口描述：
根据查询条件查询支付单列表
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 应用ID，长度在1~32位之间 | |
| channelCode | 否 | 渠道编码值 | |
| createTimeEnd | 否 | 创建结束时间 | |
| createTimeStart | 否 | 创建开始时间 | |
| keyword | 否 | 关键词 | |
| page | 是 | 页数 | |
| size | 是 | 每页记录数 | |
| payStatus | 否 | 支付状态：1未支付2已支付3已撤销 | |
| payTimeEnd | 否 | 支付结束时间 | |
| payTimeStart | 否 | 支付开始时间 | |
| refundStatus | 否 | 退款状态：1无退款2有退款 | |
| settlementStatus | 否 | 订单结算状态：1结算中2已结算3结算失败 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| content | object [] | 必须 | 支付单列表 | item 类型: object | |
| ├─ amount | number | 必须 | 订单总金额 | ||
| ├─ channelCode | string | 必须 | 支付渠道 | ||
| ├─ createTime | string | 必须 | 创建时间 | ||
| ├─ id | string | 必须 | 支付ID | ||
| ├─ orderNo | string | 必须 | 商户订单号 | ||
| ├─ payStatus | integer | 必须 | 支付状态：1未支付2已支付3已撤销 | ||
| ├─ payTime | string | 必须 | 支付时间 | ||
| ├─ refundAmount | number | 必须 | 退款金额 | ||
| ├─ refundStatus | string | 必须 | 退款情况：1无退款2有退款 | ||
| ├─ settlementStatus | integer | 必须 | 订单结算状态：1结算中2已结算3结算失败 | ||
| ├─ goodsName | string | 必须 | 商品名称 | ||
| size | integer | 必须 | 每页记录数 | ||
| number | integer | 必须 | 页数 | ||
| totalPages | integer | 必须 | 总页数 | ||
| totalElements | integer | 必须 | 总记录数 |
查询支付单详情
基本信息
Path： /pay/get
Method： GET
接口描述：
查询指定支付单详情信息
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| payId | 是 | 支付单ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| pay | object | 必须 | 订单支付信息对象 | ||
| ├─ amount | number | 必须 | 支付金额 | ||
| ├─ goodsDesc | string | 必须 | 商品描述 | ||
| ├─ channelCode | string | 必须 | 支付渠道 | ||
| ├─ payChannelRate | number | 必须 | 渠道费率 | ||
| ├─ createTime | string | 必须 | 支付单创建时间 | ||
| ├─ remark | string | 必须 | 订单附加说明 | ||
| ├─ id | string | 必须 | 支付单ID | ||
| ├─ orderNo | string | 必须 | 商户订单号 | ||
| ├─ payNo | string | 必须 | 内部支付流水号 | ||
| ├─ payStatus | integer | 必须 | 支付状态：1未支付2已支付3已撤销 | ||
| ├─ payTime | string | 必须 | 支付时间 | ||
| ├─ refundStatus | integer | 必须 | 退款情况：1无退款2有退款 | ||
| ├─ serviceCharge | number | 必须 | 渠道手续费 | ||
| ├─ goodName | string | 必须 | 商品标题 | ||
| ├─ transactionNo | string | 必须 | 支付渠道流水号 | ||
| refunds | object [] | 必须 | 订单退款信息 | ||
| ├─ createTime | string | 必须 | 退款创建时间 | ||
| ├─ refundAmount | number | 必须 | 退款金额 | ||
| ├─ refundNo | string | 必须 | 内部退款流水号 | ||
| ├─ refundStatus | integer | 必须 | 退款状态：1处理中2退款成功3退款失败 | ||
| ├─ refundTime | string | 必须 | 退款完成时间 | ||
| ├─ transactionNo | string | 必须 | 退款渠道流水号 |
四、基础交易管理
基础交易管理（应用后端-外部）
创建支付单
基本信息
Path： /trade/createPayInfo
Method： POST
接口描述：
通过该接口进行支付下单操作，获取预支付对象。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| amount | number | 必须 | 支付金额，0.01~99999999.99元 | ||
| appId | string | 必须 | 应用ID，长度在1~32位之间 | ||
| goodsDesc | string | 必须 | 商品描述信息，不超过128个字符 | ||
| channelCode | string | 必须 | 支付渠道标识符:alipay，wx | ||
| clientIp | string | 必须 | IP地址，Ip格式 | ||
| remark | string | 必须 | 订单附加说明 | ||
| extra | object | 非必须 | 额外参数（Map结构，键值对） | ||
| orderNo | string | 必须 | 订单号 | ||
| royalty | object | 必须 | |||
| ├─ royaltyDetail | object [] | 必须 | 分润明细 | item 类型: object | |
| ├─ role | string | 必须 | 分润模板角色 | ||
| ├─ userId | string | 必须 | 用户唯一标识 | ||
| ├─ royaltyTempId | string | 必须 | 分润模板ID | ||
| goodsName | string | 必须 | 商品名称，不超过32个字符 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| createTime | string | 必须 | 支付单创建时间 | ||
| charge | string | 必须 | 支付凭证，用于客户端发起支付 | ||
| orderNo | string | 必须 | 商户订单号 | ||
| payNo | string | 必须 | 内部支付流水号 | ||
查询支付单
基本信息
Path： /trade/getPayInfo
Method： POST
接口描述：
查询支付单详细信息。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| payNo | string | 必须 | 支付流水号 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| amount | number | 必须 | 订单总金额 | ||
| channelCode | string | 必须 | 支付渠道 | ||
| createTime | string | 必须 | 支付单创建时间 | ||
| orderNo | string | 必须 | 商户订单号 | ||
| payNo | string | 必须 | 内部支付流水号 | ||
| payStatus | integer | 必须 | 支付状态：1未支付，2已支付，3已撤销 | ||
| payTime | string | 必须 | 支付时间 |
取消支付单
基本信息
Path： /trade/cancelPayInfo
Method： POST
接口描述：
取消待支付单。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| payNo | string | 必须 | 支付流水号 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
创建退款单
基本信息
Path： /trade/createRefundInfo
Method： POST
接口描述：
申请退款。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| remark | string | 必须 | 退款附加说明，不超过100个字符 | ||
| payNo | string | 必须 | 支付流水号 | ||
| refundAmount | number | 非必须 | 退款金额，0.01~99999999.99元 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| createTime | string | 必须 | 退款单创建时间 | ||
| orderNo | string | 必须 | 商户订单号 | ||
| reundNo | string | 必须 | 内部支付流水号 |
查询退款单
基本信息
Path： /trade/getRefundInfo
Method： POST
接口描述：
查询退款单结果。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| refundNo | string | 必须 | 退款流水号 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| createTime | string | 必须 | 退款单创建时间 | ||
| remark | string | 必须 | 附加说明 | ||
| orderNo | string | 必须 | 商户订单号 | ||
| refundAmount | number | 必须 | 退款金额 | ||
| refundStatus | integer | 必须 | 退款状态：1处理中2退款成功3退款失败 | ||
| refundTime | string | 必须 | 退款时间 | ||
| refundNo | string | 必须 | 内部支付流水号 |
应用方确认收货
基本信息
Path： /trade/appConfirm
Method： POST
接口描述：
应用方同步确认触发分润，调用Ping++企业付款接口，两种：支付宝企业付款、微信企业付款到零钱或银行卡。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| Body |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| payNo | string | 必须 | 支付流水号 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
五、分润模板管理
分润模板管理（应用后端-外部）
获取应用下所有分润模板
基本信息
Path： /royaltyTemplate/queryAppTemplate
Method： GET
接口描述：
应用方调用该接口获取某个应用下的所有分润模板。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 基础平台AppId，长度在1~32位之间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| object [] | 非必须 | item 类型: object | |||
| ├─ id | string | 必须 | 分润模板ID | ||
| ├─ createTime | string | 必须 | 分润模板创建时间 | ||
| ├─ settleCycle | integer | 必须 | 结算周期（天数） | ||
| ├─ royaltyRule | object [] | 必须 | 分润规则详情 | item 类型: object | |
| ├─ role | string | 必须 | 分润角色 | ||
| ├─ royaltyMode | integer | 必须 | 分润模式：1百分比，2元 | ||
| ├─ value | integer | 必须 | 分润数值 | ||
| ├─ royaltyWay | integer | 必须 | 分润方式：1按百分比分润2按固定金额分润3按混合分润 | ||
| ├─ tempName | string | 必须 | 分润模板名称 | ||
| ├─ tempStatus | integer | 必须 | 分润模板状态：1待审核2有效3已删除 |
分润模板管理（应用开发者）
删除分润模板
基本信息
Path： /royaltyTemplate/delete
Method： POST
接口描述：
删除某个指定分润模板。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
| royaltyTempId | text | 是 | 分润模板ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
审核分润模板
基本信息
Path： /royaltyTemplate/audit
Method： POST
接口描述：
与银行对接审核分润模板，只有审核通过的才可以正常使用。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
| royaltyTempId | text | 是 | 分润模板ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
查询分润模板列表
基本信息
Path： /royaltyTemplate/list
Method： GET
接口描述：
根据查询条件获取分润模板列表。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 基础平台appId，长度在1~32位之间 | |
| createTimeStart | 否 | 创建开始时间，时间戳 | |
| createTimeEnd | 否 | 创建结束时间，时间戳 | |
| page | 是 | 页数 | |
| size | 是 | 每页记录数 | |
| royaltyWay | 否 | 分润方式：1按百分比分润2按固定金额分润3按混合分润 | |
| tempName | 否 | 分润模板名称 | |
| tempStatus | 否 | 分润模板状态：1待审核2有效3已删除 |
请求参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| content | object [] | 必须 | 分润模板列表对象 | item 类型: object | |
| ├─ id | string | 必须 | 分润模板ID | ||
| ├─ createTime | string | 必须 | 分润模板创建时间 | ||
| ├─ settleCycle | integer | 必须 | 结算周期（天数） | ||
| ├─ royaltyRule | object [] | 必须 | 分润规则详情 | item 类型: object | |
| ├─ role | string | 必须 | 分润角色 | ||
| ├─ royaltyMode | integer | 必须 | 分润模式：1百分比，2元 | ||
| ├─ value | integer | 必须 | 分润数值 | ||
| ├─ royaltyWay | integer | 必须 | 分润方式：1按百分比分润，2按固定金额分润，3按混合分润 | ||
| ├─ tempName | string | 必须 | 分润模板名称 | ||
| ├─ tempStatus | integer | 必须 | 分润模板状态：1待审核，2有效，3已删除 | ||
| size | integer | 必须 | 每页记录数 | ||
| number | integer | 必须 | 页数 | ||
| totalElements | integer | 必须 | 总记录数 | ||
| totalPages | integer | 必须 | 总页数 |
查询分润模板详情
基本信息
Path： /royaltyTemplate/get
Method： GET
接口描述：
查询指定分润模板详情信息。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| royaltyTempId | 是 | 分润模板ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| id | string | 必须 | 分润模板ID | ||
| settleCycle | integer | 必须 | 结算周期（天数） | ||
| royaltyWay | integer | 必须 | 分润方式：1按百分比分润，2按固定金额分润，3按混合分润 | ||
| royaltyRule | object [] | 必须 | 分润规则详情 | item 类型: object | |
| ├─ role | string | 必须 | 分润角色 | ||
| ├─ royaltyMode | integer | 必须 | 分润模式：1百分比，2元 | ||
| ├─ value | integer | 必须 | 分润数值 | ||
| tempName | string | 必须 | 分润模板名称 | ||
| tempRemark | string | 必须 | 分润模板描述 |
添加分润模板
基本信息
Path： /royaltyTemplate/create
Method： POST
接口描述：
添加一个新的分润模板。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appId | string | 必须 | 基础平台appId，长度在1~32位之间 | ||
| settleCycle | integer | 必须 | 结算周期（天数），必须大于等于0 | format: int32 | |
| royaltyRule | object [] | 必须 | 分润规则 | item 类型: object | |
| ├─ role | string | 必须 | 分润角色 | ||
| ├─ royaltyMode | integer | 必须 | 分润模式：1按百分比，2按固定金额，取值为1或2 | ||
| ├─ value | integer | 必须 | 分润数值，大于等于0 | format: int32 | |
| tempName | string | 必须 | 分润模板名称，长度在1~20之间 | ||
| tempRemark | string | 非必须 | 分润模板描述，长度不能超过100位 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| string | 非必须 | 返回结果对象 |
六、收款账户管理
收款账户管理（个人用户-外部）
查看用户收款账户
基本信息
Path： /settlementAccount/get
Method： GET
接口描述：
查看用户结算账户，每个用户在每个应用中最多只有一个结算账户。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 基础平台AppId，长度在1~32位之间 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appId | string | 必须 | 基础平台AppId | ||
| userId | string | 必须 | 用户标识 | ||
| channelCode | string | 必须 | 支付渠道标识符 | ||
| type | integer | 必须 | 账户类型：个人用户b2c，企业用户b2b | ||
| account | string | 必须 | 账号 |
设置用户收款账户
基本信息
Path：/settlementAccount/update
Method： POST
接口描述：
为用户添加结算账户用于结算，每个用户在每个应用中最多只能创建一个结算账户。
// 结算账号account参数说明：
// 1、alipay支付宝企业付款
// recipient 接收者支付宝账号、recipient_name 接收者姓名
// 2、wx、wx_pub、wx_lite微信企业付款// recipient 接收者的open_id、user_name 接收者姓名、// force_check 是否强制校验收款人姓名(仅当user_name参数不为空时该参数生效,企业付款至个人银行卡时，该参数无效)、// card_number 收款人银行卡号(传入该参数时，表示使用企业付款至个人银行卡,不能与recipient同时传入)、// open_bank_code// 开户银行编号(使用企业付款至个人银行卡时，该参数必传)【https://www.pingxx.com/api/%E5%BE%AE%E4%BF%A1%E4%BC%81%E4%B8%9A%E4%BB%98%E6%AC%BE%E9%93%B6%E8%A1%8C%E7%BC%96%E5%8F%B7%E8%AF%B4%E6%98%8E.html】请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appId | string | 必须 | 基础平台AppId，长度在1~32位之间 | ||
| channelCode | string | 必须 | 支付渠道标识符 | ||
| type | integer | 必须 | 账户类型：1个人用户，2企业用户，取值为1或2 | ||
| account | string | 必须 | 账号，json字符串 | ||
| nickName | string | 必须 | 用户昵称 |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
七、退款单管理
退款单管理（应用开发者）
查询退款单列表
基本信息
Path：/refund/list
Method： GET
接口描述：
根据查询条件获取退款单列表。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| appId | 是 | 应用ID，长度在1~32位之间 | |
| channelCode | 否 | 支付渠道 | |
| createTimeEnd | 否 | 创建结束时间 | |
| createTimeStart | 否 | 创建开始时间 | |
| orderNo | 否 | 商户订单号 | |
| page | 是 | 页数 | |
| size | 是 | 每页记录数 | |
| refundStatus | 否 | 退款状态：1处理中2退款成功3退款失败 | |
| refundTimeEnd | 否 | 退款结束时间 | |
| refundTimeStart | 否 | 退款开始时间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| content | object [] | 必须 | 退款单列表 | item 类型: object | |
| ├─ channelCode | string | 必须 | 支付渠道 | ||
| ├─ createTime | string | 必须 | 退款创建时间 | ||
| ├─ orderNo | string | 必须 | 商户订单号 | ||
| ├─ refundAmount | number | 必须 | 退款金额 | ||
| ├─ refundNo | string | 必须 | 结算云流水号 | ||
| ├─ id | string | 必须 | 退款记录ID | ||
| ├─ refundStatus | integer | 必须 | 退款状态：1处理中2退款成功3退款失败 | ||
| ├─ refundTime | string | 必须 | 退款完成时间 | ||
| ├─ transactionNo | string | 必须 | 退款渠道流水号 | ||
| number | integer | 必须 | 页数 | ||
| size | integer | 必须 | 每页记录数 | ||
| totalElements | integer | 必须 | 每页记录数 | ||
| totalPages | integer | 必须 | 总页数 |
查询退款单详情
基本信息
Path：/refund/get
Method： GET
接口描述：
查询指定退款单详情信息。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
| refundId | 是 | 退款单ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| createTime | string | 必须 | 退款创建时间 | ||
| remark | string | 必须 | 附加说明 | ||
| orderNo | string | 必须 | 商户订单号 | ||
| refundAmount | integer | 必须 | 退款金额 | ||
| refundNo | string | 必须 | 结算云流水号 | ||
| refundStatus | integer | 必须 | 退款状态：1处理中2退款成功3退款失败 | ||
| refundTime | string | 必须 | 退款完成时间 | ||
| transactionNo | string | 必须 | 退款渠道流水号 |
八、交易通知管理
交易通知管理（结算云后端）
ping++异步通知结算云
基本信息
Path： /notify/public/pingAsyncNotify
Method： POST
接口描述：
查询指定退款单详情信息。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| string | 非必须 | 正常返回空字符串，Ping++测试时返回"pingxx123" |
结算云异步通知应用方（MQ）
基本信息
Path： /notify/settleAsyncNotify
Method： POST
接口描述：
结算云异步通知应用。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| notifyEvent | integer | 必须 | 通知事件：pay、refund | format: int32 | |
| notifyTime | string | 必须 | 通知时间 | format: date-time | |
| orderNo | string | 必须 | 商户订单号 | ||
| result | integer | 必须 | 交易结果：1成功、2失败 | format: int32 | |
| tradeNo | string | 必须 | 交易流水号 | ||
| tradeTime | string | 必须 | 交易完成时间 | format: date-time |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
九、交易统计管理
交易统计管理（应用开发者）
获取应用交易信息
基本信息
Path： /statistics/queryAppTradeInfo
Method： GET
接口描述：
应用列表页面，获取应用交易信息展示。
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| object [] | 非必须 | item 类型: object | |||
| ├─ appId | string | 必须 | 基础平台appId | ||
| ├─ isConfig | boolean | 必须 | 应用是否已配置 | ||
| ├─ todayTradeAmount | number | 必须 | 今日交易额 | ||
| ├─ todayTradeCount | integer | 必须 | 今日交易量 | ||
| ├─ yesterdayTradeAmount | number | 必须 | 昨日交易额 | ||
| ├─ yesterdayTradeCount | integer | 必须 | 昨日交易量 |
