资源描述
北京锐融天下信息技术有限公司 xOnlineV3.0-接口文档
wo
第一章
第1章 前言
1.1 文档说明
本文档用于描述xMobile产品前端与后台服务间数据交互的统一接口规范，双方按照该文档定义的报文格式进行通讯，为xMobile支付产品相关接口的开发标准。
1.2 文档约定
1.2.1 类型长度表示
类型
符号
长度
示例
字符串
S
（20）
S(20)
20位长度字符串
整数
N
（10）
N(10)
10位长度整数
数字（带小数）
N
(10,2)
N(10,2)
整数10位，小数2位数字
1.2.2 是否必输
输入控制
符号
必须输入
M
非必须输入
O
不可输入
-
1.3 通讯方式
1) 使用http协议传输XML数据签名验证的方式
通讯协议：HTTP
报文格式：XML
输入报文：即请求报文，由“输入公共报文头”+“报文体”组成；
输出报文：即返回报文，由“输出公共报文头”+“报文体”组成；
1.4 输入公共报文头
<RRTX>
<HEAD>
<INTERFACEID></INTERFACEID>
<MSGID></MSGID>
<VERSION></VERSION>
<SENDER></SENDER>
<RECEIVER></RECEIVER>
<HEADDATE></HEADDATE>
<HEADTIME></HEADTIME>
</HEAD>
</RRTX>
1.5 输出公共报文头
<RRTX>
<HEAD>
<INTERFACEID></INTERFACEID>
<MSGID></MSGID>
<VERSION></VERSION>
<SENDER></SENDER>
<RECEIVER></RECEIVER>
<HEADDATE></HEADDATE>
<HEADTIME></HEADTIME>
<RETURNCODE></RETURNCODE>
<RETURNMESSAGE></RETURNMESSAGE>
</HEAD>
</RRTX>
1.6 错误码定义规则
系统错误码编码规则：8位，由四部分组成。
第一部分：类型编号 ，一位 （P）存储过程 、（F）Function 、（J）Java代码、（S）js脚本、（A）不明确；
第二部分：系统编号，三位 （PER）个人 、（COR）企业 、（INM）内管 、（MER）商户 、（PAY）支付 、（AUT）自动服务 、（PUB）公共 、（LBS）定位相关、（APP）应用；
第三部分：模块编号，两位（数字或字母，建议字母）；
系统模块定义为：
模块名
编号
平台基础
CM
公共交易
PB
系统管理
SY
客户管理
CS
账户管理
AC
交易管理
TR
交易查询
TQ
安全中心
SC
支付网关
PY
预付卡
PP
定位相关
LB
第四部分：错误码编码 两位 (数字)。
1.7 公共错误码
公共错误码指所有交易都可能会报的错误码。
序号
信息编号
内容说明
1.
FAP001
请求服务不存在
2.
JPUBCM01
请求输入数据校验错误
3.
JPUBCM02
对不起，系统错误，请稍候重试
4.
JPUBCM03
用户会话超时
第2章 业务接口定义
第一章
第二章
2.1 线下扫码（ScanCodeAction）
2.1.1 线下扫码-支付交易接口 (ScanCodeAction.payOrder)
2.1.1.1 功能简介
进行支付交易。(关联数据库：licg@10.143.7.12:1521/gmptestdb)
2.1.1.2 输入
序号
中文名称
英文名称
类型
是否必输
备注
1.
订单号
orderNo
S(32)
M
与门店系统做唯一标识
2.
订单金额
orderAmt
S(32)
M
3.
门店id号
mallId
S(20)
M
门店号（storeNo）
4.
商户号
merchantid
S(20)
M
门店号对应的美付宝商户号（mallId）
5.
二维码
shortUrl
S(255)
M
二维码串
6.
分部通知URL
notifyUrl
S(255)
M
通知门店URL
2.1.1.3 输出
序号
中文名称
英文名称
类型
是否必输
备注
1.
通知URL
notifyUrl
S(255)
M
通知门店URL
2.1.1.4 错误码说明
序号
信息编号
内容说明
1.
EBPG0006
用户不存在
2.
PPAYOD02
订单已处理
3.
PPAYOD03
数据重复错误
4.
PPAYOD01
创建支付订单时发生异常
2.1.1.5 示例报文
请求报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>PAYORDER</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>JL</SENDER>
<RECEIVER>MFB</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>102449</HEADTIME>
</HEAD>
<TRANDATA>
<orderNo>61664784</orderNo>
<orderAmt>12.00</orderAmt>
<mallId>A209</mallId>
<merchantid>M100001040</merchantid>
<shortUrl>wweosk</shortUrl>
<notifyUrl>http://...</notifyUrl>
</TRANDATA>
<SIGNMSG>MMSLAOCLDLG...</SIGNMSG>
</RRTX>
返回报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>VERIFYORDERINF</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>MFB</SENDER>
<RECEIVER>JL</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>102954</HEADTIME>
</HEAD>
<TRANDATA>
<notifyUrl>http://...</notifyUrl>
</TRANDATA>
<SIGNMSG>DKLEOFS...</SIGNMSG>
</RRTX>
2.1.2 线下扫码-查询订单 (ScanCodeAction.verifyOrderInf)
2.1.2.1 功能简介
查询订单。
2.1.2.2 输入
序号
中文名称
英文名称
类型
是否必输
备注
1
订单号
orderNo
S(20)
M
与门店系统做唯一标识
2
门店ID号
mallId
S(20)
M
3
订单金额
orderAmt
S(32)
O
去掉折扣后的金额
2.1.2.3 输出
序号
中文名称
英文名称
类型
是否必输
备注
1
订单号
orderNo
S(20)
M
与门店系统做唯一标识
2
支付平台订单号
payOrderNo
S(20)
M
3
订单状态
orderStt
S(2)
M
4
订单金额
orderAmt
S(32)
M
5
成功时间
succTime
S(14)
M
yyyymmdd
2.1.2.4 错误码说明
序号
信息编号
内容说明
1.
PPAYOD04
没有订单记录
2.
PPAYOD05
查询支付订单时发生异常
3.
4.
2.1.2.5 示例报文
请求报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>VERIFYORDERINF</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>JL</SENDER>
<RECEIVER>MFB</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>102950</HEADTIME>
</HEAD>
<TRANDATA>
<orderNo>662700324</orderNo>
<mallId>M100000060</mallId>
<orderAmt>12.00</orderAmt>
</TRANDATA>
<SIGNMSG></SIGNMSG>
</RRTX>
返回报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>VERIFYORDERINF</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>MFB</SENDER>
<RECEIVER>JL</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>102954</HEADTIME>
</HEAD>
<TRANDATA>
<orderNo>662700324</orderNo>
<payOrderNo>59300921</payOrderNo>
<orderStt>0</orderStt>
<orderAmt>12.00</orderAmt>
<succTime>0</succTime>
</TRANDATA>
<SIGNMSG>DKLEOFS...</SIGNMSG>
</RRTX>
2.1.3 线下扫码-冲正 (ScanCodeAction.correction)
2.1.3.1 功能简介
交易信息回到门店系统出现问题，由门店系统发起冲正请求到手机服务端进行冲正交易。
2.1.3.2 输入
序号
中文名称
英文名称
类型
是否必输
备注
1
订单号
orderNo
S(20)
M
与门店系统做唯一标识
2
门店ID号
mallId
S(20)
M
2.1.3.3 输出
无
2.1.3.4 错误码说明
序号
信息编号
内容说明
1.
PPAYPY02
该笔订单已经冲正
2.
3.
4.
2.1.3.5 示例报文
请求报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>CORRECTION</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>JL</SENDER>
<RECEIVER>MFB</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>103250</HEADTIME>
</HEAD>
<TRANDATA>
<orderNo>61664784</orderNo>
<mallId>M100000060</mallId>
</TRANDATA>
<SIGNMSG>ASDEGYH...</SIGNMSG>
</RRTX>
返回报文：
参见1.5 输出公共报文头
2.1.4 线下扫码-退款 (ScanCodeAction.refund)
2.1.4.1 功能简介
订单完成后进行退款交易。
2.1.4.2 输入
序号
中文名称
英文名称
类型
是否必输
备注
1
原订单号
orderNo
S(20)
M
与门店系统做唯一标识
2
退款订单号
refundOrderNo
S(20)
M
3
门店ID号
mallId
S(20)
M
4
订单金额
orderAmt
S(32)
M
2.1.4.3 输出
序号
中文名称
英文名称
类型
是否必输
备注
1
原订单号
orderNo
S(20)
M
与门店系统做唯一标识
2
退款订单号
refundOrderNo
S(20)
M
3
支付平台退款订单号
payRefundOrderNo
S(20)
M
4
退款订单创建时间
transTime
S(14)
M
2.1.4.4 错误码说明
序号
信息编号
内容说明
1.
GWTR01
传送的数据格式有误
2.
GWTR02
验签失败
3.
PMERTK01
订单不是已支付状态，不能进行退款
4.
PMERTK04
退款金额不合法
2.1.4.5 示例报文
请求报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>REFUND</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>JL</SENDER>
<RECEIVER>MFB</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>103251</HEADTIME>
</HEAD>
<TRANDATA>
<orderNo>61664784</orderNo>
<mallId>M100000060</mallId>
<refundOrderNo>361664784</refundOrderNo>
<orderAmt>12.00</orderAmt>
</TRANDATA>
<SIGNMSG>ASDEGYH...</SIGNMSG>
</RRTX>
返回报文：
<?xml version="1.0" encoding="UTF-8">
<RRTX>
<HEAD>
<INTERFACEID>REFUND</INTERFACEID>
<MSGID></MSGID>
<VERSION>1.0</VERSION>
<SENDER>MFB</SENDER>
<RECEIVER>JL</RECEIVER>
<HEADDATE>20150528</HEADDATE>
<HEADTIME>103257</HEADTIME>
</HEAD>
<TRANDATA>
<orderNo>61664784</orderNo>
<refundOrderNo>59300921</refundOrderNo>
<payRefundOrderNo>0</payRefundOrderNo>
<transTime>20150528103549</transTime>
</TRANDATA>
<SIGNMSG>DKLEOFS...</SIGNMSG>
</RRTX>
第13页，共13页
展开阅读全文
浙ICP备2021020529号-1 | 浙B2-20240490 
