TransferEasy微信国际分账API文档

## 1.引言
本部分对TransferEasy微信国际分账接口进行详细地描述，通过该文档可以对本接口有个全面地了解，使商户技术人员尽快掌握本接口，并能够在此基础上进行开发。
#### 1.1概述
本部分详细介绍了TransferEasy微信国际分账接口进行了详细描述。接口采用https+数据签名的方式来保证商户与交易平台间的身份验证、中间信息传递的完整性，以便进行电子商务安全当中非常重要的交易身份辨识、不可抵赖、防止篡改等功能。
#### 1.2使用对象
TransferEasy商户的网上应用开发人员、维护人员和管理人员，他们应具备以下基本知识:
1. 了解上述系统上的网站设置和网页制作方法;
2. 了解HTML语言或了解JAVA、PHP、.NET 等开发语言; 
3. 了解信息安全的基本概念。

#### 1.3需求栏

| 标记 | 含义   |
|----|------|
| M  | 必填   |
| C  | 有条件的 |
| O  | 可选   |
#### 1.4接入规范
TransferEasy所有的数据提交和接收的方式皆是以post方式提交和接收。
１)数字签名
i.若无特殊说明，Transfereasy API均需签名，以便Transfereasy确认使用者身份

ii.生成私钥
用途：商户端请求API时对参数进行签名的重要参数
存储：请商户端妥善保存，切勿泄露
本地生成私钥：
openssl genrsa 2048 | openssl pkcs8 -topk8 -nocrypt -out private.key

iii.生成公钥
用途：Transfereasy对请求签名验证的重要参数
存储：登录Transfereasy商户后台系统填写保存
本地生成公钥：openssl  rsa -pubout -in private.key -out public.key

iv.生成待签名字符串
a.将请求参数（GET请求的query string，POST请求的form内容）按照参数名ASCII码从小到大排序（字典序）后，使用URL键值对的格式（即key1=value1&key2=value2…）拼接成参数字符串，注意：键值中的value需要进行URL编码。
b.在参数字符串后面拼接上Timestamp，用,隔开,得到待签名字符串。

v.生成签名
a.将待签名字符串用RSA加密，哈希算法采用SHA256，密钥使用申请服务时提交的密钥对的私钥。
b.将加密结果使用base64进行编码，得到最终的签名结果。

vi.添加请求头
每个接口的请求和响应header中都包含以下参数：

| header参数     | 说明     | 生成方法                         |
|--------------|--------|------------------------------|
| Content-Type | 内容编码类型 | 固定值：application/json         |
| MerchantNO   | 商户号    | 由Transfereasy统一生成分配          |
| ProductCode  | 产品号    | 由Transfereasy开通权限的产品号，详见产品编号，与收单产品号一致 |
| Timestamp    | 时间戳    | 即生成待签名字符串时的Timestamp         |
| Signature    | API签名  | 即生成签名中得到的结果                  |

## 2.TransferEasy上传接收分账方审核材料接口
### 2.1功能描述
商户通过上传接收分账方审核材料接口，上传审核材料（接收分账方与境外主体的合同材料和申请承诺函，详见申请承诺函范本下载地址：https://s.transfereasy.com/增加分账接收方承诺函-英文版.docx 记得盖章签字后扫描进行上传），得到文件标识 ID后，在添加分账接受方时使用。
注：两份资料分别使用文件上传 API 进行提交、获取到文件标识 ID 之后：
	a. "接收分账方与境外主体的合同材料"对应的文件标识 ID 填入添加分账接收方接口中【partnershipFileId】字段
	b. "申请承诺函"对应的文件标识 ID 填入添加分账接收方接口【applicationFileId】字段
`注意：上传文件接口 使用英文逗号和时间戳timestamp签名，file不参与签名  示例：,1705903457`

### 2.2接口地址
请求地址：`/V1/profitSharing/fileUpload`

### 2.3请求参数列表

| 参数名称                    | 参数中文名称 | 类型& 长度     | 参数说明                            | 是否必填 |
|-------------------------|--------|------------|---------------------------------|------|
| file                  | 上传文件   | file       | 上传文件后缀必须为".pdf"、".jpg"、".png"； 示例：“verify.pdf”      | M    |

###  2.4示例
```html
{
  "file": verify.pdf
}
```
### 2.5请求同步返回参数列表

| 参数名称   | 参数中文名称 | 参数说明                 |
|--------|--------|----------------------|
| status | 请求状态   | 成功SUCCESS,请求已接收      |失败FAILED             |
| code   | 状态码    | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-1/doc-21/)     |
| msg    | 状态描述   | 状态描述                 |
| data   | 数据信息   | 返回数据对象信息，在请求状态为成功时返回 |

#### 2.5.1响应参数（data，响应信息）

| 参数名称           | 参数中文名称 | 参数说明                     |
|----------------|--------|--------------------------|
| fileId | 文件标识 ID | TransferEasy 返回文件标识 ID |

### 2.6示例
```html
{
  "code": 1000,
  "msg": "Sucess",
  "status": "SUCCESS"，
  "data": {
   	"fileId": "b6a17e2a-1dc4-4376-8630-e73d06490c0d"
  },
}
```
## 3.TransferEasy 添加分账接收方接口

### 3.1功能描述
商户通过添加分账接收方接口，添加商户自己的分账接收方信息，添加成功后可用于订单分账
### 3.2接口地址
请求地址：`/V1/profitSharing/receivers`
### 3.3请求参数列表

| 参数名称    | 参数中文名称 | 类型& 长度     | 参数说明                                                 | 是否必填 |
|---------|--------|------------|------------------------------------------------------|------|
| appid    |  微信应用 ID     | String(3) | 微信配置的应用 ID 值，如公众号、小程序等。当接收方类型为PERSONAL_SUB_OPENID时，本字段必填。示例值：wx88888888 | C    |
| type | 接收方类型     | String(64) | MERCHANT_ID - 商户号;PERSONAL_SUB_OPENID - 个人 Sub OpenID| M    |
| account    |  接收方账号     | String(64) | 类型是 MERCHANT_ID 时，是商户号;类型是 PERSONAL_SUB_OPENID 时，是个人对应的 OpenID 值 | M    |
| name    |  分账接收方名称     | String(1024) | 分账接收方名称，类型为商户号时，必传| C    |
| relationType    |  与分账方的关系类型     | String(64) | SUPPLIER:供应商; DISTRIBUTOR:分销商;  TAX_SERVICE_PROVIDER:税费服商; IT_SERVICE_PROVIDER:技术服务提供方; CUSTOM:自定义 | M    |
| customRelation    |  自定义的分账关系     | String(10) | 分账方与接收方具体的关系，本字段最多 10 个字。当字段 relationType 的值为CUSTOM 时，本字段必填;当字段 relationType 的值不为 CUSTOM 时，本字段无需填写 | C    |
| scene    |  分账场景详细描述     | String(256) | 请商户对于分账场景进行具体描述。示例值：该分账接收方是境内税费服务提供方，帮助商户向境内海关代扣代缴税费。 | M    |
| settleCurrency    |  结算币种     | String(3) | 结算币种 为哪个结算币种账户创建分账接收方 | M    |
| majorService    |  接收方商户的主营业务范围     | String(256) | 描述该公司主体的主营业务范围。当接收方类型为MERCHANT_ID 时，本字段必填。示例值：税务准备服务| C    |
| applicationFileId    |  分账接收方申请函文件 ID     | String(64) | TransferEasy 返回文件标识ID，示例：“b6a17e2a-1dc4-4376-8630-e73d06490c0d” | M    |
| partnershipFileId    |  分账方与接收方合作关系证明文件 ID     | String(64) | 当接收方类型为MERCHANT_ID 时，本字段必填。TransferEasy 返回文件标识ID，示例：“b6a17e2a-1dc4-4376-8630-e73d06490c0d” | C    |
| expectedRatio    |  分账接收方预计分账比例     | Integer | 指所添加的分账接收方预计可能达到的最高分账比例，此处仅作信息收集，不代表实际最高分账比例，实际允许的最高分账比例以平台策略为准。 单位万分比，比如2000表示20%。示例：2000| M    |
### 3.4示例
```html
{
    "type":"MERCHANT_ID",
	"appid":"wxf39e7d3ffssd8b005",
	"account":"86693332",
    "customRelation":"代理商",
    "majorService":"税务准备服务",
    "name":"Merchant name",
    "relationType":"SERVICE_PROVIDER",
    "scene":"该分账接收方是境内税费服务提供方，帮助商户向境内海关代扣代缴税费。",
    "settleCurrency":"USD",
	"applicationFileId":"17b59418-b63c-4a31-953a-d10233330de",
    "partnershipFileId":"34b59418-b63c-4a31-653a-d143333380de",
	"expectedRatio":2000
}
```
### 3.5请求同步返回参数列表
| 参数名称| 参数中文名称 | 参数说明                         |
| ------------------ | ---------------------- | ------------------------------------------ |
| status             | 请求状态               | 成功SUCCESS,请求已接收失败FAILED           |
| code               | 状态码                 | 请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-1/doc-21/) |
| msg                | 状态描述               | 状态描述                                   |
| data               | 数据信息               | 返回数据对象信息，在请求状态为成功时返回   |

#### 3.5.1响应参数（data，响应信息）
| 参数名称     | 参数中文名称 | 参数说明                |
|----------|--------|---------------------|
| receiverNo  | 接收方编号     | 接收方编号，示例：”546BADF5A6CB9861”     |
| type | 接收方类型   | MERCHANT_ID - 商户号; PERSONAL_SUB_OPENID - 个人 Sub OpenID |
| account     |  接收方账号    | 类型是 MERCHANT_ID 时，是商户号;类型是 PERSONAL_SUB_OPENID 时，是个人对应的OpenID 值|
| name    |  分账接收方名称     | 分账接收方名称，类型为商户号时，必传| C    |
| relationType    |  与分账方的关系类型     | SUPPLIER:供应商;DISTRIBUTOR:分销商;TAX_SERVICE_PROVIDER:税费服务商;IT_SERVICE_PROVIDER:技术服务提供方; CUSTOM:自定义 | M    |
| customRelation    |  自定义的分账关系     |  分账方与接收方具体的关系，本字段最多 10 个字。当字段 relationType 的值为CUSTOM 时，本字段必填;当字段 relationType 的值不为 CUSTOM 时，本字段无需填写 | C    |
| scene    |  分账场景详细描述     |  请商户对于分账场景进行具体描述。示例值：该分账接收方是境内税费服务提供方，帮助商户向境内海关代扣代缴税费。 | M    |
| appid    |  微信应用 ID     | 微信配置的应用 ID 值，如公众号、小程序等。当接收方类型为PERSONAL_SUB_OPENID时，本字段必填。示例值：wx88888888 | C    |
| majorService    |  接收方商户的主营业务范围     | 描述该公司主体的主营业务范围。当接收方类型为MERCHANT_ID 时，本字段必填。示例值：税务准备服务| C    |
| applicationFileId    |  分账接收方申请函文件 ID   | TransferEasy 返回文件标识ID，示例：“b6a17e2a-1dc4-4376-8630-e73d06490c0d” | M    |
| partnershipFileId    |  分账方与接收方合作关系证明文件 ID  | 当接收方类型为MERCHANT_ID 时，本字段必填。TransferEasy 返回文件标识ID，示例：“b6a17e2a-1dc4-4376-8630-e73d06490c0d” | C    |
| state     |  接收方关系状态    | 分账方与该接收方的关系状态，仅允许对 EFFECTIVE的接收方发起分账。 INIT - 待审核，等待微信审核接收方资料EFFECTIVE - 生效中，接收方关系生效中; AUDIT_FAILED - 审核未通过，接收方审核未通过|
| failReason     |  接收关系添加失败原因    | 添加分账接收方失败的原因，只有在 state 为AUDIT_FAILED 时才会出现,PARTNERSHIP_NOT_SUPPORTED - 合作关系不支持，分账接收方合作关系不支持分账,DEFAULT_ERROR - 默认错误|
| expectedRatio    |  分账接收方预计分账比例     | 指所添加的分账接收方预计可能达到的最高分账比例，此处仅作信息收集，不代表实际最高分账比例，实际允许的最高分账比例以平台策略为准。 单位万分比，比如2000表示20%。示例：2000|
### 3.6示例
```html
{
    "status":"SUCCESS",
    "code":1000,
    "msg":"Sucess",
    "data":{
        "receiverNo":"EA9A4SSWE3I1B1Q3",
        "type":"PERSONAL_SUB_OPENID",
        "account":"o2qSSA5MZbnwfsdSFFDS3E00",
        "name":"张三",
        "state":"EFFECTIVE",
        "relationType":"CUSTOM",
        "customRelation":"代理商",
        "scene":"该分账接收方是境内税费服务提供方，帮助商户向境内海关代扣代缴税费。",
        "majorService":"税务准备服务",
        "applicationFileId":"9418-b63-ed69-4fa8-b993-9418-b63",
        "partnershipFileId":"9418-b63-ed69-4fa8-b993-9418-b63",
		"expectedRatio":2000
    }
}
```
## 4.TransferEasy 查询分账接收方接口

### 4.1功能描述
商户通过分账接收方查询接口查询 TransferEasy 平台添加分账接收方结果，并且通过主动查询接口来获知分账接收方信息。

### 4.2接口地址
请求地址：`/V1/profitSharing/getReceivers`
### 4.3请求参数列表
|参数名称   | 参数中文名称| 类型& 长度| 参数说明                                         | 是否必填|
| ---------| ---------------------- | -------------------- | ----------------------------------------- | ------------------ |
| receiverNo  | 接收方编号     | String(64) |接收方编号，示例：”546BADF5A6CB9861”     |M|

### 4.4示例
```html
{
   "receiverNo": "546BADF5A6CB9861"
}
```
### 4.5请求同步返回参数列表
| 参数名称| 参数中文名称 | 参数说明                         |
| ------------------ | ---------------------- | ------------------------------------------ |
| status             | 请求状态               | 成功SUCCESS,请求已接收失败FAILED           |
| code               | 状态码                 | 请求状态码，请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-1/doc-21/)     |
| msg                | 状态描述               | 状态描述                                   |
| data               | 数据信息               | 返回数据对象信息，在请求状态为成功时返回   |

#### 4.5.1响应参数（data，响应信息）
| 参数名称 | 参数中文名称 | 参数说明                                           |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| receiverNo  | 接收方编号     | 接收方编号，示例：”546BADF5A6CB9861”     |
| type | 接收方类型   | MERCHANT_ID - 商户号; PERSONAL_SUB_OPENID - 个人 Sub OpenID |
| account     |  接收方账号    | 类型是 MERCHANT_ID 时，是商户号;类型是 PERSONAL_SUB_OPENID 时，是个人对应的OpenID 值|
| name    |  分账接收方名称     | 分账接收方名称，类型为商户号时，必传| C    |
| relationType    |  与分账方的关系类型     | SUPPLIER:供应商;DISTRIBUTOR:分销商;TAX_SERVICE_PROVIDER:税费服务商;IT_SERVICE_PROVIDER:技术服务提供方; CUSTOM:自定义 | M    |
| customRelation    |  自定义的分账关系     |  分账方与接收方具体的关系，本字段最多 10 个字。当字段 relationType 的值为CUSTOM 时，本字段必填;当字段 relationType 的值不为 CUSTOM 时，本字段无需填写 | C    |
| scene    |  分账场景详细描述     |  请商户对于分账场景进行具体描述。示例值：该分账接收方是境内税费服务提供方，帮助商户向境内海关代扣代缴税费。 | M    |
| appid    |  微信应用 ID     | 微信配置的应用 ID 值，如公众号、小程序等。当接收方类型为PERSONAL_SUB_OPENID时，本字段必填。示例值：wx88888888 | C    |
| majorService    |  接收方商户的主营业务范围     | 描述该公司主体的主营业务范围。当接收方类型为MERCHANT_ID 时，本字段必填。示例值：税务准备服务| C    |
| applicationFileId    |  分账接收方申请函文件 ID   | TransferEasy 返回文件标识ID，示例：“b6a17e2a-1dc4-4376-8630-e73d06490c0d” | M    |
| partnershipFileId    |  分账方与接收方合作关系证明文件 ID  | 当接收方类型为MERCHANT_ID 时，本字段必填。TransferEasy 返回文件标识ID，示例：“b6a17e2a-1dc4-4376-8630-e73d06490c0d” | C    |
| state     |  接收方关系状态    | 分账方与该接收方的关系状态，仅允许对 EFFECTIVE的接收方发起分账。 INIT - 待审核，等待微信审核接收方资料EFFECTIVE - 生效中，接收方关系生效中; AUDIT_FAILED - 审核未通过，接收方审核未通过|
| failReason     |  接收关系添加失败原因    | 添加分账接收方失败的原因，只有在 state 为AUDIT_FAILED 时才会出现,PARTNERSHIP_NOT_SUPPORTED - 合作关系不支持，分账接收方合作关系不支持分账,DEFAULT_ERROR - 默认错误|
| expectedRatio    |  分账接收方预计分账比例     | 指所添加的分账接收方预计可能达到的最高分账比例，此处仅作信息收集，不代表实际最高分账比例，实际允许的最高分账比例以平台策略为准。 单位万分比，比如2000表示20%。示例：2000|

### 4.6示例
```html
{
    "status":"SUCCESS",
    "code":1000,
    "msg":"Sucess",
    "data":{
        "receiverNo":"EA9A4SSWE3I1B1Q3",
        "type":"PERSONAL_SUB_OPENID",
        "account":"o2qSSA5MZbnwfsdSFFDS3E00",
        "name":"张三",
        "state":"EFFECTIVE",
        "relationType":"CUSTOM",
        "customRelation":"代理商",
        "scene":"该分账接收方是境内税费服务提供方，帮助商户向境内海关代扣代缴税费。",
        "majorService":"税务准备服务",
        "applicationFileId":"9418-b63-ed69-4fa8-b993-9418-b63",
        "partnershipFileId":"9418-b63-ed69-4fa8-b993-9418-b63",
		"expectedRatio":2000
    }
}
```

## 5.TransferEasy 请求分账接口

### 5.1功能描述
商户通过请求分账接口用于在分账订单支付成功后，通讯采用 https 协议，商户通过向TransferEasy 指定的 URL 发送请求参数数据，完成分账请求。
注意：请保证分账订单已经退款完成后再进行分账操作，因为金额通过分账分出给接收方后的金额不可再进行退款。
示例：分账订单金额 10 元，分账已经分出：3 元，如果此时用户要退款 8 元或全额退款那就会退款失败，退款金额不足

### 5.2接口地址
请求地址：`/V1/profitSharing/order`

### 5.3请求参数列表
| 参数名称  |  参数中文名称  |  类型& 长度  |  参数说明  |  是否必填  |
| ------------------ | ---------------------- | -------------------- | ------------------ | ------------------ |
| outOrderNo         | 商户分账单号                 | String(64)           | 商户分账订单号为商户自行拟定，提交的订单号必须在自身平台交易中唯一       | M  |
| paymentNo         | 商户支付单号                 | String(64)           | 商户支付订单号，示例: “201901021232211023” | M  |
| appid         | 微信应用 ID                 | String(32)           | 微信配置的应用 ID 值，如公众号、小程序等。当接收方类型为PERSONAL_SUB_OPENID 时，本字段必填。示例值：wx88888888 | C  |
| isUnfreeze         | 是否解冻剩余未分账资金  | Int  | 是否解冻剩余未分账资金，可选项："1/0" ，默认 0； 注：确认解冻后，将在次工作日办理换汇及跨境结算，汇率价格以出境日为准       | O  |
| receivers         | 分账接收方明细                 | Json 数组          | 见表：5.3.1；`注：Json 数组，不是字符串， 需排序参与签名`    | M  |

#### 5.3.1请求参数（receivers，分账接收方明细）
| 参数名称  |  参数中文名称  |  类型& 长度  |  参数说明  |  是否必填  |
| ------------------ | ---------------------- | -------------------- | ------------------ | ------------------ |
| receiverNo         | 接收方编号 | String | 接收方编号，给自己分账时请直接填写商户号即可   | M  |
| amount         | 分账金额   | long  | 分账金额，取值币种的最小货币单位，详见货币列表说明| M  |
| description   | 分账描述   | String(64)  | 分账描述   | M  |
### 5.4示例
```html
{
    "appid":"wxf39e7d22228b005",
    "isUnfreeze":0,
    "outOrderNo":"1696832289534",
    "paymentNo":"20231002260923P4591",
    "receivers":[
        {
            "amount":1,
            "description":"zw分账",
            "receiverNo":"EA0A22JE7FAASB1Q3"
        },
        {
            "amount":10,
            "description":"aw分账",
            "receiverNo":"8ASSWAS138"
        }
    ]
}
```
### 5.5请求分账返回参数列表
|  参数名称  |  参数中文名称  |  参数说明                          |
| ------------------ | ---------------------- | ------------------------------------------ |
| status             | 请求状态               | 成功SUCCESS,请求已接收失败FAILED           |
| code               | 状态码                 | 请求状态码，请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-1/doc-21/)     |
| msg                | 状态描述               | 状态描述                                   |
| data               | 数据信息               | 返回数据对象信息，在请求状态为成功时返回   |

#### 5.5.1响应参数（data，响应信息）
|  参数名称  |  参数中文名称  |  参数说明                                            |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| paymentNo         | 商户支付单号                 | 同请求参数 |
| orders         | 分账单列表                 | 分账单列表 |
#### 5.5.2响应参数（orders，响应信息）
|  参数名称  |  参数中文名称  |  参数说明                                            |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| profitSharingNo          | 分账交易编号               | 分账交易编号，示例：”P2022030816263245681288564”                                     |
| outOrderNo         | 商户分账单号                 | 同请求参数 |
| state             | 分账单状态               | 分账单状态（每个接收方的分账结果请查看 receivers中的 result 字段）。PROCESSING - 处理中，FINISHED - 分账完成，示例值：FINISHED                                            |
| receivers           | 分账接收方明细               | 详见表：5.5.3                                            |

#### 5.5.3响应参数（receivers，响应信息）

| 参数名称 | 参数中文名称 | 参数说明                                           |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| receiverNo  | 接收方编号     | 接收方编号，示例：”546BADF5A6CB9861”     |
| detailNo | 分账明细交易单号   | 分账明细交易单号 |
| settleCurrency | 结算币种   | 结算币种，明细类型为UNFREEZE_TO_SPONSOR(解冻给出境)时 该字段才会被设置。示例值：HKD |
| result |  分账明细结果   | 每一笔分账明细转账的结果。PENDING - 待分账，SUCCESS - 分账成功，CLOSED - 已关闭， 示例值：SUCCESS |
| settleAmount |  结算金额 | 该笔明细通过换汇后最终结算的金额，明细类型为 UNFREEZE_TO_SPONSOR(解冻给出境)时该字段才会被设置。示例值：8.88 |
| amount |   分账金额 |  分账金额 |
| currency |   分账币种 |  分账币种 |
| description |   分账描述 |  分账描述 |
| rate |   汇率 |  汇率 |
| detailType |   分账明细类型 |  分账明细分为两类，包括分出给其他接收方和解冻给出资方。可由该字段来区分，若明细类型为 UNFREEZE_TO_SPONSOR(解冻给出资方)时，分账明细中还会返回出资方结算币种、结算金额、汇率值等信息。DISTRIBUTE_TO_OTHERS - 分出给其他接收方，UNFREEZE_TO_SPONSOR -解冻给出资方出境，示例值：DISTRIBUTE_TO_OTHERS |
| createTime | 分账明细创建时间   | 分账明细创建时间 |
| finishTime | 分账明细完成时间   | 分账明细完成时间，在分账明细结果为"SUCCESS"或"CLOSED"时才会返回，示例： "2022-03-09 17:04:46" |

### 5.6示例
```html
{
    "status":"SUCCESS",
    "code":1000,
    "msg":"Sucess",
    "data":{
        "paymentNo":"20231009160923P4444",
        "orders":[
            {
                "outOrderNo":"1696839994448",
                "profitSharingNo":"20231009162641PS444",
                "state":"PROCESSING",
                "receivers":[
                    {
                        "receiverNo":"80044448",
                        "settleCurrency":"HKD",
                        "detailNo":"2023144462642PD7631",
                        "createTime":"2023-10-09 16:26:42",
                        "result":"PENDING",
                        "settleAmount":10,
                        "rate":0.9339,
                        "amount":10,
                        "currency":"CNY",
                        "description":"aw分账",
                        "detailType":"UNFREEZE_TO_SPONSOR"
                    },
                    {
                        "receiverNo":"EA0A44FFFDI1B1Q3",
                        "detailNo":"20231009162ffDDDD7932",
                        "finishTime":"2023-10-09 16:30:42",
						"createTime":"2023-10-09 16:26:42",
                        "result":"SUCCESS",
                        "amount":1,
                        "currency":"CNY",
                        "description":"zw分账",
                        "detailType":"DISTRIBUTE_TO_OTHERS"
                    }
                ]
            }
        ]
    }
}
```
## 6.TransferEasy 分账结果查询接口

### 6.1功能描述
商户通过分账结果查询接口查询 TransferEasy 平台的分账订单状态，并且通过主动查询分账订单来获知分账订单信息。

### 6.2接口地址
请求地址：`/V1/profitSharing/order/query`

### 6.4请求参数列表

|  参数名称  |   参数中文名称  |  类型& 长度  |  参数说明  |  是否必填  |
| ------------------ | ---------------------- | -------------------- | ------------------ | ------------------ |
| outOrderNo     | 商户分账单号         | String(64)           | 商户分账订单号为商户自行拟定，提交的订单号必须在自身平台交易中唯一       | O |
| paymentNo     | 商户支付单号         | String(64)           | 商户支付订单号，示例: “201901021232211023”  | M |

### 6.5示例
```html
{
   "outOrderNo": "54875621645871789", 
   "paymentNo": '63cc3aae82e54a18afcd411dbc90ead8'
}
```

### 6.6请求同步返回参数列表
|  参数名称  |  参数中文名称  |  参数说明                          |
| ------------------ | ---------------------- | ------------------------------------------ |
| status             | 请求状态               | 成功SUCCESS,请求已接收失败FAILED           |
| code               | 状态码                 | 请求状态码，请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-1/doc-21/)    |
| msg                | 状态描述               | 状态描述                                   |
| data               | 数据信息               | 返回数据对象信息，在请求状态为成功时返回   |

#### 6.6.1响应参数（data，响应信息）
|  参数名称  |  参数中文名称  |  参数说明                                            |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| paymentNo         | 商户支付单号                 | 同请求参数 |
| orders         | 分账单列表                 | 分账单列表 |
#### 6.6.2响应参数（orders，响应信息）
|  参数名称  |  参数中文名称  |  参数说明                                            |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| profitSharingNo          | 分账交易编号               | 分账交易编号，示例：”P2022030816263245681288564”                                     |
| outOrderNo         | 商户分账单号                 | 同请求参数 |
| state             | 分账单状态               | 分账单状态（每个接收方的分账结果请查看 receivers中的 result 字段）。PROCESSING - 处理中，FINISHED - 分账完成，示例值：FINISHED                                            |
| receivers           | 分账接收方明细               | 详见表：5.5.3                                            |

#### 6.6.3响应参数（receivers，响应信息）

| 参数名称 | 参数中文名称 | 参数说明                                           |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| receiverNo  | 接收方编号     | 接收方编号，示例：”546BADF5A6CB9861”     |
| detailNo | 分账明细交易单号   | 分账明细交易单号 |
| settleCurrency | 结算币种   | 结算币种，明细类型为UNFREEZE_TO_SPONSOR(解冻给出境)时 该字段才会被设置。示例值：HKD |
| result |  分账明细结果   | 每一笔分账明细转账的结果。PENDING - 待分账，SUCCESS - 分账成功，CLOSED - 已关闭， 示例值：SUCCESS |
| settleAmount |  结算金额 | 该笔明细通过换汇后最终结算的金额，明细类型为 UNFREEZE_TO_SPONSOR(解冻给出境)时该字段才会被设置。示例值：8.88 |
| amount |   分账金额 |  分账金额 |
| currency |   分账币种 |  分账币种 |
| description |   分账描述 |  分账描述 |
| rate |   汇率 |  汇率 |
| detailType |   分账明细类型 |  分账明细分为两类，包括分出给其他接收方和解冻给出资方。可由该字段来区分，若明细类型为 UNFREEZE_TO_SPONSOR(解冻给出资方)时，分账明细中还会返回出资方结算币种、结算金额、汇率值等信息。DISTRIBUTE_TO_OTHERS - 分出给其他接收方，UNFREEZE_TO_SPONSOR -解冻给出资方出境，示例值：DISTRIBUTE_TO_OTHERS |
| channelDetailId | 通道分账明细Id   | 分账成功后接收方可在微信查看到的流水号（收款单号） |
| createTime | 分账明细创建时间   | 分账明细创建时间 |
| finishTime | 分账明细完成时间   | 分账明细完成时间，在分账明细结果为"SUCCESS"或"CLOSED"时才会返回，示例： "2022-03-09 17:04:46" |

### 6.6示例
```html
{
    "status":"SUCCESS",
    "code":1000,
    "msg":"Sucess",
    "data":{
        "paymentNo":"20231009160923P4444",
        "orders":[
            {
                "outOrderNo":"1696839994448",
                "profitSharingNo":"20231009162641PS444",
                "state":"PROCESSING",
                "receivers":[
                    {
                        "receiverNo":"80044448",
                        "settleCurrency":"HKD",
                        "detailNo":"2023144462642PD7631",
                        "createTime":"2023-10-09 16:26:42",
                        "result":"PENDING",
                        "settleAmount":10,
                        "rate":0.9339,
                        "amount":10,
                        "currency":"CNY",
                        "description":"aw分账",
                        "detailType":"UNFREEZE_TO_SPONSOR"
                    },
                    {
                        "receiverNo":"EA0A44FFFDI1B1Q3",
                        "detailNo":"20231009162ffDDDD7932",
                        "finishTime":"2023-10-09 16:30:42",
						"createTime":"2023-10-09 16:26:42",
                        "result":"SUCCESS",
                        "amount":1,
                        "currency":"CNY",
                        "description":"zw分账",
                        "detailType":"DISTRIBUTE_TO_OTHERS"
                    }
                ]
            }
        ]
    }
}
```

## 7.TransferEasy 剩余资金解冻接口

### 7.1功能描述
商户通过剩余资金解冻接口，解冻支付成功分账订单中的待分账金额，解冻发起成功后会按订单正常结算周期进行结算入账。注：发起解冻后，将在次工作日办理换汇及跨境结算，汇率价格以出境日为准。

### 7.2接口地址
请求地址：`/V1/profitSharing/unfreeze`
### 7.3请求参数列表
|  参数名称  |   参数中文名称  |  类型& 长度  |  参数说明  |  是否必填  |
| ------------------ | ---------------------- | -------------------- | ------------------ | ------------------ |
| outOrderNo     | 商户分账单号         | String(64)           | 商户分账订单号为商户自行拟定，提交的订单号必须在自身平台交易中唯一       | M |
| paymentNo     | 商户支付单号         | String(64)           | 商户支付订单号，示例: “201901021232211023”  | M |

### 7.4示例
```html
{
   "outOrderNo": "54875621645871789", 
   "paymentNo": '63cc3aae82e54a18afcd411dbc90ead8'
}
```

### 7.5解冻请求同步返回参数列表
|  参数名称  |  参数中文名称  |  参数说明                          |
| ------------------ | ---------------------- | ------------------------------------------ |
| status             | 请求状态               | 成功SUCCESS,请求已接收失败FAILED           |
| code               | 状态码                 | 请求状态码，请求状态码，[详见业务状态码](https://mrdoc.transfereasy.com/project-1/doc-21/)     |
| msg                | 状态描述               | 状态描述                                   |
| data               | 数据信息               | 返回数据对象信息，在请求状态为成功时返回   |

#### 7.5.1响应参数（data，响应信息）
|  参数名称  |  参数中文名称  |  参数说明                                            |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| paymentNo         | 商户支付单号                 | 同请求参数 |
| orders         | 分账单列表                 | 分账单列表 |
#### 7.5.2响应参数（orders，响应信息）
|  参数名称  |  参数中文名称  |  参数说明                                            |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| profitSharingNo          | 分账交易编号               | 分账交易编号，示例：”P2022030816263245681288564”                                     |
| outOrderNo         | 商户分账单号                 | 同请求参数 |
| state             | 分账单状态               | 分账单状态（每个接收方的分账结果请查看 receivers中的 result 字段）。PROCESSING - 处理中，FINISHED - 分账完成，示例值：FINISHED                                            |
| receivers           | 分账接收方明细               | 详见表：5.5.3                                            |

#### 7.5.3响应参数（receivers，响应信息）
| 参数名称 | 参数中文名称 | 参数说明                                           |
| ------------------ | ---------------------- | ------------------------------------------------------------ |
| receiverNo  | 接收方编号     | 接收方编号，示例：”546BADF5A6CB9861”     |
| detailNo | 分账明细交易单号   | 分账明细交易单号 |
| settleCurrency | 结算币种   | 结算币种，明细类型为UNFREEZE_TO_SPONSOR(解冻给出境)时 该字段才会被设置。示例值：HKD |
| result |  分账明细结果   | 每一笔分账明细转账的结果。PENDING - 待分账，SUCCESS - 分账成功，CLOSED - 已关闭， 示例值：SUCCESS |
| settleAmount |  结算金额 | 该笔明细通过换汇后最终结算的金额，明细类型为 UNFREEZE_TO_SPONSOR(解冻给出境)时该字段才会被设置。示例值：8.88 |
| amount |   分账金额 |  分账金额 |
| currency |   分账币种 |  分账币种 |
| description |   分账描述 |  分账描述 |
| detailType |   分账明细类型 |  分账明细分为两类，包括分出给其他接收方和解冻给出资方。可由该字段来区分，若明细类型为 UNFREEZE_TO_SPONSOR(解冻给出资方)时，分账明细中还会返回出资方结算币种、结算金额、汇率值等信息。DISTRIBUTE_TO_OTHERS - 分出给其他接收方，UNFREEZE_TO_SPONSOR -解冻给出资方出境，示例值：DISTRIBUTE_TO_OTHERS |
| createTime | 分账明细创建时间   | 分账明细创建时间 |
| finishTime | 分账明细完成时间   | 分账明细完成时间，在分账明细结果为"SUCCESS"或"CLOSED"时才会返回，示例： "2022-03-09 17:04:46" |

### 7.6示例
```html
{
    "status":"SUCCESS",
    "code":1000,
    "msg":"Sucess",
    "data":{
        "paymentNo":"20231009160923P4444",
        "orders":[
            {
                "outOrderNo":"1696839994448",
                "profitSharingNo":"20231009162641PS444",
                "state":"PROCESSING",
                "receivers":[
                    {
                        "receiverNo":"80044448",
                        "settleCurrency":"HKD",
                        "detailNo":"2023144462642PD7631",
                        "createTime":"2023-10-09 16:26:42",
                        "result":"PENDING",
                        "settleAmount":10,
                        "rate":0.9339,
                        "amount":10,
                        "currency":"CNY",
                        "description":"aw分账",
                        "detailType":"UNFREEZE_TO_SPONSOR"
                    },
                    {
                        "receiverNo":"EA0A44FFFDI1B1Q3",
                        "detailNo":"20231009162ffDDDD7932",
                        "finishTime":"2023-10-09 16:30:42",
						"createTime":"2023-10-09 16:26:42",
                        "result":"SUCCESS",
                        "amount":1,
                        "currency":"CNY",
                        "description":"zw分账",
                        "detailType":"DISTRIBUTE_TO_OTHERS"
                    }
                ]
            }
        ]
    }
}
```