聚合支付对接文档

# 1.API接入认证

## 1.1接口说明

> 开放平台的所有服务 URL 的请求参数分为系统级参数和业务级参数两部分，系统级参数是所有服务 API 都拥有的参数，而业务级参数由具体服务 API 定义。

## 1.2接口地址

> 请联系客户经理获取接口地址

## 1.3调用方式

> HTTP POST
参数类型为：application/x-www-form-urlencoded;charset=UTF-8

## 1.4系统级参数

> 系统级参数是由开放平台定义的一组参数，每个服务都拥有这些参数，用以传送框架级的参数信息。如 method 就是一个系统级参数，使用该参数指定业务的名称。共有 6 个系统级参数：

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | (终端编号)应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端号即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

## 1.5签名sign

1.对必传的业务级请求参数按key做升序排列。

2.把参数名和参数值连接成字符串，得到拼接字符串：<键1><值1><键2><值2><键3><值3>...
	示例：k1v1k2v2k3v3k4v4

3.将secret秘钥 拼接到参数字符串后面： <请求参数字符串><秘钥>
	示例：k1v1k2v2k3v3k4v4ABCDEFG

4.对该字符串进行SHA1运算，生成16进制SHA1字符串 ，该加密后字符串即为签名值。

5.将签名值放入系统级参数sign中，和其他参数一起调用接口即可。

## 1.6业务级参数

详见 API 接口的具体参数定义。

## 1.7附录

### 1.7.1交易状态

# 2.业务接口

## 2.1反扫码创建订单

- 接口说明

- 整合银联云闪付、微信、支付宝反扫接口，调用该接口进行反扫支付
  - 收银员使用扫码设备读取用户 APP 展示的二维码后，商家系统识别付款APP， 通过系统调用该接口发起支付

- method

rsypay.online.barcodepay

### 2.1.1请求参数

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称          | 类型   | 是否必须 | 描述                               |
| ------------- | ------ | -------- | ---------------------------------- |
| total_amount  | String | 是       | 支付金额(元)                           |
| auth_code     | String | 是       | 扫码支付授权码                     |
| pay_way       | String | 是       | 支付方式(1微信、2支付宝、3银联)    |
| out_trade_no  | String | 是       | 客户订单号                         |
| shopdate      | String | 是       | 客户系统的交易发生日期格式yyyyMMdd |
| subject       | String | 否       | 订单备注                           |
| timeout_express | String | 否       | 设置未付款交易的超时时间，一旦超时，该笔交易就会自动被关闭，取值范围：1m～15d。m-分钟，h-小时，d-天。该参数数值不接受小数点，如1.5h，可转换为90m。注意：设置了未付款交易超时时间的情况下，若我司在限定时间内没有收到成功支付通知，则会关闭交易，关闭后该笔交易若付款方支付成功的情况下，会自动原路退款至付款方。 示例值：96h 代表96小时后订单自动关闭  不传默认15m                         |
| other_content | String | 否       | 其他参数                           |

### 2.1.2响应参数

- 公共响应参数

| 名称                           | 类型    | 父级 | 描述                          |
| ------------------------------ | ------- | ---- | ----------------------------- |
| code                           | Integer |      | 状态码：返回200请求成功       |
| success                        | boolean |      | 是否成功                      |
| data                           | String  |      | 承载数据                      |
| msg                            | String  |      | 消息                          |
| sign                           | String  | data | 签名（仅加密 必传的响应参数） |
| rsy_online_barcodepay_response | String  | data | 响应业务参数集合              |

- 业务响应参数

| 名称          | 类型   | 是否必须 | 描述                                                      |
| ------------- | ------ | -------- | --------------------------------------------------------- |
| order_code    | String | 是       | 订单号                                                    |
| trade_status  | String | 是       | 交易状态，成功状态的值： TRADE_SUCCESS，其他状态参考1.7.1 |
| sub_msg       | String | 否       | 交易信息                                                  |
| total_amount  | String | 是       | 支付金额                                                  |
| out_trade_no  | String | 是       | 客户订单号                                                |
| shopdate      | String | 是       | 客户系统的交易发生日期格式yyyyMMdd                        |
| subject       | String | 否       | 订单备注                                                  |
| other_content | String | 否       | 其他参数                                                  |
| aisle_order_code | String | 否       | 条码订单号(退款接口v1.1使用)                                                  |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "sign": "ea2aa87d46238b465adce5a43e826e166995b939",
        "rsy_online_barcodepay_response": {
            "order_code": "8010120221103194205100263714",
            "out_trade_no": "666677778888",
            "total_amount": "0.02",
            "shopdate": "20221029",
            "subject": "备注123456",
            "trade_status": "WAIT_BUYER_PAY",
            "sub_msg": "101 每个二维码仅限使用一次，请刷新再试",
            "other_content": "666",
			"aisle_order_code": "83611111111111584690"
        }
    },
    "msg": "操作成功"
}
```

## 2.2主扫创建订单

- 接口说明

- 整合银联云闪付、微信、支付宝主扫接口，调用该接口进行主扫支付
  - 前端根据获取的不同支付端的用户标识 支付参数等，调用该接口生成预支付订单信息
  - 前端根据该接口返回的预支付信息，调用对应支付应用发起支付

- method

rsypay.online.pay

### 2.2.1请求参数

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称          | 类型   | 是否必须                                             | 描述                                                |
| ------------- | ------ | ---------------------------------------------------- | --------------------------------------------------- |
| total_amount  | String | 是                                                   | 支付金额(元)                                            |
| pay_way       | String | 是                                                   | 支付方式(1微信、2支付宝、3银联)                     |
| wx_auth_code  | String | 是（微信，支付宝，云闪付，必填其中一个，其它可为空） | 微信用户openId                                        |
| ali_auth_Code | String | 是（微信，支付宝，云闪付，必填其中一个，其它可为空） | 支付宝用户ID                                      |
| ysf_auth_Code | String | 是（微信，支付宝，云闪付，必填其中一个，其它可为空） | 云闪付用户授权码                                      |
| is_minipg     | String | 否                                                   | 【微信小程序支付：1】，【 微信公众号支付：2】 |
| out_trade_no  | String | 是                                                   | 客户订单号                                          |
| shopdate      | String | 是                                                   | 客户系统的交易发生日期格式yyyyMMdd                  |
| subject       | String | 否                                                   | 订单备注                                            |
| other_content | String | 否                                                   | 其他参数                                            |
| appid         | String | 否                                                   | appid 公众号或小程序支付时必传                                             |

### 2.2.2响应参数

- 公共响应参数

| 名称                    | 类型    | 父级 | 描述                          |
| ----------------------- | ------- | ---- | ----------------------------- |
| code                    | Integer |      | 状态码：返回200请求成功       |
| success                 | boolean |      | 是否成功                      |
| data                    | String  |      | 承载数据                      |
| msg                     | String  |      | 消息                          |
| sign                    | String  | data | 签名（仅加密 必传的响应参数） |
| rsy_online_pay_response | String  | data | 响应业务参数集合              |

- 业务响应参数

| 名称          | 类型   | 是否必须 | 描述                               |
| ------------- | ------ | -------- | ---------------------------------- |
| order_code    | String | 是       | 订单号                             |
| js_api        | String | 是       | 返回拉起支付的必要信息             |
| total_amount  | String | 是       | 支付金额                           |
| out_trade_no  | String | 是       | 客户订单号                         |
| shopdate      | String | 是       | 客户系统的交易发生日期格式yyyyMMdd |
| subject       | String | 否       | 订单备注                           |
| other_content | String | 否       | 其他参数                           |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "rsy_online_pay_response": {
            "order_code": "801012021110412075613184BJOg",
            "out_trade_no": "666677778888",
            "total_amount": "0.02",
            "js_api": "{\"appId\":\"wx6017696d3225dc8d\",\"timeStamp\":\"1667527678\",\"nonceStr\":\"8ceaaa4ccd3749b4a394da0fd2cd6657\",\"package\":\"prepay_id=wx041007580387244307cf50cf705d140000\",\"signType\":\"RSA\",\"paySign\":\"zH+MGPRUtDUrNJdgCEk4BfeZn5FTUkY6MGfhgVRW5VqzWy+0C1+vmfZ593sMVB0R8vtLv/dCF5Upqhauf8Ffc4QyQhX/NGVYW2BaaUaBasCji7c5mWtloTGvixzlgk/+Ok8lkIJegu4X6kb9LFJDKIXi3NzTg8NmjGBOrMD6Qly0rcIvaFRfYp3GDpOwLCVOPQRaYtvVZfZMdC3Dqr8YgQzai0YZIS+fXby/11fsG3YkVgOp3oaqnamuZjnUfTGw9Yo6RqP9FJm1nr65W3Qn8CJWzg7FxbNnnkJGjgV4BDX9Z5Ai1PXceOcsPDDjnWHs4uO297Bkik3ZZb1laIbADQ==\"}",
            "shopdate": "20221029",
            "subject": "备注123456",
            "other_content": "666"
        },
        "sign": "2e65b8b5377c0dade9bd99c6819274b4ab6f0044"
    },
    "msg": "操作成功"
}
```

## 2.3查询订单

- 接口说明

- 需要查询订单及明细状态，调用此接口

- method

rsypay.online.trade.order.query

### 2.3.1请求参数

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称         | 类型   | 是否必须 | 描述                                      |
| ------------ | ------ | -------- | ----------------------------------------- |
| order_code   | String | 是       | 系统订单号                                |
| out_trade_no | String | 是       | 客户订单号                                |
| shopdate     | String | 是       | 客户系统的 订单交易发生日期  格式yyyyMMdd |

### 2.3.2响应参数

- 公共响应参数

| 名称                             | 类型    | 父级 | 描述                          |
| -------------------------------- | ------- | ---- | ----------------------------- |
| code                             | Integer |      | 状态码：返回200请求成功       |
| success                          | boolean |      | 是否成功                      |
| data                             | String  |      | 承载数据                      |
| msg                              | String  |      | 消息                          |
| sign                             | String  | data | 签名（仅加密 必传的响应参数） |
| rsy_online_order_detail_response | String  | data | 响应业务参数集合              |

- 业务响应参数

| 名称           | 类型       | 是否必须 | 描述                                                         |
| -------------- | ---------- | -------- | ------------------------------------------------------------ |
| order_code     | String     | 是       | 订单号                                                       |
| total_amount   | BigDecimal | 是       | 交易金额(元)                                                     |
| pay_way        | Integer    | 是       | 支付方式(1微信、2支付宝、3银联)                              |
| pay_state      | Integer    | 是       | 交易状态标识(0未支付1支付成功2支付失败3取消支付4退款中5已退款6退款失败) |
| pay_state_msg  | String     | 否       | 交易状态信息                                                 |
| pay_trade_type | Integer    | 是       | 交易类型(1支付单，2退款单)                                   |
| is_refund      | Integer    | 是       | 是否有退款（0否1部分退款2全部退款）                          |
| refund_amount  | BigDecimal | 是       | 退款金额                                                     |
| rpt_pay_time   | Date       | 是       | 发起支付时间                                                 |
| out_trade_no   | String     | 是       | 客户订单号                                                   |
| shopdate       | String     | 是       | 客户系统的交易发生日期格式yyyyMMdd                           |
| subject        | String     | 否       | 订单备注                                                     |
| other_content  | String     | 否       | 其他参数                                                     |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "sign": "54c419dba88137e1a685815bdcf2aba6fae5e781",
        "rsy_online_order_detail_response": {
            "pay_state": 0,
            "pay_trade_type": 1,
            "subject": "备注123456",
            "rpt_pay_time": "2022-11-04 14:35:25",
            "pay_way": 1,
            "order_code": "8010120221104143524102903714",
            "pay_state_msg": "未支付",
            "out_trade_no": "666677778888",
            "total_amount": "0.02",
            "shopdate": "20221029",
            "refund_amount": "0.00",
            "other_content": "666",
            "is_refund": 0
        }
    },
    "msg": "操作成功"
}
```

## 2.4取消订单

- 接口说明

- 对于不需要支付的订单，可以调用接口进行关闭操作

- method

rsypay.online.trade.close

### 2.4.1请求参数

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称         | 类型   | 是否必须 | 描述                                      |
| ------------ | ------ | -------- | ----------------------------------------- |
| order_code   | String | 是       | 系统订单号                                |
| out_trade_no | String | 是       | 客户订单号                                |
| shopdate     | String | 是       | 客户系统的 订单交易发生日期  格式yyyyMMdd |

### 2.4.2响应参数

- 公共响应参数

| 名称                            | 类型    | 父级 | 描述                          |
| ------------------------------- | ------- | ---- | ----------------------------- |
| code                            | Integer |      | 状态码：返回200请求成功       |
| success                         | boolean |      | 是否成功                      |
| msg                             | String  |      | 消息                          |
| data                            | String  |      | 承载数据                      |
| sign                            | String  | data | 签名（仅加密 必传的响应参数） |
| rsy_online_trade_close_response | String  | data | 响应业务参数集合              |

- 业务响应参数

| 名称         | 类型   | 是否必须 | 描述                      |
| ------------ | ------ | -------- | ------------------------- |
| order_code   | String | 否       | 订单号                    |
| out_trade_no | String | 否       | 客户订单号                |
| status       | String | 是       | 响应代码, 成功返回success |
| status_msg   | String | 是       | 响应代码描述              |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "sign": "59d369850ea4b02bedfd929125b442543ab2314d",
        "rsy_online_trade_close_response": {
            "order_code": "8010120221104143524102903714",
            "out_trade_no": "666677778888",
            "status_msg": "取消订单成功！",
            "status": "success"
        }
    },
    "msg": "操作成功"
}
```

## 2.5订单退款

- 接口说明

- 对于支付完成的交易，需要进退款操作的，调用此接口来进行退款

- method

rsypay.online.trade.refund

### 2.5.1请求参数

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称           | 类型   | 是否必须 | 描述                                                         |
| -------------- | ------ | -------- | ------------------------------------------------------------ |
| order_code     | String | 是       | 系统原订单号                                                 |
| out_trade_no   | String | 是       | 客户原订单号                                                 |
| out_request_no | String | 是       | 生成的退款订单号，标识一次退款请求，同一笔交易多次退款需要保证唯一。 |
| shopdate       | String | 是       | 客户系统的 原订单交易发生日期  格式yyyyMMdd                  |
| refund_amount  | String | 是       | 退款金额  (元)                                                   |
| refund_reason  | String | 是       | 退款理由                                                     |

### 2.5.2响应参数

- 公共响应参数

| 名称                             | 类型    | 父级 | 描述                          |
| -------------------------------- | ------- | ---- | ----------------------------- |
| code                             | Integer |      | 状态码：返回200请求成功       |
| success                          | boolean |      | 是否成功                      |
| msg                              | String  |      | 消息                          |
| data                             | String  |      | 承载数据                      |
| sign                             | String  | data | 签名（仅加密 必传的响应参数） |
| rsy_online_trade_refund_response | String  | data | 响应业务参数集合              |

- 业务响应参数

| 名称               | 类型   | 是否必须 | 描述                      |
| ------------------ | ------ | -------- | ------------------------- |
| order_code         | String | 否       | 原支付订单号              |
| out_trade_no       | String | 否       | 原客户支付订单号          |
| order_request_code | String | 否       | 聚合平台退款订单号(可退款查询使用)            |
| out_request_No     | String | 否       | 客户退款订单号            |
| status             | String | 是       | 响应代码, 成功返回success |
| status_msg         | String | 是       | 响应代码描述              |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "sign": "42f7a8a174c7230ea3ea2694276ed33c91d12759",
        "rsy_online_trade_refund_response": {
            "order_code": "8010120221107211141100873668",
            "out_trade_no": "666677778888",
            "order_request_code": "8010120221107211207100923668",
            "status_msg": "用户发起退款成功！",
            "out_request_No": "111112222233",
            "status": "success"
        }
    },
    "msg": "操作成功"
}
```

## 2.5订单退款 v1.1

- 接口说明

- 对于支付完成的交易，需要进退款操作的，调用此接口来进行退款

- method

rsypay.online.trade.refundv1.1

### 2.5.1 请求参数 v1.1

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称             | 类型   | 是否必须 | 描述                                                         |
| ---------------- | ------ | -------- | ------------------------------------------------------------ |
| out_request_no   | String | 是       | 退款申请单号，标识一次退款请求，同一笔交易多次退款需要保证唯一。 |
| order_code       | String | 否       | 原交易平台订单号(与aisle_order_code二选一)                   |
| aisle_order_code | String | 否       | 原交易支付公司商家订单号(与order_code二选一)                 |
| refund_amount    | String | 是       | 退款金额(元)                                                     |
| refund_reason    | String | 是       | 退款理由                                                     |

### 2.5.2 响应参数 v1.1

- 公共响应参数

| 名称                             | 类型    | 父级 | 描述                              |
| -------------------------------- | ------- | ---- | --------------------------------- |
| code                             | Integer |      | 状态码：返回200请求成功           |
| success                          | boolean |      | 是否成功                          |
| msg                              | String  |      | 消息                              |
| data                             | String  |      | 承载数据                          |
| sign                             | String  | data | 签名（仅加密 键值非空的响应参数） |
| rsy_online_trade_refund_response | String  | data | 响应业务参数集合                  |

- 业务响应参数

| 名称               | 类型   | 是否必须 | 描述                           |
| ------------------ | ------ | -------- | ------------------------------ |
| out_request_No     | String | 否       | 退款申请单号                   |
| order_code         | String | 否       | 原交易平台订单号               |
| aisle_order_code   | String | 否       | 原交易支付公司商家订单号       |
| order_request_code | String | 否       | 平台退款订单号(可退款查询使用) |
| status             | String | 是       | 响应代码, 成功返回success      |
| status_msg         | String | 是       | 响应代码描述                   |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "sign": "5293728f3fe45d60f1c2475b834b5e638a21858e",
        "rsy_online_trade_refund_response": {
            "order_code": "2023112716513480101101732612",
            "order_request_code": "8010120231127165235102192612",
            "aisle_order_code": "1101729060382909378560",
            "status_msg": "用户发起退款成功！",
            "out_request_No": "20231127165232ovonmq",
            "status": "success"
        }
    },
    "msg": "操作成功"
}
```

## 2.6退款查询

- 接口说明

- 对于退款的交易，调用此接口来进行退款查询

- method

rsypay.online.trade.refund.detail

### 2.6.1请求参数

- 公共请求参数

| 名称        | 类型   | 是否必须 | 描述                                                         |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| appkey      | String | 是       | 应用键，用以确定客户端应用的身份，如 000001。应用键对应一个密钥secret。要基于平台开发应用，必须事先通过申请获取appkey/secret后，才能进行应用的开发。  终端code即为appkey |
| timestamp   | Long   | 是       | 发送请求的时间戳（秒）， 和互联网时间误差不能超过 5分钟。    |
| sign        | String | 是       | 接口调用的签名值  可验证请求参数的合法性                     |
| method      | String | 是       | 业务标识，每个业务有单独的标识                               |
| notify_url  | String | 否       | 交易成功异步通知url                                          |
| rpi_no      | String | 是       | 商户唯一编号                                                 |
| biz_content | String | 是       | 业务级请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |

- 业务请求参数

| 名称              | 类型   | 是否必须 | 描述             |
| ----------------- | ------ | -------- | ---------------- |
| refund_order_code | String | 是       | 聚合平台退款订单号 |

### 2.6.2响应参数

- 公共响应参数

| 名称                                    | 类型    | 父级 | 描述                          |
| --------------------------------------- | ------- | ---- | ----------------------------- |
| code                                    | Integer |      | 状态码：返回200请求成功       |
| success                                 | boolean |      | 是否成功                      |
| msg                                     | String  |      | 消息                          |
| data                                    | String  |      | 承载数据                      |
| sign                                    | String  | data | 签名（仅加密 必传的响应参数） |
| rsy_online_order_refund_detail_response | String  | data | 响应业务参数集合              |

- 业务响应参数

| 名称                  | 类型   | 是否必须 | 描述                                  |
| --------------------- | ------ | -------- | ------------------------------------- |
| refund_order_code     | String | 是       | 聚合平台退款订单号                      |
| out_refund_order_code | String | 是       | 商户退款订单号                        |
| refund_state          | String | 是       | 退款状态标识(4退款中5已退款6退款失败) |
| refund_state_msg      | String | 否       | 退款状态信息                          |
| refund_amount         | String | 是       | 退款金额(元)                              |

- 示例

```json
{
    "code": 200,
    "success": true,
    "data": {
        "rsy_online_order_refund_detail_response": {
            "refund_amount": "0.03",
            "refund_order_code": "8010120230825173648202990239",
            "out_refund_order_code": "20230825173641h00y14",
            "refund_state": 5,
            "refund_state_msg": "已退款"
        },
        "sign": "e6a7193aea9265b9026a872d350eacce7794f090"
    },
    "msg": "操作成功"
}
```

# 3.回调接口

- 说明
  - 各回调业务 有独自的notify_type（通知类型），用户可根据此参数区分不同回调业务
  - 回调失败 再次调用间隔时长

```java
// 回调接口统一回调间隔时长如下：（仅回调失败时，触发下次回调）
第一次瞬发， 
第二次5分钟   
第三次10分钟     
第四次30分钟  
第五次3小时  
第六次5小时  
第七次10小时
```

## 3.1支付状态回调

- 接口说明

用于通知用户订单支付信息，是否成功支付。

- 通知参数

| 名称          | 类型   | 是否必须 | 描述                                                         |
| ------------- | ------ | -------- | ------------------------------------------------------------ |
| sign          | String | 是       | 签名（仅加密 下列必传的参数），此字段不参与签名              |
| notify_type   | String | 是       | 通知类型（可区分不同的回调业务）     固定值：pay.status.sync |
| order_code    | String | 是       | 系统订单号                                                   |
| trade_status  | String | 是       | 交易目前所处的状态。成功状态的值： TRADE_SUCCESS             |
| result_note   | String | 否       | 交易结果描述，当交易失败时，保存错误描述                     |
| out_trade_no  | String | 是       | 客户订单号                                                   |
| notice_time   | String | 是       | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 2022-11-7 14:29:55 |
| total_amount  | String | 否       | 该笔订单的资金总额，单位为RMB-Yuan。取值范围为[0.01，100000000.00]，精确到小数点后两位。 |
| account_date  | String | 否       | 入账的时间                                                   |
| subject       | String | 否       | 订单备注(拉起交易时,传入的备注信息)                          |
| other_content | String | 否       | 其他参数(拉起交易时,传入的其他参数)                          |

- 返回参数

- 回调接收成功请回复 success 七个字符，否则视为回调失败。

- 示例

```
    success
    ```

## 3.2退款状态回调

- 接口说明

用于通知用户订单退款信息，是否成功退款。

- 通知参数

| 名称                   | 类型   | 是否必须 | 描述                                                         |
| ---------------------- | ------ | -------- | ------------------------------------------------------------ |
| sign                   | String | 是       | 签名（仅加密 下列必传的参数），此字段不参与签名              |
| notify_type            | String | 是       | 通知类型（可区分不同的回调业务）     固定值：refund.status.sync |
| rpt_order_request_code | String | 是       | 系统退款订单号                                               |
| out_request_no         | String | 是       | 客户退款订单号                                               |
| trade_status           | String | 是       | 交易目前所处的状态。成功状态的值： TRADE_SUCCESS             |
| notice_time            | String | 是       | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 2022-11-7 22:10:02 |

- 返回参数

- 回调接收成功请回复 success 七个字符，否则视为回调失败。

- 示例

```
    success
    ```