更新时间:2024-12-05 15:30:14
/pos/200/preauth/preAuthBar
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
pay_type | String | 3 | Y | 000自动识别 |
service_id | String | 3 | Y | 接口类型,当前类型010 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号,填写商户系统的订单号 |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
auth_no | String | 128 | Y | 授权码,客户的付款码 |
total_fee | String | 12 | Y | 金额,单位分 |
order_body | String | 128 | N | 订单描述 |
attach | String | 128 | N | 附加数据,原样返回 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数+令牌,UTF-8编码,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权成功”,“预授权支付中”,“请求受限”等 |
result_code | String | 2 | N | 业务结果:01预授权成功 02失败 ,03预授权支付中,99该条码暂不支持支付类型自动匹配 |
pay_type | String | 3 | N | 请求类型,010微信,020 支付宝, |
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,全局统一时间格式 |
total_fee | String | 12 | N | 金额,单位分 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
channel_trade_no | String | 32 | N | 通道订单号,微信订单号、支付宝订单号等 |
channel_order_no | String | 64 | N | 银行渠道订单号,微信支付时显示在支付成功页面的条码,可用作扫码查询和扫码退款时匹配 |
user_id | String | 32 | N | 付款方用户id |
attach | String | 128 | N | 附加数据,原样返回 |
pay_status_code | String | 3 | N | 交易状态 “7”,预授权成功 “3” 预授权支付中 |
store_name | String | 40 | N | 门店名称 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
/pos/200/preauth/preAuthQr
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
pay_type | String | 3 | Y | 010 微信,020 支付宝090 口碑,100 翼支付 |
service_id | String | 3 | Y | 接口类型,当前类型011 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号,填写商户系统的订单号 |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
total_fee | String | 12 | Y | 金额,单位分 |
order_body | String | 128 | N | 订单描述 |
attach | String | 128 | N | 附加数据,原样返回 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数+令牌,UTF-8编码,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权请求成功”,“预支付请求失败”等 |
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,全局统一时间格式 |
total_fee | String | 12 | N | 金额,单位分 |
qr_url | String | 128 | N | 二维码码串 |
attach | String | 128 | N | 附加数据,原样返回 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
/pos/200/preauth/preAuthQrH5pay
GET
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号,填写商户系统的订单号 |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
total_fee | String | 12 | Y | 金额,单位分 |
order_body | String | 128 | N | 订单描述 |
front_url | String | 256 | N | 前端回调地址,必须urlencode(get请求拼接需要urlencode,签名拼接不需要urlencode),不填则支付成功后不跳转 |
attach | String | 128 | N | 附加数据,原样返回 |
key_sign | String | 32 | Y | 签名字符串,字典序拼装所有非空参数+令牌,32位md5加密转换 |
/pos/200/preauth/preAuthH5pay
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
pay_type | String | 3 | Y | 支付方式,010 微信, 020 支付宝 |
service_id | String | 3 | Y | 接口类型,当前类型013 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号,填写商户系统的订单号 |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
total_fee | String | 12 | Y | 金额,单位分 |
open_id | String | 128 | N | 用户标识(微信openid,支付宝user_id),需要传入 |
order_body | String | 128 | N | 订单描述 |
attach | String | 128 | N | 附加数据,原样返回 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数+令牌,UTF-8编码,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权请求成功”,“预授权请求失败”等 |
result_code | String | 2 | N | 业务结果:01 成功 , 02 失败 |
pay_type | String | 3 | N | 请求类型,010微信,020支付宝 |
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,全局统一时间格式 |
total_fee | String | 12 | N | 金额,单位分 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
appId | String | 16 | N | 微信支付返回字段,公众号id |
timeStamp | String | 32 | N | 微信返回字段,时间戳,示例:1414561699,标准北京时间,时区为东八区,自1970年1月1日 0点0分0秒以来的秒数。注意:部分系统取到的值为毫秒级,需要转换成秒(10位数字)。 |
nonceStr | String | 32 | N | 微信返回字段,签名方式,示例:MD5,RSA |
package_str | String | 128 | N | 微信支付返回字段,订单详情扩展字符串,示例:prepay_id=123456789,统一下单接口返回的prepay_id参数值,提交格式如:prepay_id= |
signType | String | 32 | N | 微信支付返回字段,签名方式,示例:MD5,RSA |
paySign | String | 512 | N | 微信支付返回字段,签名 |
ali_trade_no | String | 32 | N | 支付宝JSAPI支付返回字段用于调起支付宝JSAPI |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
/pos/200/preauth/preAuthFacepay
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
pay_type | String | 3 | Y | 000自动识别 |
service_id | String | 3 | Y | 接口类型,当前类型010 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号,填写商户系统的订单号 |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
auth_no | String | 128 | Y | 授权码,客户的付款码 |
total_fee | String | 12 | Y | 金额,单位分 |
open_id | String | 128 | N | 用户标识 |
out_trade_no | String | 32 | N | 订单号 |
goods_detail | String | 2048 | N | 订单包含的商品列表信息 |
terminal_params | String | 2048 | N | 商户传入终端设备相关信息,具体值要和支付宝约定 |
goods_tag | String | 32 | N | 订单优惠标记 |
device_type | String | 1 | N | 新增字段,解决不同刷脸设备不需要传产品协议问题 设备类型,1支付宝自助收银设备【传协议】、2微信自助收银设备 、3支付宝蜻蜓设备、 4微信青蛙刷脸设备 5银联刷脸设备6.支付宝海马S1离线刷脸 |
sub_appid | String | 16 | N | 公众号appid |
order_body | String | 128 | N | 订单描述 |
attach | String | 128 | N | 附加数据,原样返回 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数+令牌,UTF-8编码,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权成功”,“预授权支付中”,“请求受限”等 |
result_code | String | 2 | N | 业务结果:01预授权成功 02失败 ,03预授权支付中,99该条码暂不支持支付类型自动匹配 |
pay_type | String | 3 | N | 请求类型,010微信,020 支付宝, |
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,全局统一时间格式 |
total_fee | String | 12 | N | 金额,单位分 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
channel_trade_no | String | 32 | N | 通道订单号,微信订单号、支付宝订单号等 |
channel_order_no | String | 64 | N | 银行渠道订单号,微信支付时显示在支付成功页面的条码,可用作扫码查询和扫码退款时匹配 |
user_id | String | 32 | N | 付款方用户id |
attach | String | 128 | N | 附加数据,原样返回 |
pay_status_code | String | 3 | N | 交易状态 “7”,预授权成功 “3” 预授权支付中 |
store_name | String | 40 | N | 门店名称 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
/pos/200/preauth/preAuthQueryFinal
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本 100 |
pay_type | String | 3 | Y | 请求类型,010微信,020 支付宝 |
service_id | String | 3 | Y | 接口类型,当前类型 014 |
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 | 64 | Y | 订单号,查询凭据,可填利楚订单号、微信订单号、支付宝订单号、银行卡订单号任意一个 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数+令牌,UTF-8编码,32位md5加密转换 |
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码: 01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权成功”,“预授权支付中”,“请求受限”等 |
result_code | String | 2 | N | 业务结果:01成功 ,02失败 ,具体状态和原因会在return_msg中给出解释 |
pay_type | String | 3 | N | 请求类型,010微信,020 支付宝 |
merchant_name | String | 40 | N | 商户名称 |
merchant_no | String | 15 | N | 商户号 |
terminal_id | String | 8 | N | 终端号 |
store_name | String | 32 | N | 门店名称 |
terminal_trace | String | 32 | N | 终端流水号,商户系统的查询流水号,扫呗系统原样返回 |
terminal_time | String | 14 | N | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
total_fee | String | 12 | N | 金额,单位分 |
receipt_fee | String | 12 | N | 实收金额 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
trade_state | String | 10 | N | 交易订单状态,SUCCESS支付成功,REFUND转入退款,NOTPAY未支付,CLOSED已关闭,USERPAYING用户支付中,REVOKED已撤销,NOPAY未支付支付超时,PAYERROR支付失败 |
pay_status_code | String | 1 | N | 交易状态, 预授权完成成功1,预授权失败2,预授权支付中3,预授权撤销成功4,预授权完成撤销成功5,预授权完成撤销失败6,预授权成功7,预授权撤销失败8,预授权完成失败9 |
channel_trade_no | String | 32 | N | 通道订单号,微信订单号、支付宝订单号等, |
channel_order_no | String | 64 | N | 银行渠道订单号,微信支付时显示在支付成功页面的条码,可用作扫码查询和扫码退款时匹配 |
user_id | String | 32 | N | 付款方用户id,“微信openid”、“支付宝账户”、“qq号”等, |
attach | String | 128 | N | 附加数据,原样返回, |
pay_trace | String | 32 | N | 当前支付终端流水号 |
pay_time | String | 14 | N | 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
revoke_no | String | 32 | N | 撤销订单号 |
success_no | String | 32 | N | 成功订单号 |
poundage | String | 5 | N | 手续费 |
finish_amt | String | 12 | N | 预授权完成金额,单位分 |
order_amt | String | 12 | N | 订单金额,单位分 |
orig_trade_no | String | 32 | N | 撤销原订单号 |
order_body | String | 128 | N | 订单描述 |
key_sign | String | 32 | Y | 签名字符串,拼装所有返回参数,UTF-8编码,32位md5加密转换 |
注意:
/pos/200/preauth/preAuthFinish
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
service_id | String | 3 | Y | 接口类型,当前类型015 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端退款流水号,填写商户系统的退款流水号 |
terminal_time | String | 14 | Y | 终端退款时间,yyyyMMddHHmmss,全局统一时间格式 |
finish_amt | String | 12 | Y | 预授权金额,单位分 |
out_trade_no | String | 64 | Y | 订单号,查询凭据 |
pay_trace | String | 32 | N | 当前支付终端流水号,与pay_time同时传递 |
pay_time | String | 14 | N | 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递 |
order_body | String | 128 | N | 订单描述 |
key_sign | String | 32 | Y | 签名字符串,拼装所有非空参数+令牌,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 失败 |
pay_type | String | 3 | N | 请求类型,1 微信 2__支付宝 3银行卡 |
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,全局统一时间格式 |
order_amt | String | 12 | N | 订单金额,单位分 |
finish_amt | String | 12 | N | 预授权完成金额,单位分 |
return_amt | String | 12 | N | 预授权完成退回金额,单位分 |
poundage | String | 5 | N | 手续费 |
end_time | String | 14 | N | 退款完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
orig_trade_no | String | 32 | N | 撤销原订单号 |
channel_trade_no | String | 32 | N | 通道订单号 |
channel_order_no | String | 64 | N | 银行渠道订单号 |
order_body | String | 128 | N | 订单描述 |
order_type | String | 32 | N | 02预授权撤销 03预授权完成 |
attach | String | 128 | N | 附加数据 |
pay_status_code | String | 2 | N | 交易状态, 预授权完成成功1,预授权失败2,预授权支付中3,预授权撤销成功4,预授权完成撤销成功5,预授权完成撤销失败6,预授权成功7,预授权撤销失败8,预授权完成失败9 |
store_name | String | 50 | N | 门店名称 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
/pos/200/preauth/preAuthCancel
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
service_id | String | 3 | Y | 接口类型,当前类型016 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号(socket协议:长度为6位,Http协议:长度为32位) |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号,优先使用订单号out_trade_no发起撤销,在out_trade_no获取异常的情况,可使用当前支付请求的终端交易流水号pay_trace和终端交易时间pay_time发起撤销 |
pay_trace | String | 32 | N | 当前支付终端流水号,与pay_time同时传递 |
pay_time | String | 14 | N | 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递 |
attach | String | 128 | N | 附加数据 |
order_body | String | 128 | N | 订单描述 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数+令牌,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权撤销成功”、“订单不存在”等 |
result_code | String | 2 | N | 业务结果:01预授权撤销成功 ,02预授权撤销失败 |
pay_type | String | 3 | N | 请求类型,1 微信 2__支付宝 3银行卡 |
merchant_no | String | 15 | N | 商户号 |
terminal_id | String | 8 | N | 终端号 |
terminal_trace | String | 32 | N | 终端流水号(socket协议:长度为6位,Http协议:长度为32位) |
terminal_time | String | 14 | N | 终端撤销时间,yyyyMMddHHmmss,全局统一时间格式 |
order_amt | String | 12 | N | 订单金额,单位分 |
return_amt | String | 40 | N | 预授权完成退回金额 |
poundage | String | 5 | N | 手续费 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
orig_trade_no | String | 32 | N | 撤销原订单号 |
channel_trade_no | String | 32 | N | 通道订单号 |
channel_order_no | String | 64 | N | 银行渠道订单号 |
order_body | String | 128 | N | 订单描述 |
order_type | String | 2 | Y | 02预授权撤销 03预授权完成 |
attach | String | 128 | N | 附加数据 |
pay_status_code | String | 2 | N | 交易状态 |
store_name | String | 50 | N | 门店名称 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
/pos/200/preauth/preAuthRefund
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本100 |
pay_type | String | 3 | Y | 支付方式,010微信,020 支付宝,040 现金,060qq钱包,080京东钱包,090口碑,100翼支付,110银联二维码,000自动识别类型 |
service_id | String | 3 | Y | 接口类型,当前类型030 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号(socket协议:长度为6位,Http协议:长度为32位) |
terminal_time | String | 14 | Y | 终端退款时间,yyyyMMddHHmmss,全局统一时间格式 |
refund_fee | String | 12 | Y | 退款金额,单位分 |
out_trade_no | String | 64 | Y | 利楚唯一订单号,优先使用订单号out_trade_no发起撤销,在out_trade_no获取异常的情况,可使用当前支付请求的终端交易流水号pay_trace和终端交易时间pay_time发起撤销 |
pay_trace | String | 32 | N | 当前支付终端流水号,与pay_time同时传递 |
pay_time | String | 14 | N | 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递 |
auth_code | String | 6 | N | 短信或邮箱验证码 |
key_sign | String | 32 | Y | 签名字符串,拼装所有必传参数+令牌,UTF-8编码,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01成功 ,02失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权撤销成功”、“订单不存在”等 |
result_code | String | 2 | N | 业务结果:01预授权撤销成功 ,02预授权撤销失败 |
pay_type | String | 3 | N | 请求类型,010微信,020 支付宝 |
merchant_no | String | 15 | N | 商户号 |
merchant_name | String | 40 | N | 商户名称 |
terminal_id | String | 8 | N | 终端号 |
terminal_trace | String | 32 | N | 终端流水号(socket协议:长度为6位,Http协议:长度为32位) |
terminal_time | String | 14 | N | 终端撤销时间,yyyyMMddHHmmss,全局统一时间格式 |
refund_fee | String | 40 | N | 申请退款金额 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
orig_trade_no | String | 32 | N | 撤销原订单号 |
channel_trade_no | String | 32 | N | 通道订单号 |
channel_order_no | String | 64 | N | 银行渠道订单号 |
order_body | String | 128 | N | 订单描述 |
order_type | String | 2 | Y | 02预授权撤销 03预授权完成 |
attach | String | 128 | N | 附加数据 |
pay_status_code | String | 2 | N | 交易状态, 预授权完成成功1,预授权失败2,预授权支付中3,预授权撤销成功4,预授权完成撤销成功5,预授权完成撤销失败6,预授权成功7,预授权撤销失败8,预授权完成失败9 |
store_name | String | 50 | N | 门店名称 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数,UTF-8编码,32位md5加密转换 |
以上为响应参数
● URL:/pos/200/preauth/commonQuery
● Method:POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本 100 |
pay_type | String | 3 | Y | 请求类型,010微信,020 支付宝 |
service_id | String | 3 | Y | 接口类型,当前类型 014 |
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 | 64 | Y | 订单号,查询凭据,可填利楚订单号、微信订单号、支付宝订单号、银行卡订单号任意一个 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数+令牌,UTF-8编码,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码: 01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“预授权成功”,“预授权支付中”,“请求受限”等 |
result_code | String | 2 | N | 业务结果:01成功 ,02失败 ,03支付中,支付失败和退款成功状态均返回02,具体状态和原因会在return_msg中给出解释 |
pay_type | String | 3 | N | 请求类型,010微信,020 支付宝 |
merchant_name | String | 40 | N | 商户名称 |
merchant_no | String | 15 | N | 商户号 |
terminal_id | String | 8 | N | 终端号 |
store_name | String | 32 | N | 门店名称 |
terminal_trace | String | 32 | N | 终端流水号,商户系统的查询流水号,扫呗系统原样返回 |
terminal_time | String | 14 | N | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
total_fee | String | 12 | N | 金额,单位分 |
receipt_fee | String | 12 | N | 实收金额 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
trade_state | String | 10 | N | 交易订单状态,SUCCESS支付成功,REFUND转入退款,NOTPAY未支付,CLOSED已关闭,USERPAYING用户支付中,REVOKED已撤销,NOPAY未支付支付超时,PAYERROR支付失败 |
pay_status_code | String | 1 | N | 交易状态, 预授权完成成功1,预授权失败2,预授权支付中3,预授权撤销成功4,预授权完成撤销成功5,预授权完成撤销失败6,预授权成功7,预授权撤销失败8,预授权完成失败9 |
channel_trade_no | String | 32 | N | 通道订单号,微信订单号、支付宝订单号等, |
channel_order_no | String | 64 | N | 银行渠道订单号,微信支付时显示在支付成功页面的条码,可用作扫码查询和扫码退款时匹配 |
user_id | String | 32 | N | 付款方用户id,“微信openid”、“支付宝账户”、“qq号”等, |
attach | String | 128 | N | 附加数据,原样返回, |
pay_trace | String | 32 | N | 当前支付终端流水号 |
pay_time | String | 14 | N | 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数,UTF-8编码,32位md5加密转换 |
注意:
● 查询支付结果时参数存在两种情况:1.out_trade_no为空的时候,查询的时候out_trade_no还是需要作为参数(对应的值是"")传进去,此时pay_trace(对应支付请求中的terminal_trace参数值)和pay_time(对应支付请求中的terminal_time参数值)也要作为请求参数传进去;2.out_trade_no不为空的时候,直接按照正常操作进行;
● 查询最多15次,每次间隔5s
● 此接口用来查原订单
/pos/200/preauth/preAuthQuery
POST
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
pay_ver | String | 3 | Y | 版本号,当前版本110 |
order_type | String | 2 | Y | 02预授权撤销订单查询 03预授权完成订单查询 |
service_id | String | 3 | Y | 接口类型,当前类型017 |
merchant_no | String | 15 | Y | 商户号 |
terminal_id | String | 8 | Y | 终端号 |
terminal_trace | String | 32 | Y | 终端流水号(socket协议:长度为6位,Http协议:长度为32位) |
terminal_time | String | 14 | Y | 终端交易时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号,优先使用订单号out_trade_no查询,在out_trade_no获取异常的情况,可使用当前支付请求的终端交易流水号pay_trace和终端交易时间pay_time发起撤销 |
pay_trace | String | 32 | N | 当前支付终端流水号,与pay_time同时传递 |
pay_time | String | 14 | N | 当前支付终端交易时间,yyyyMMddHHmmss,全局统一时间格式,与pay_trace同时传递 |
attach | String | 128 | N | 附加数据 |
order_body | String | 128 | N | 订单描述 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数+令牌,32位md5加密转换 |
以上为请求参数
参数名称 | 类型 | 长度 | 必填 | 说明 |
---|---|---|---|---|
return_code | String | 2 | Y | 响应码:01 成功 , 02 失败,响应码仅代表通信状态,不代表业务结果 |
return_msg | String | 128 | Y | 返回信息提示,“退款成功”、“订单不存在”等 |
result_code | String | 2 | N | 业务结果:01预授权撤销成功 ,02预授权撤销失败 |
pay_type | String | 3 | N | 请求类型,010微信,020 支付宝 |
merchant_no | String | 15 | N | 商户号 |
terminal_id | String | 8 | N | 终端号 |
terminal_trace | String | 32 | N | 终端流水号(socket协议:长度为6位,Http协议:长度为32位) |
terminal_time | String | 14 | N | 终端撤销时间,yyyyMMddHHmmss,全局统一时间格式 |
order_amt | String | 12 | N | 订单金额,单位分 |
poundage | String | 5 | N | 手续费 |
end_time | String | 14 | N | 支付完成时间,yyyyMMddHHmmss,全局统一时间格式 |
out_trade_no | String | 32 | N | 利楚唯一订单号 |
orig_trade_no | String | 32 | N | 撤销原订单号 |
channel_trade_no | String | 32 | N | 通道订单号 |
channel_order_no | String | 64 | N | 银行渠道订单号 |
order_body | String | 128 | N | 订单描述 |
order_type | String | 2 | Y | 02预授权撤销 03预授权完成 |
attach | String | 128 | N | 附加数据 |
pay_status_code | String | 2 | N | 交易状态,预授权完成成功1,预授权失败2,预授权支付中3,预授权撤销成功4,预授权完成撤销成功5,预授权完成撤销失败6,预授权成功7,预授权撤销失败8,预授权完成失败9 |
finish_amt | String | 12 | N | 预授权完成金额,单位分 |
store_name | String | 50 | N | 门店名称 |
key_sign | String | 32 | Y | 签名字符串,拼装所有传递参数,UTF-8编码,32位md5加密转换 |
以上为响应参数