更新时间：2021-12-16 16:18:01
inst_no： 扫呗后台代理商号（每个代理商唯一）
contract_token： 签约令牌 （每个代理商唯一，和 inst_no绑定）
merchant_no： 扫呗后台商户号（每个商户单唯一）
mch_id： 利楚微信支付服务商号（不变）
sub_mch_id： 微信特约子商户号（唯一，扫呗后台商户渠道查询可以查到）
terminal_id： 终端设备ID（添加第三方终端就有）
token： 设备支付令牌（添加第三方终端就有，和terminal_id绑定）
organization_id： 微信特约子商户机构ID（唯一）
machine_code： 设备场景码
appid： 利楚支付服务商公众号appid（wxe568c727d466aef9，不变）
sub_appid： 微信特约子商户公众号appid
k12/open/agreement/addPOSTapplication/json;charset:utf-8;请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| group_id | String | 32 | Y | 分库id |
| group_type | String | 32 | N | 分库类型 0-k12 1-高校,若未传则根据group_id查询 |
| class_name | String | 32 | N | 班级名称 分库类型为0时必传 |
| class_admin_name | String | 32 | N | 班级管理员名称 分库类型为0时必传 |
| agreement_type | String | 2 | Y | 签约类型 1:支付宝 2:微信 |
| third_user_id | String | 30 | Y | 第三方会员号（保证同一个刷脸用户在一个group_id下唯一） |
| user_name | String | 10 | Y | 用户姓名 |
| cert_type | String | 2 | N | 证件类型 1：身份证分库类型为0时必传 |
| cert_no | String | 18 | N | 用户证件号码 分库类型为0时必传 |
| user_type | String | 10 | N | 用户类型：0 学生 1 教职工 分库类型为0时必传 |
| user_mobile | String | 11 | Y | 账号绑定手机号 |
| guardian_name | String | 10 | N | 监护人姓名 |
| guardian_mobile | String | 11 | N | 监护人手机号 |
| key_sign | String | 32 | Y | 签名字符串,必传参数字典序+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
| out_user_id | String | 32 | N | 刷脸用户ID |
k12/open/agreement/updatePOSTapplication/json;charset:utf-8;注:签约驳回状态不允许修改信息，修改信息需要同步人员签约表(微信是否可以修改)
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| out_user_id | String | 32 | Y | 刷脸用户ID |
| group_id | String | 32 | Y | 分库id |
| group_type | String | 32 | N | 分库类型 0-k12 1-高校 若未传则根据group_id查询 |
| class_name | String | 32 | N | 分库名称 分库类型为0时必传 |
| class_admin_name | String | 32 | N | 分库管理员名称 |
| agreement_type | String | 2 | Y | 签约类型 1:支付宝 2:微信 |
| third_user_id | String | 30 | N | 第三方会员号（保证同一个刷脸用户在一个group_id下唯一） |
| user_name | String | 10 | Y | 用户姓名 |
| cert_type | String | 2 | N | 证件类型 1：身份证分库类型为0时必传 |
| cert_no | String | 18 | N | 用户证件号码 分库类型为0时必传 |
| user_type | String | 10 | N | 用户类型：0 学生 1 教职工 分库类型为0时必传 |
| user_info | String | 32 | N | 当签约类型为微信时必传 若用户类型 为学生则传入班级名 若为教职工则传入职业 例：高一(1)班/教师 分库类型为0时必传 |
| user_mobile | String | 11 | Y | 账号绑定手机号 |
| guardian_name | String | 10 | N | 监护人姓名 |
| guardian_mobile | String | 11 | N | 监护人手机号 |
| key_sign | String | 32 | Y | 签名字符串,必传参数字典序+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
URL:k12/open/agreement/takephoto
Method: POST
ContentType: application/json;charset:utf-8;
注：支付宝支持批量采集人脸信息；微信支持自行采集人脸信息、批量采集人脸信息
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| agreement_type | String | 2 | Y | 签约类型 1:支付宝 2:微信 |
| operator_user_id | String | 32 | Y | 操作人userid |
| out_user_id | String | 32 | Y | 刷脸用户ID |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
| extraData | String | 32 | N | 生成场景token, 支付宝详情见 https://opendocs.alipay.com/pre-apis/api_pre/alipay.commerce.educate.scene.token.create 微信详情见 https://docs.qq.com/doc/DT3pWS0VPaUFaQ0dK |
商户调用该接口可获取预签约码（presign_token），预签约码对应用户一次的签约信息，之后用户可以从商户小程序跳转到微信签约小程序时使用该预签约码进行签约。
注意：
预签约码仅有2小时有效期，超时将失效无法使用，需要重新调用本接口为用户申请新的预签约码。
URL:k12/open/agreement/facepayapply
Method: POST
ContentType: application/json
注:支付宝预签约前必须调用https://lcsw.yuque.com/eq5uy2/updyxg/tmcygw#mFtV3接口查询token
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| agreement_type | String | 2 | Y | 签约类型 1:支付宝 2:微信 |
| operator_user_id | String | 32 | Y | 操作人userid |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
| out_user_id | String | 32 | Y | 刷脸用户ID |
| limit_bank_card | String | 200 | N | 签约绑定指定卡(签约类型为2时传入) |
| ext_info | String | 200 | N | 签约绑定指定卡(签约类型为1时传入) |
limit_bank_card参数如下（微信高校暂不支持指定银行卡）
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| bank_card_number | String | 18 | Y | 银行卡号 |
| identification_name | String | 32 | Y | 开卡人姓名 |
| identification_number | String | 18 | Y | 开卡人证件号码 |
| valid_thru | String | 8 | N | 08/21 格式mm/yy，仅部分银行需要 |
| bank_type | String | 10 | N | 银行类型 建议填写，采用字符串类型的银行标识，值列表详见银行类型https://pay.weixin.qq.com/wiki/doc/api/micropay_sl.php?chapter=4_2 |
ext_info参数如下
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| useBankChannel | String | 8 | Y | 是否使用银行代扣 使用：YES ;不使用：NO |
| useBankMode | String | 16 | Y | 指定银行或指定银行卡 指定银行：BANK 指定银行卡：BANK_CARD |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
| to_appId | String | 32 | Y | 跳转小程序appid |
| extraData | String | 32 | N | 预签约参数，唤起上游小程序, 支付宝详情见 https://opendocs.alipay.com/pre-apis/api_pre/alipay.commerce.educate.scene.token.create 微信详情见 https://docs.qq.com/doc/DT3pWS0VPaUFaQ0dK |
URL:k12/open/agreement/querystatus
Method: POST
ContentType: application/json
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| agreement_type | String | 2 | Y | 签约类型 1:支付宝 2:微信 |
| operator_user_id | String | 32 | Y | 操作人userid |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
| third_user_id | String | 30 | N | 第三方会员号（唯一）如果不传则out_user_id必传 |
| out_user_id | String | 32 | N | 刷脸用户id，如果不传则third_user_id必传 |
| group_id | String | 32 | Y | 分库id |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 03用户不存在 |
| user_status | String | 1 | N | 用户状态: 0. 未采集；1.已采集；2.已签约 4.已解约 |
| face_user_id | String | 64 | N | 用户人脸id |
| user_name | String | 10 | N | 用户名 |
| out_user_id | String | 32 | N | 刷脸用户id |
商户通过调用该接口可主动解除与用户的签约关系。
注意：
• 解约后商户和用户依旧可以查询到已经解除的合约。
URL:k12/open/agreement/facepayclose
Method: POST
ContentType: application/json
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| agreement_type | String | 2 | Y | 签约类型 1:支付宝 2:微信 |
| third_user_id | String | 30 | N | 第三方会员号（唯一），如果不传则out_user_id必传 |
| out_user_id | String | 32 | N | 刷脸用户id，如果不传则third_user_id必传 |
| group_id | String | 32 | Y | 分库id |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 03用户不存在 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
URL:k12/agreement/alitokenquery
Method: POST
ContentType: application/json
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| api_ver | String | 3 | Y | 版本号，当前版本100 |
| trace_no | String | 32 | Y | 请求流水号 |
| inst_no | String | 8 | Y | 机构号 |
| merchant_no | String | 8 | Y | 商户号 |
| token | String | 500 | Y | 加密TOKEN |
| out_user_id | String | 32 | Y | 刷脸用户ID |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| trace_no | String | 32 | Y | 请求流水号 |
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名串 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
| user_status | String | 2 | N | 用户状态: 0. 未采集；1.已采集；2.已签约 3.已解约 |
| group_id | String | 32 | N | 分库id |
| group_type | String | 32 | N | 分库类型 0-k12 1-高校 |
| face_user_id | String | 16 | N | 上游faceuid |
| parent_user_id | String | 16 | N | 家长id，如是本人开通，当前id与用户id相同 |
| parent_logon_id | String | 50 | N | 家长支付宝账户的脱敏信息 |
| school_std_code | String | 100 | N | 学校外标（即学校的统一信用编码） |
签约、解约成功后（包含用户主动解约），利楚会把相关签约、解约信息异步通知给商户。
Method: POST请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| result_code | String | 2 | Y | 业务处理响应码，01成功 02失败 |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
| inst_no | String | 8 | Y | 机构号 |
| out_user_id | String | 32 | Y | 刷脸用户id |
| third_user_id | String | 30 | Y | 第三方会员id |
| group_id | String | 32 | N | 分库id |
| group_type | String | 2 | N | 分库类型 0-k12 1-高校 |
| face_user_id | String | 16 | N | 上游faceuid |
| pay_user_id | String | 16 | N | 家长id，如是本人开通，当前id与用户id相同 |
| user_status | String | 2 | N | 用户状态: 0. 未采集；1.已采集；2.已签约 3.已解约 |
| contract_time | String | 19 | N | 签约时间，示例:2016-07-01 10:00:00 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 返回信息提示，“签名失败”，“参数格式校验错误"等 |
openpos/100/schoolPosInitPOSTapplication/json请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| inst_no | String | 3 | Y | 机构号，由利楚分配 |
| terminal_mac | String | 3 | Y | 机器号，机器出厂时已经设定 |
| terminal_model | String | 15 | Y | 机器型号，如ME50N,A8 |
| trace_no | String | 32 | Y | 请求流水号 |
| serialnum | String | 2048 | N | SIM卡号 |
| version | String | 3 | Y | 版本号 固定100 |
| machine_code | String | 20 | Y | 机具类型 WX_MACHINE 微信机具、 ALI_MACHINE 支付宝机具、 ALI_GROUP_MEAL 团餐机具、 WX_K12_MACHINE 微信k12机具、 ALI_K12_MACHINE 支付宝k12机具 |
| key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数(字典序)+令牌，UTF-8编码，32位md5加密转换 |
以上为请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 响应码：01成功 ，02失败，响应码仅代表通信状态，不代表业务结果 |
| return_msg | String | 128 | Y | 返回信息提示，“凭证获取成功”，“凭证获取失败”等 |
| key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数(字典序)+令牌，UTF-8编码，32位md5加密转换 |
以上为响应参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| result_code | String | 2 | N | 业务结果：01成功 ，02失败 |
| trace_no | String | 32 | N | 请求流水号 |
| merchant_no | String | 15 | N | 商户号 |
| merchant_name | String | 100 | N | 商户名称 |
| store_no | String | 32 | N | 门店号 |
| store_name | String | 100 | N | 门店名称 |
| terminal_id | String | 8 | N | 终端号 |
| access_token | String | 32 | N | 终端令牌 |
| brand_name | String | 50 | N | 品牌名称 |
| is_oem | String | 2 | N | 是否oem[是否非扫呗] 默认0否 1是 |
| brand_logo_url | String | 225 | N | 品牌logo,url地址 |
| brand_voice_url | String | 225 | N | 品牌名称资源url文件 |
machine_code为ALI_K12_MACHINE时返回以下参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| group_id | String | 32 | N | 分库id |
| group_type | String | 32 | N | 分库类型 0-k12 1-高校 |
| group_name | String | 80 | N | 分库名称 |
| serv_mchid | String | 32 | N | 服务商户号 |
| sub_mchid | String | 32 | N | 子商户号 |
| isv_name | String | 50 | N | isv名称 |
| schoole_code | String | 32 | N | 用户所属上游机构ID |
machine_code为WX_K12_MACHINE时返回以下参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| group_id | String | 32 | N | 分库id |
| group_type | String | 32 | N | 分库类型 0-k12 1-高校 |
| group_name | String | 80 | N | 分库名称 |
| serv_mchid | String | 32 | N | 服务商户号 |
| sub_mchid | String | 32 | N | 子商户号 |
| wx_sub_app_id | String | 32 | N | 微信子商户号appid |
| wx_appid | String | 32 | N | 微信服务商appid |
| isv_name | String | 50 | N | isv名称 |
URL:k12/open/pay/facepay
Method: POST
ContentType: application/json
备注：支付项目
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| pay_ver | String | 3 | Y | 版本号，当前版本100 |
| pay_type | String | 4 | Y | 请求类型 010:微信; 020:支付宝 |
| merchant_no | String | 8 | Y | 商户号 |
| terminal_no | String | 8 | Y | 终端号 |
| terminal_trace | String | 32 | Y | 终端流水号 |
| terminal_time | String | 14 | Y | 终端流水时间:yyyyMMddHHmmss |
| machine_code | String | 20 | Y | 机具类型 WX_MACHINE 微信机具、 ALI_MACHINE 支付宝机具、 ALI_GROUP_MEAL 团餐机具、 WX_K12_MACHINE 微信k12机具、 ALI_K12_MACHINE 支付宝k12机具 |
| total_fee | String | 11 | Y | 订单金额 |
| auth_no | String | 32 | Y | 人脸识别SDK调用凭证 |
| auth_no_type | String | 2 | Y | 1付款码支付凭证 0人脸凭证 |
| sub_appid | String | 16 | N | 微信子商户appid |
| open_id | String | 32 | N | 用户身份标识, 用户open_id或者user_id |
| pay_credential | String | 32 | N | 离线人脸凭证 |
| attach | String | 128 | N | 订单特殊标识 |
| order_body | String | 128 | N | 订单备注 |
| goods_tag | String | 32 | N | 订单优惠标记，代金券或立减优惠功能的参数 |
| scene_info | String | - | N | 支付场景信息，详见scene_info定义 |
| description | String | 100 | N | 商品信息，长度不大于100 |
| settle_info | String | - | N | 结算信息，详见settle_info定义 |
| business | String | - | N | 微信业务信息，详见business定义 |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
scene_info定义如下
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| device_ip | String | 15 | Y | 设备IP，139.0.5.1 |
business定义如下
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| business_product_id | String | 2 | Y | 平台产品ID，2:K12项目,11:企业团餐 |
| business_scene_id | String | 2 | Y | 平台场景ID K12可选：3:食堂; 4:超市; 5:校医院; 6:K12测试场景 企业团餐可选：124:团餐测试; 125:企业食堂; 126:腾讯食堂 |
settle_info定义如下
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| profit_sharing | bool | 5 | N | 是否支持分账 |
返回参数
| 字段名 | 类型 | 长度 | 必传 | 备注 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 请求状态码 01请求成功 02 响应失败 |
| return_msg | String | 128 | Y | 请求返回信息 |
| result_code | String | 2 | Y | 业务状态码 01 支付成功 02 支付失败 03 支付中 |
| merchant_name | String | 80 | Y | 商户名称 |
| merchant_no | String | 15 | Y | 商户号 |
| terminal_no | String | 8 | Y | 终端号 |
| terminal_trace | String | 32 | Y | 终端流水号 |
| terminal_time | String | 14 | Y | 终端时间:yyyyMMddHHmmss |
| total_fee | String | 11 | Y | 订单金额 |
| end_time | String | 14 | Y | 支付完成时间 |
| out_trade_no | String | 32 | Y | 订单号 |
| channel_trade_no | String | 32 | Y | 官方订单号 |
| channel_order_no | String | 32 | Y | 通道订单号 |
| open_id | String | 32 | N | 用户身份标识 |
| attach | String | 128 | Y | 订单特殊备注字段 |
| bank_type | String | 5 | N | 付款银行 |
| trade_type | String | 5 | N | 支付成功才返回 "AUTH" - 行业代扣 |
| debt_state | String | 10 | N | 欠款状态 NOT_DEBT：无欠款（无垫资） DEBT：有欠款（垫资支付）REPAYMENT：（已还款） |
| description | String | 100 | N | 商品信息 |
| key_sign | String | 32 | Y | 签名 |
URL:k12/open/pay/query
Method: POST
ContentType: application/json
备注：支付项目
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| pay_ver | String | 3 | Y | 版本号，当前版本100 |
| pay_type | String | 4 | Y | 请求类型 010:微信; 020:支付宝 |
| merchant_no | String | 8 | Y | 商户号 |
| terminal_no | String | 8 | Y | 终端号 |
| terminal_trace | String | 32 | Y | 终端流水号 |
| terminal_time | String | 14 | Y | 终端流水时间:yyyyMMddHHmmss |
| pay_trace | String | 32 | N | 当前支付终端流水号，与pay_time同时传递 |
| pay_time | String | 14 | N | 当前支付终端交易时间，yyyyMMddHHmmss，全局统一时间格式，与pay_trace同时传递 |
| out_trade_no | String | 32 | N | 订单号，查询凭据，填利楚订单号、微信订单号任意一个 |
| key_sign | String | 32 | Y | 签名字符串,非空字典序参数+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名字符串,拼装所有必传参数+令牌，UTF-8编码，32位md5加密转换 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
| merchant_name | String | 40 | N | 商户名称 |
| merchant_no | String | 15 | N | 商户号 |
| terminal_id | String | 8 | N | 终端号 |
| terminal_trace | String | 32 | N | 终端流水号，商户系统的订单号，扫呗系统原样返回 |
| terminal_time | String | 14 | N | 终端交易时间，yyyyMMddHHmmss，全局统一时间格式 |
| trade_state | String | 12 | N | “SUCCESS” - 支付成功（支付成功无需处理） “REFUND" - 转入退款（支付成功无需处理） “NOTPAY” - 未支付（重试扣款） “CLOSED" - 已关闭（换单号重试） “REVOKED” - 已撤销（换单号重试） “USERPAYING” - 用户支付中（重试扣款） “PAYERROR” - 支付失败(换单号重试) |
bank_type |
String | 32 | N | 付款银行 |
receipt_fee |
String | 11 | N | 实收金额，单位分 |
| total_fee | String | 1 | N | 金额，单位分 |
| end_time | String | 14 | N | 支付完成时间，yyyyMMddHHmmss，全局统一时间格式 |
| out_trade_no | String | 32 | N | 利楚唯一订单号 |
| channel_trade_no | String | 32 | N | 微信官方订单号 |
| attach | String | 128 | N | 附加数据，原样返回 |
URL:k12/open/pay/refund
Method: POST
ContentType: application/json
备注：支付项目
请求参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| pay_ver | String | 3 | Y | 版本号，当前版本110 |
| pay_type | String | 3 | Y | 请求类型，010微信，020 支付宝,当前只支持微信 |
| merchant_no | String | 15 | Y | 商户号 |
| terminal_id | String | 8 | Y | 终端号 |
| terminal_trace | String | 32 | Y | 终端流水号，填写商户系统的订单号 |
| terminal_time | String | 14 | Y | 终端交易时间，yyyyMMddHHmmss |
| pay_trace | String | 32 | N | 当前支付终端流水号，与pay_time同时传递 |
| pay_time | String | 14 | N | 当前支付终端交易时间，yyyyMMddHHmmss，全局统一时间格式，与pay_trace同时传递 |
| out_trade_no | String | 32 | Y | 订单号，查询凭据，填利楚订单号、微信订单号任意一个 |
| refund_fee | String | 12 | Y | 退款金额，单位分 |
| key_sign | String | 32 | Y | 签名字符串,拼装所有必传参数+令牌，UTF-8编码，32位md5加密转换 |
返回参数
| 参数名称 | 类型 | 长度 | 必填 | 说明 |
|---|---|---|---|---|
| return_code | String | 2 | Y | 业务响应码，01成功 02失败 |
| return_msg | String | 128 | Y | 业务响应描述 |
| key_sign | String | 32 | Y | 签名字符串,拼装所有必传参数+令牌，UTF-8编码，32位md5加密转换 |
| result_code | String | 2 | N | 业务处理响应码，01成功 02失败 |
| merchant_name | String | 40 | N | 商户名称 |
| merchant_no | String | 15 | N | 商户号 |
| terminal_id | String | 8 | N | 终端号 |
| terminal_trace | String | 32 | N | 终端流水号，商户系统的订单号，扫呗系统原样返回 |
| terminal_time | String | 14 | N | 终端交易时间，yyyyMMddHHmmss，全局统一时间格式 |
| refund_fee | String | 11 | N | 退款金额，单位分 |
| end_time | String | 14 | N | 退款完成时间，yyyyMMddHHmmss，全局统一时间格式 |
| out_trade_no | String | 32 | N | 唯一订单号 |
| out_refund_no | String | 32 | N | 唯一退款单号 |