管理后台
供派娜(PayAny)聚合支付SaaS平台用户的员工进行管理合同、商户、终端、订单、退款、争议、运单、提现、报表等。
{platform}为manager。
退款
对交易进行撤销或返还/退还给顾客部分/全额;仅限收款订单。
创建
对指定的订单退款。
请求地址:/refund/create
请求谓词:POST
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
txnId | 文本 | 是 | 交易号 | |
originalCurrency | 文本 | 是 | 原始币种 | |
originalAmount | 金额 | >0 | 是 | 原始金额 |
reason | 数值 | 否 | 原因 0:其它原因,1:退还差价,2:退还运费, 3:货物破损,4:货物丢失,5:货物漏发, 6:货物不符,7:缺货,8:质量问题, 9:协商一致 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
数值 | 是 | 退款编号 |
响应示例:
{ "status":200, "message":"ok", "data":11223344, "timestamp":1218154088000}
详情
获取指定的退款详细信息。
请求地址:/refund/get/{id}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 退款编号 为URL路径的一部分,非GET参数 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
id | 数值 | 是 | 退款编号 |
merchantId | 数值 | 是 | 商户编号 |
txnId | 文本 | 是 | 交易号 |
originalCurrency | 文本 | 是 | 原始货币 |
originalAmount | 金额 | 是 | 原始金额 |
transactionCurrency | 文本 | 是 | 交易货币 |
transactionAmount | 金额 | 是 | 交易金额 |
settleCurrency | 文本 | 是 | 结算货币 |
settleAmount | 金额 | 是 | 结算金额 |
settleFee | 金额 | 是 | 退款处理费 |
reason | 数值 | 是 | 退款原因 参考创建处声明 |
status | 数值 | 是 | 状态 0:处理中,1:已拒绝,2:已失败,3:已成功 |
dateCreated | 时间 | 是 | 创建时间 |
dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "id":11223344, "merchantId":12345678, "txnId":"20080808200808", "originalCurrency":"USD", "originalAmount":100, "transactionCurrency":"CNY", "transactionAmount":654.31, "settleCurrency":"CNY", "settleAmount":635.32, "settleFee":3.00, "reason":3, "status":0, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":null }, "timestamp":1218154088000}
审核
对指定的退款进行审核。
请求地址:/refund/set/{id}
请求谓词:PUT
请求主体:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
id | 数值 | 是 | 退款编号 为URL路径的一部分,非GET参数 | |
status | 数值 | 1 | 是 | 状态 参考详情处声明 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
布尔 | 是 | true表示设置成功 false表示设置失败 |
响应示例:
{ "status":200, "message":"ok", "data":true, "timestamp":1218154088000}
列表
以分页形式提供退款的列表或查询结果。
请求地址:/refund/list/{pageIndex}-{pageSize}
请求谓词:GET
请求参数:
名称 | 类型 | 长度 | 必须 | 说明 |
---|---|---|---|---|
pageIndex | 数值 | >=1 | 是 | 分页页码 为URL路径的一部分,非GET参数 |
pageSize | 数值 | 1~100 | 是 | 分页容量,建议20 为URL路径的一部分,非GET参数 |
refundId | 数值 | 否 | 退款编号 | |
merchantId | 数值 | 否 | 商户编号 | |
txnId | 文本 | 否 | 交易号 | |
reason | 数值 | 否 | 原因 参考详情处声明 | |
status | 数值 | 否 | 状态 参考详情处声明 | |
dateStart | 时间 yyyy-mm-dd hh:mm:ss | 否 | 起始时间,包含 如:2008-08-08 08:08:08 | |
dateEnd | 时间 yyyy-mm-dd hh:mm:ss | 否 | 截止时间,包含 如:2018-10-18 18:18:18 |
响应主体:
名称 | 类型 | 必须 | 说明 |
---|---|---|---|
pageIndex | 数值 | 是 | 分页页码 |
pageSize | 数值 | 是 | 分页容量 |
totalPageCount | 数值 | 是 | 总页数 |
totalItemCount | 数值 | 是 | 总记录数 |
items | 集合 | 是 | 对象集合,可以为空 |
items[].id | 数值 | 是 | 退款编号 |
items[].merchantId | 数值 | 是 | 商户号 |
items[].txnId | 文本 | 是 | 交易号 |
items[].originalCurrency | 文本 | 是 | 原始货币 |
items[].originalAmount | 文本 | 是 | 原始金额 |
items[].transactionCurrency | 文本 | 是 | 交易货币 |
items[].transactionAmount | 文本 | 是 | 交易金额 |
items[].settleCurrency | 文本 | 是 | 结算货币 |
items[].settleAmount | 文本 | 是 | 结算金额 |
items[].settleFee | 文本 | 是 | 退款手续费 |
items[].reason | 文本 | 是 | 原因 参考详情处声明 |
items[].status | 文本 | 是 | 状态 参考详情处声明 |
items[].dateCreated | 时间 | 是 | 创建时间 |
items[].dateUpdated | 时间 | 否 | 最后变更时间 |
响应示例:
{ "status":200, "message":"ok", "data":{ "pageIndex":1, "pageSize":20, "totalPageCount":100, "totalItemCount":1998, "items":[ { "id":11223344, "merchantId":12345678, "txnId":"20080808200808", "originalCurrency":"USD", "originalAmount":100.00, "transactionCurrency":"CNY", "transactionAmount":643.15, "settleCurrency":"CNY", "settleAmount":634.21, "settleFee":3.00, "reason":3, "status":2, "dateCreated":"2008-08-08T18:18:18", "dateUpdated":"2008-08-08T18:18:18" }, //.... ] }, "timestamp":1218154088000}