拉卡拉开放平台
数字支付解决方案
──
 最新版本 Ver 1.0


拉卡拉支付集团
版权所有,盗版必究

拉卡拉开放平台<br />数字支付解决方案<br />──<br /> 最新版本 Ver 1.0<br /><br /><br />拉卡拉支付集团<br />版权所有,盗版必究接入说明安全统一接入规范请求网关的Header处理请求网关的签名伪代码拉卡拉响应伪代码接入流程Demo文件下载证书生成指引方式1方式2证书签名代码示例验签代码示例交易接口公共参数说明交易接口说明访问URL说明交易接口公共请求参数termExtInfo字段说明交易接口公共响应参数主扫支付(C扫B)接口主扫支付请求参数主扫支付请求参数:extendParams字段说明响应参数主扫支付响应参数JSAPI支付主扫JSAPI支付响应参数:payMode=WECHAT 时返回主扫JSAPI支付响应参数:payMode=ALIPAY 时返回主扫JSAPI支付响应参数:payMode=UQRCODEPAY 时返回主扫JSAPI支付响应参数:payMode=LKLACC 时返回NATIVE支付主扫NATIVE支付响应参数微信小程序支付主扫-微信小程序支付响应参数:微信App支付主扫-微信App支付响应参数支付宝H5支付主扫-支付宝H5支付响应参数示例报文NATIVE请求报文NATIVE成功响应报文NATIVE失败响应报文JSAPI请求报文JSAPI成功响应报文JSAPI失败响应报文错误码主扫支付接口错误码关单接口(C扫B/主扫)关单接口请求参数关单接口响应参数关单接口请求报文关单接口成功响应报文:关单接口错误码被扫支付接口(付款码支付/B扫C)被扫支付接口请求参数被扫支付接口extendParams字段说明支持的authCode说明被扫支付接口响应参数被扫支付接口请求报文被扫支付接口成功响应报文被扫支付接口错误码撤销接口(B扫C/付款码/被扫交易)被扫撤销接口请求参数撤销接口响应参数撤销接口请求报文撤销接口成功响应报文撤销接口失败响应报文撤销接口错误码外部订单查询外部订单查询请求参数外部订单查询响应参数外部订单查询请求报文外部订单查询成功响应报文交易订单查询交易订单查询请求参数交易订单查询响应参数交易订单查询请求报文示例交易订单查询响应报文示例退款接口退款接口请求参数退款接口响应参数退款请求示例报文退款请求成功响应示例报文退款接口错误码生成动态二维码接口动态二维码请求接口说明动态二维码txnField字段说明动态二维码orderField字段说明动态二维码响应参数动态二维码请求示例动态二维码响应示例微信openid查询微信openid查询请求接口说明微信openid查询响应参数微信openid查询请求示例微信openid查询响应示例子商户号查询子商户号查询请求接口说明子商户号查询响应参数子商户号查询请求示例子商户号查询响应示例错误码BPS错误码交易系统错误码LABS错误码结算接口公共参数说明结算接口版本结算接口公共请求参数结算接口公共响应参数订单结算接口订单结算接口请求参数订单结算接口revcData说明按比例结算请求示例:按金额结算请求示例:订单结算接口响应参数订单结算接口请求示例订单结算接口响应示例结算结果查询结算结果查询请求参数结算结果查询响应参数结算结果查询details说明结算结果查询revcData说明结算结果查询revcData示例:结算结果查询请求示例结算结果查询响应示例结算完成结果通知(异步)结算完成结果通知请求参数结算完成结果通知响应参数结算完成结果通知revcData说明结算完成结果通知请求示例商户入网接口(三代)公共参数说明接口版本说明商户入网接口公共请求参数商户入网接口公共响应参数地区码表经营内容字典表商户入网:经营内容字典表POS类型字典表商户入网:POS类型字典表结算周期字典表商户入网:结算周期字典表证件类型字典表商户入网:证件类型字典表费率类型字典表商户入网:费率类型字典表限额类型字典表商户入网:限额类型字典表新增商户进件增商进件请求接口业务参数说明(reqData)增商进件请求接口费率信息集合增商进件请求接口附件列表增商进件请求接口返回参数(respData)增商进件请求接口请求报文参考增商进件请求接口响应报文参考增网增终进件增网增终进件请求接口业务参数说明(reqData)增网增终进件费率信息集合增网增终进件附件列表增网增终进件返回参数(respData)增网增终请求报文参考增终请求报文参考增网增终进件响应报文参考商户信息变更商户信息变更请求接口业务参数说明(reqData)商户信息变更商户信息变更附件列表商户信息变更返回参数(respData)商户信息变更请求报文参考商户信息变更响应报文参考费率信息变更费率信息变更请求接口业务参数说明(reqData)费率信息变更:费率信息集合费率信息变更附件列表费率信息变更返回参数(respData)费率信息变更请求报文参考费率信息变更响应报文参考结算信息变更结算信息变更请求接口业务参数说明(reqData)结算信息变更附件列表结算信息变更返回参数(respData)结算信息变更请求报文参考结算信息变更响应报文参考进件信息查询进件信息查询请求接口业务参数说明(reqData)进件信息查询返回参数(respData)进件信息查询请求报文参考进件信息查询转人工响应报文参考进件信息查询审核通过响应报文参考进件回调通知签名Header进件回调通知加密进件回调通知报文参数进件回调通知响应报文参数进件回调通知:提交成功参考进件回调通知:审核通过报文参考附件上传附件上传请求接口业务参数说明(reqData)附件上传请求:附件类型枚举附件上传请求:返回参数(respData)附件上传请求报文参考附件上传请求响应报文参考附件补充上传附件补充上传请求接口业务参数说明(reqData)附件补充上传:附件类型枚举附件补充上传:返回参数(respData)附件补充上传请求报文参考附件补充上传响应报文参考商户状态变更商户状态变更请求接口业务参数说明(reqData)商户状态变更返回参数(respData)商户状态变更请求报文参考商户状态变更响应报文参考进件校验进件校验请求接口业务参数说明(reqData)进件校验返回参数(respData)进件校验请求报文参考进件校验响应报文参考商户信息查询商户信息查询请求接口业务参数说明(reqData)商户信息查询返回参数(respData)商户信息查询:终端列表商户信息查询:限额列表商户信息查询:费率信息列表商户信息查询:请求报文参考商户信息查询:响应报文参考进件复议提交进件复议提交请求接口业务参数说明(reqData)进件复议提交返回参数(respData)进件复议提交请求报文参考进件复议提交响应报文参考卡BIN信息查询卡BIN信息查询请求接口业务参数说明(reqData)卡BIN信息查询返回参数(respData)卡BIN信息查询请求报文参考卡BIN信息查询响应报文参考订单接口公共说明订单接口版本说明订单接口公共请求参数订单接口公共响应参数商户下单商户下单请求参数(reqData)商户下单返回参数(respData)商户下单请求报文参考商户下单响应报文参考订单全量信息查询订单全量信息查询请求参数(reqData)订单全量信息查询返回参数(respData)订单全量信息查询请求报文参考订单全量信息查询响应报文参考订单结果通知Header处理订单结果通知加密订单结果通知报文参数订单结果通知响应报文参数订单结果通知请求报文参考订单结果通知响应报文参考签名新商服接口公共说明新商服接口版本说明新商服接口公共请求参数新商服接口公共响应参数统一退货统一退货请求接口说明统一退货响应统一退货请求示例统一退货响应示例核心交易接口公共说明核心交易接口版本核心交易接口公共请求参数核心交易接口公共响应参数SaaS退款申请SaaS退款申请tradeCodeSaaS退款申请请求参数SaaS退款申请响应参数对文档存在疑问的,请联系您的项目对接经理。

接入说明

本章内容为拉卡拉数字支付开放平台的接入公用说明。

对于任何想要获得拉卡拉数字支付相关能力的机构、商户和个人,如目前尚无项目经理与您进行对接,请联系我司邮箱 dcdp@lakala.com


原拉卡拉智能终端开放平台接入的客户,请点击此处访问相关内容。


测试环境地址:https://test.wsmsd.cn/sit/ 生产环境地址:https://s2.lakala.com/

拉卡拉会分配给对接方一个appId 获取拉卡拉公钥 测试环境:https://test.wsmsd.cn/sit/gw/pubcerts?appId=xxx 生产环境:https://s2.lakala.com/gw/pubcerts?appId=xx

各类接口地址

labs主扫支付url:https://test.wsmsd.cn/sit/labs/txn/labs_order_pre_orderpay labs关单url:https://test.wsmsd.cn/sit/labs/txn/labs_order_close labs被扫支付url:https://test.wsmsd.cn/sit/labs/txn/labs_order_micropay labs退款url:https://test.wsmsd.cn/sit/labs/txn/labs_order_refund labs动态码url:https://test.wsmsd.cn/sit/labs/txn/labs_dycode_create labs订单查询url:https://test.wsmsd.cn/sit/labs/txn/labs_order_query 订单结算url:https://test.wsmsd.cn/sit/mrss/ledger/settle_ledger 结算结果查询url:https://test.wsmsd.cn/sit/mrss/ledger/settle_result_query

 

安全统一接入规范

请求到api网关的签名

Header中传送下列值

Authorization: 认证类型 签名信息 如

请求网关的Header处理

其中 LKLAPI-SHA256withRSA 表示拉卡拉安全接入签名加密方式,如果有对称加密,如 LKLAPI-SHA256withRSA-AES128、 LKLAPI-SHA256withRSA-RC4

格式如:LKLAPI-{签名方式}-{加密方式} 如果仅是MD5加签,则写成 LKLAPI-MD5 如无签名加密,则写成 LKLAPI 不存在就为空 , 如仅仅使用3DES加密,则写成 LKLAPI–3DES

目前传统与智能终端是RSA1024签名方式则为 LKLAPI-SHA1withRSA

其中字段意义:

产生签名值signature的签名串拼接一共有5行,每一行为一个参数。行尾以\n(换行符,ASCII编码值为0x0A)结束,包括最后一行。如果参数本身以\n结束,也需要附加一个\n。

${appid}\n

${serialNo}\n ——存在则需要,不存在仅仅保留这个换行符\n

${timeStamp}\n

${nonceStr}\n

请求报文主体${body}\n

签名后的二进制值通过base64无76字符换行的方式进行传送 String signature = new String(Base64.encodeBase64(sign)) //不需要进行76字符换行

伪代码如

请求网关的签名伪代码

其中产生的签名用base64非76字符换行方式送出

拉卡拉响应签名

响应的Header信息包括:

其中,产生签名值Lklapi-Signature的签名串拼接一共有5行,每一行为一个参数。行尾以\n(换行符,ASCII编码值为0x0A)结束,包括最后一行。如果参数本身以\n结束,也需要附加一个\n。

${appid}\n ——存在则需要,不存在仅仅保留这个换行符\n

${serialNo}\n ——存在则需要,不存在仅仅保留这个换行符\n

${timeStamp}\n

${nonceStr}\n

响应报文主体${body}\n

伪代码如:

拉卡拉响应伪代码

注:对称加密传输时,默认采用AES-256的 CBC模式 AES/CBC/PKCS5Padding 初始向量16字节的 0x00

返回response:

接入流程

接入流程

 

Demo文件下载

  1. 签名验签参考OpenplatformDemo.java文件
  2. 具体请求服务参考HandlerBusiDemo.java文件

附件

openplatformSDK.rar

证书生成指引

方式1

使用openssl工具来生成公私钥 将生成的公钥证书发给拉卡拉进行配置 参考文档:https://blog.csdn.net/bbwangj/article/details/82503675

方式2

此方式生成的私钥不是PEM格式,使用此方式生成证书请参考本页代码,不要使用DEMO代码。

访问https://getacert.com/ 点击Generate self-signed Certificate

GetaCert:点击生成证书

输入公司名、城市、国家等相关信息,有效期可自行选择

GetaCert:填写证书参数

确认信息后提交

GetaCert:复核证书信息

生成4个文件,下载公钥证书和P12文件,私钥文件和CSR文件不需要下载,公钥证书请发送给拉卡拉对接人员,P12文件请妥善保存。如发生丢失作废失效等情况可以重新申请新证书并发送给拉卡拉。

GetaCert:证书内容清单

签名代码如下: 别名需要修改成生成证书时候填写的公司名称,密码统一为password无需修改;

证书签名代码示例

下载测试证书 生产验签证书请从拉卡拉对接人员处获取。 验签代码如下

验签代码示例

附件

 

 

交易接口

公共参数说明

接口文档中,必选栏目:M 必须,C 可选

交易接口说明
说明描述
接口版本v1.0.0
功能描述外部机构接入开放平台
调用方外部机构
请求方法POST
请求签名
响应签名
需要BASE64编码
授权方式LKLAPI-SHA256withRSA
测试环境URLhttps://test.wsmsd.cn/sit/labs/txn/xx
生产环境URLhttps://s2.lakala.com/labs/txn
测试环境商户终端号商户号:822290070111135 终端号: 29034705 商户号:822126090640003 终端号: 47781282

 

访问URL说明
URL描述
https://test.wsmsd.cn/sit/labs/txn/labs_order_query查询交易
https://test.wsmsd.cn/sit/labs/txn/labs_order_pre_orderpay主扫支付
https://test.wsmsd.cn/sit/labs/txn/labs_order_close主扫支付关单
https://test.wsmsd.cn/sit/labs/txn/labs_order_micropay被扫支付
https://test.wsmsd.cn/sit/labs/txn/labs_order_refund退款申请
https://test.wsmsd.cn/sit/labs/txn/labs_dycode_create生成动态码

 

交易接口公共请求参数
字段说明是否必填类型备注
timestamp时间戳CLongUnix时间戳。13位
rnd随机数CString(32)随机数
ver版本号CString(6)1.0.0
reqId请求序列号CString(32)-
reqData请求参数MObject 
termExtInfo终端信息MObject无特殊处理需求或无终端信息,填写”termExtInfo”:{}
termExtInfo字段说明
属性说明必选类型备注
termSN终端设备序列号CString(64)商户终端设备的SN号,存在必填,如:QR930000001172
termBaseStation终端基站信息CString(128)商户终端设备的基站信息,存在必填,上送格式为:MNC 移动网络号码(2)+LAC 位置区域码(5)+CID 基站编号(8)其中LAC不满五位,或CID不满足8位的均左补空格.如:00 6361 ·58130 为:00+LAC:6361+CID:58130
termLoc终端地理位置CString(100)商户终端的地理位置,存在必填 格式:纬度,经度,+表示北纬、东经,-表示南纬、 西经,精度最长支持小数点后9位。举例:+37.123456789,-121.123456789
termIp终端IP地址CString(32)商户终端的IP地址,存在必填,格式如36.45.36.95
termSerialNo终端设备串号CString(64)商户终端硬件的设备串号,存在必填,静态码没有
termType终端设备类型CString(2)商户终端硬件的设备类型,必填 01:PC 02:手机 03:收银机 04:移动终端 05:静态码
termModel终端型号CString(64)商户终端型号
termManu终端厂商CString(64)商户终端厂商
appCode终端app代码CString(64)商户终端app代码
appVer终端app版本CString(64)商户终端app版本
termFP终端指纹CString(64)商户终端指纹

termBaseStation、termLoc、termIp三者必须上送一个

 

交易接口公共响应参数
属性说明必选类型备注
retCode返回业务代码MString(8)返回业务代码(000000为成功,其余按照错误信息来定)
retMsg返回业务代码描述MString(50)返回业务代码描述
sign签名CString(32)默认MD5方式签名,签名内容为retData+secret_key。
timestamp时间戳MLongUnix时间戳,13位
rnd随机数CString(32)随机数
reqId请求序列号CString(32)请求序列号
respId响应序列号CString(32)响应序列号
ver版本号MString(6)版本号
respData响应参数CObject返回数据.下文定义的响应均为该属性中的内容

 

主扫支付(C扫B)接口

包括:jsapi/natvie/H5/APP/小程序。其中微信NATIVE已废弃

 

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_order_pre_orderpay 生产环境:https://s2.lakala.com/labs/txn/labs_order_pre_orderpay

主扫支付请求参数
字段说明是否必填类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
payMode支付模式MString(32)支付模式, 微信:WECHAT 支付宝:ALIPAY 银联:UQRCODEPAY 数字货币:DCPAY 拉卡拉钱包:LKLACC
amount金额MString(12)交易金额(单位分)
openId用户子标识 sub_openidCString(128)transType=51时(即公众号支付),此参数必传,只对微信支付有效 注:建议使用静默授权 微信公众号为用户的 openid 支付宝服务窗为用户的 buyer_id 银联JS支付为用户的 userId,获取用户授权返回00时必传 翼支付不需要上送 拉卡拉钱包为用户的userid
spbillCreateIp付款方IPMString(32)用户的客户端IP,格式如36.45.36.95
transType接入方式MString(2)41:NATIVE(微信不支持) 51:JSAPI(微信公众号支付,支付宝服务窗支付,银联JS支付,数字货币钱包支付,拉卡拉钱包) 61:微信APP支付(暂不支持) 71:微信小程序支付 81:支付宝H5支付(暂时只对labs使用) (61 71 81仅labs接口支持)
orderId商户订单号MString(32)商户系统唯一,可认为是交易的请求流水号
appId子商户公众账号ID sub_appidCString(32)transType=51时(即公众号支付),有此值时,此参数必传,只对微信支付有效
extendParams业务扩展参数Cobject支付宝业务扩展参数 JSON格式,见下列说明(目前不支持分期)
frontUrl银联前台通知地址CString(200)收款方向银联推送订单时上送的前台通知地址(仅允许为外网地址),用户完成支付点击,“返回”后,银联通过浏览器POST请求到该地址。 当transType为JSAPI,payMode为UQRCODEPAY时,可选填此字段
frontFailUrl银联失败交易前台通知地址CString(200)收款方向银联推送订单时上送的失败交易前台通知地址(仅允许为外网地址),用户支付过程中交易失败,点击“返回”后,银联通过浏览器GET请求到该地址。 当transType为JSAPI,payMode为UQRCODEPAY时,可选填此字段,需与frontUrl同时出现,未上送默认为frontUrl的值
subject订单标题MString(128)标题,用于简单描述订单或商品
settleType结算类型CString(2)0:正常结算 1:暂缓结算
exterOrderSource订单来源CString(16)一般一个机构一个分配好的订单来源,订单来源决定了主扫结果的通知
exterMerOrderNo外部商户订单号CString(32)同一个订单来源,外部商户订单号不可重复
主扫支付请求参数:extendParams字段说明
属性说明必选类型备注
sysServiceProviderId服务商的PIDCString(64)系统商编号,该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID
hbFqNum花呗分期期数MString(3)支付宝花呗分期必送字段: 花呗分期数 3:3期 6:6期 12:12期
hbFqSellerPercent卖家承担手续费比例MString(5)支付宝花呗分期必送字段: 卖家承担收费比例,商家承担手续费传入100,用户承担手续费传入0,仅支持传入100、0两种,其他比例暂不支持 100:代表商家贴息 0:代表用户承担手续费

响应参数

主扫支付响应参数
属性说明必选类型备注
tradeTime交易时间MString(14)平台交易时间yyyyMMddHHmmss
orderId商户订单号MString(32)如果请求中携带,则返回
lklOrderId拉卡拉订单号CString(32) 

JSAPI支付

(transType=51)

主扫JSAPI支付响应参数:payMode=WECHAT 时返回
属性说明必选类型备注
paySign支付签名信息CString(256)签名
appId公众号idCString(32)商户注册具有支付权限的公众号成功后即可获得公众号id
timeStamp时间戳CString(32)当前的时间
nonceStr随机字符串CString(32)随机字符串
package订单详情扩展字符串CString(128)统一下单接口返回的prepay_id参数值
signType签名方式CString(32)签名类型,支持RSA
主扫JSAPI支付响应参数:payMode=ALIPAY 时返回
属性说明必选类型备注
prepayId预下单IdCString(32)预支付交易会话ID
主扫JSAPI支付响应参数:payMode=UQRCODEPAY 时返回
属性说明必选类型备注
redirectUrl银联JS支付重定向地址CString(256)银联JS支付返回重定向地址
主扫JSAPI支付响应参数:payMode=LKLACC 时返回
属性说明必选类型备注
prepayId预下单IdCString(32)预支付交易会话ID

NATIVE支付

(transType=41)

主扫NATIVE支付响应参数
属性说明必选类型备注
code二维码信息CString(256)商户可用此参数自定义去生成二维码后展示出来进行扫码支付
codeImage二维码图片内容CString(256)商户收款二维码图片。Base64编码,暂无

微信小程序支付

(transType=71)

主扫-微信小程序支付响应参数:
属性说明必选类型备注
prepayId预下单IdCString(32)预支付交易会话ID
paySign支付签名信息CString(256)签名
appId小程序idCString(32)商户注册具有支付权限的小程序成功后即可获得小程序id
timeStamp时间戳CString(32)当前的时间
nonceStr随机字符串CString(32)随机字符串
package订单详情扩展字符串CString(128)统一下单接口返回的prepay_id参数值
signType签名方式CString(32)签名类型,支持RSA

微信App支付

(transType=61)

主扫-微信App支付响应参数
属性说明必选类型备注
prepayId预下单IdCString(32)预支付交易会话ID
paySign支付签名信息CString(256)签名
appId应用idCString(32)开放平台审核通过的应用APPID,为特约商户申请的应用APPID
timeStamp时间戳CString(32)当前的时间
nonceStr随机字符串CString(32)随机字符串
package订单详情扩展字符串CString(128)固定值 Sign=WXPay
partnerId从业机构号CString(32)支付分配的从业机构号

支付宝H5支付

(transType=81)

主扫-支付宝H5支付响应参数
属性说明必选类型备注
formData为开发者生成前台页面请求需要的完整form 表单的 html(不包含自动提交脚本),商户可决定是否直接提交 form 表单,如需要直接提交的,可将这个表单的 String 加自动提交脚本输出到 http response 中,如不需要直接提交的,可以自行决定中间处理过程,但提交至支付宝侧的 form 表达内容不可修改,否则会引起支付宝侧报错。CString(128)为银联支付宝H5支付时,为开发者生成前台页面请求需要的完整form 表单的 html

示例报文

NATIVE请求报文
NATIVE成功响应报文
NATIVE失败响应报文

 

JSAPI请求报文
JSAPI成功响应报文
JSAPI失败响应报文

错误码

主扫支付接口错误码
错误码描述备注
000000交易成功-

 

关单接口(C扫B/主扫)

主扫支付关闭订单(支持动态二维码)

 

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_order_close 生产环境:https://s2.lakala.com/labs/txn/labs_order_close

 

关单接口请求参数
属性说明必选类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
ornMerOrderId原商户订单号CString(32)同生成动态码中的商户订单号exterMerOrderNo
ornOrderSource原订单来源CString(16)原订单来源-同生成动态码接口中exterOrderSource
ornOrderId原商户流水号CString(32)主扫支付原商户订单号-orderId

注:ornMerOrderId+ornOrderSource和ornOrderId 两者只送其一,如果同时都送会校验两者之间的关系。ornOrderId是做交易时的请求orderId。

 

关单接口响应参数
属性说明必选类型备注
retcode响应码CString(32) 
message响应信息CString(32) 

 

关单接口请求报文
关单接口成功响应报文:
关单接口错误码
错误码描述备注
000000交易成功 

被扫支付接口(付款码支付/B扫C)

收银员使用扫码设备读取用户微信/支付宝/云闪付等APP付款码以后,二维码或条码信息传送至商户收银台, 由商户收银台或者商户后台调用该接口发起支付对用户进行收款。

 

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_order_micropay 生产环境:https://s2.lakala.com/labs/txn/labs_order_micropay

 

被扫支付接口请求参数
属性说明必选类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
authCode支付授权码MString(32)扫码支付授权码,设备读取用户APP中的条码或者二维码信息,用户付款码条形码规则见说明
amount金额MString(12)交易金额(单位分)
orderId商户订单号MString(32)商户系统唯一
extendParams业务扩展参数Cobject支付宝业务扩展参数 JSON格式,见下列说明
detail商品详情CString(6000)订单包含的商品列表信息,Json格式。payMode为WECHAT,ALIPAY时,可选填此字段
scanType扫码类型CString(1)0或不填:扫码支付 1:刷脸支付
appId子商户公众账号ID sub_appidCString(32)微信公众平台基本配置中的AppID(应用ID),传入后支付成功可返回对应公众号下的用户openid,只对微信支付有效
subject订单标题CString(128)标题,用于简单描述订单或商品
settleType结算类型CString(2)0:正常结算 1:暂缓结算
被扫支付接口extendParams字段说明
属性说明必选类型备注
sysServiceProviderId服务商的PIDCString(64)系统商编号。该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的 PID
hbFqNum花呗分期期数MString(3)支付宝花呗分期必送字段: 花呗分期数 3:3期 6:6期 12:12期
hbFqSellerPercent卖家承担手续费比例MString(5)支付宝花呗分期必送字段: 卖家承担收费比例,商家承担手续费传入100,用户承担手续费传入0,仅支持传入100、0两种,其他比例暂不支持 100:代表商家贴息 0:代表用户承担手续费
支持的authCode说明
属性说明备注
微信WECHAT付款码10 11 12 13 14 15开头
支付宝ALIPAY付款码25 26 27 28 29 30开头
银联UQRCODEPAY付款码62开头
翼支付BESTPAY付款码51开头
苏宁SUNING付款码83开头
数字货币DCPAY付款码01开头,第3位到第5位是002、003、004、005、008、009

 

被扫支付接口响应参数
属性说明必选类型备注
tradeTime平台交易时间MString(14)平台交易时间yyyyMMddHHmmss
orderId商户订单号MString(32) 
amount订单金额CString(12)单位分,12位,左补0
payMode支付方式CString(16)微信:WECHAT 支付宝:ALIPAY 银联:UQRCODEPAY 翼支付: BESTPAY 苏宁易付宝: SUNING 数字货币: DCPAY
weOrderNo账户端交易订单号CString(32)账户端交易订单号
lklOrderId拉卡拉商户订单号CString(32)拉卡拉生成的交易流水
openId用户标识CString(128)用户在商户appid下的唯一标识
settlementTotalFee应结订单金额CString(12)应结订单金额,单位分
clientDiscountAmt商户优惠金额(账户端)CString(12)账户端返回商户优惠金额,单位分
serverDiscountAmt账户端优惠金额(账户端)CString(12)账户端返回账户端优惠金额,单位分
platformDiscountAmount平台优惠金额CString(12)平台优惠金额,单位分
bankType付款银行CString(128)付款银行
activityId活动 IDCString(32)在账户端商户后台配置的批次 ID
upIssAddnData银联单品营销 附加数据CString(8000)参与单品营销优惠时返回
upCouponInfo银联优惠信息 出资方信息CString(500)参与单品营销优惠时返回 数字货币中行返回示例说明:[{“fundchannel”:”BOC”,”amount”:”18”}]

authCode为UQRCODEPAY的银联付款码若要支持银联单品营销功能,需要上送公共说明中的参数orderInfo、goodsInfo、termExtInfo中的termSN、termType,响应参数会新增公共说明中的参数issAddnData、couponInfo。具体见银联单品营销示例报文。 银联单品营销只支持全额退款。

 

被扫支付接口请求报文
被扫支付接口成功响应报文

```

 

被扫支付接口错误码
错误码描述备注
000000交易成功 

撤销接口(B扫C/付款码/被扫交易)

当日支付成功且需要取消的交易,可以调用该接口。接口逻辑 : 支付成功的撤销支付(资金会退还给用户)。 调用支付接口后请勿立即调用撤销订单接口,建议支付后至少15s后再调用撤销订单接口。

 

请求URL:

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_order_micropay_reverse 生产环境:https://s2.lakala.com/labs/txn/labs_order_micropay_reverse

被扫撤销接口请求参数
属性说明必选类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
orderId商户订单号MString(32)商户系统唯一
ornOrderId原商户订单号CString(32)原被扫交易上送的订单号
lklOrderNo原拉卡拉商户订单号CString(32)原拉卡拉生成的交易流水

ornOrderId和lklOrderNo 必须送一个

撤销接口响应参数
属性说明必选类型备注
retcode响应码CString(32) 
message响应信息CString(32) 
orderId商户订单号CString(32)如果请求中携带,则返回

 

撤销接口请求报文
撤销接口成功响应报文
撤销接口失败响应报文

 

撤销接口错误码
错误码描述备注
000000交易成功-

外部订单查询

使用场景是B端使用外部订单生成二维码,供用户扫码支付,在这种场景下,B端发起查询,只有生成二维码的订单信息,这时,用这个接口查询

请求URL:

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_ext_order_query 生产环境:https://s2.lakala.com/labs/txn/labs_ext_order_query

 

外部订单查询请求参数
属性说明必选类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
exterOrderSource订单来源MString(16) 
exterMerOrderNo商户订单号MString(32) 

 

外部订单查询响应参数
属性说明必选类型备注
amount交易金额CString(12)单位分
tradeState交易状态CString(32)INIT-初始化 CREATE-下单成功 SUCCESS-交易成功 FAIL-交易失败 DEAL-交易处理中 UNKNOWN-未知状态 CLOSE-订单关闭 PART_REFUND-部分退款 REFUND-全部退款 REVOKED-订单撤销
payTime支付时间CString(14)实际支付时间。yyyyMMddHHmmss
weOrderNo账户端交易订单号CString(32)账户端交易订单号
lklOrderNo拉卡拉商户订单号CString(32)拉卡拉生成的交易流水
openId用户标识CString(128)用户在商户appid下的唯一标识
settlementTotalFee应结订单金额CString(12)应结订单金额,单位分
clientDiscountAmt商户优惠金额(账户端)CString(12)账户端返回商户优惠金额,单位分
serverDiscountAmt账户端优惠金额(账户端)CString(12)账户端返回账户端优惠金额,单位分
bankType付款银行CString(128)付款银行
platformDiscountAmount平台优惠金额CString(12)平台优惠金额,单位分

订单查询响应接口中的retCode及retMsg只代表查询流程的业务状态,交易的状态需根据respData中的tradeState字段来判定。

 

外部订单查询请求报文
外部订单查询成功响应报文

交易订单查询

根据商户订单号或者平台订单号查询平台的具体订单信息

请求URL:

环境地址
测试环境https://test.wsmsd.cn/sit/labs/txn/labs_order_query
生产环境https://s2.lakala.com/labs/txn/labs_order_query
交易订单查询请求参数
属性说明必选类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
ornOrderId原商户订单号CString(32)商户系统唯一
lklOrderNo拉卡拉商户订单号CString(32)拉卡拉生成的交易流水

ornOrderId和lklOrderNo 必须送一个

交易订单查询响应参数
属性说明必选类型备注
amount交易金额CString(12)单位分
tradeState交易状态CString(32)INIT-初始化 CREATE-下单成功 SUCCESS-交易成功 FAIL-交易失败 DEAL-交易处理中 UNKNOWN-未知状态 CLOSE-订单关闭 PART_REFUND-部分退款 REFUND-全部退款 REVOKED-订单撤销
payTime支付时间CString(14)实际支付时间。yyyyMMddHHmmss
weOrderNo账户端交易订单号CString(32)账户端交易订单号
lklOrderNo拉卡拉商户订单号CString(32)拉卡拉生成的交易流水
openId用户标识CString(128)用户在商户appid下的唯一标识
settlementTotalFee应结订单金额CString(12)应结订单金额,单位分
clientDiscountAmt商户优惠金额(账户端)CString(12)账户端返回商户优惠金额,单位分
serverDiscountAmt账户端优惠金额(账户端)CString(12)账户端返回账户端优惠金额,单位分
bankType付款银行CString(128) 
platformDiscountAmount平台优惠金额CString(12)平台优惠金额,单位分

订单查询响应接口中的retCode及retMsg只代表查询流程的业务状态,交易的状态需根据respData中的tradeState字段来判定。

交易订单查询请求报文示例
交易订单查询响应报文示例

退款接口

 

请求URL:

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_order_refund 生产环境:https://s2.lakala.com/labs/txn/labs_order_refund

 

退款接口请求参数
属性说明必选类型备注
mercId商户号MString(32)拉卡拉分配的商户号
termNo终端号MString(32)拉卡拉分配的终端号
refundOrderId商户退款单号MString(32)商户退款单号,若上送需保证商户退款单号唯一,不可重复退款
ornOrderId原商户订单号CString(32)原扫码交易上送的订单号
amount退款金额MString(12)单位分
lklOrderNo原拉卡拉商户订单号CString(32)原拉卡拉生成的交易流水

lklOrderNo和ornOrderId 必须送一个

退款接口响应参数
属性说明必选类型备注
retcode响应码CString(32) 
message响应信息CString(32) 
retAmt退款金额CString(12)单位分
refundOrderId商户退款单号CString(32)如果请求中携带,则返回
refundLklOrderNo拉卡拉退款单号CString(32)拉卡拉退款单号

 

退款请求示例报文
退款请求成功响应示例报文

 

退款接口错误码
错误码描述备注
000000交易成功-

生成动态二维码接口

请求URL:

测试环境:https://test.wsmsd.cn/sit/labs/txn/labs_dycode_create 生产环境:https://s2.lakala.com/labs/txn/labs_dycode_create

动态二维码请求接口说明
字段名称内容是否必输最大长度备注
mercId商户号String(32) 
termNo终端号String(32) 
merName商户名称String(128) 
codeValidPeriod二维码有效期int二维码的有效时间,单位秒,区间为60秒-300秒
orderField订单域object 
txnField交易域object 
动态二维码txnField字段说明
属性说明必选类型备注
settleType结算类型String(2)0:正常结算 1:暂缓结算
notifyUrl通知地址String(256)接收平台通知的URL,需给绝对路径,255字符内格式,确保平台能通过互联网访问该地址,若上送后台按异步通知机制通知交易结果
appId子商户公众账号IDString(32)微信分配的子商户公众账号ID,sub_appid(即微信小程序支付-71、公众号支付-51),需要使用某个商家的APPID时此参数必传,只对微信支付有效
attach附加域String(128)附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据。商户定制字段,直接送到账户端。
goodsDetail商品详情String(128)订单包含的商品列表信息,Json格式
goodsTag订单优惠标记String(32)订单优惠标记,微信平台配置的商品标记,用于优惠券或者满减使用,accountType为WECHAT时,可选填此字段
动态二维码orderField字段说明
属性说明必选类型备注
amount金额String(12)金额,单位:分
exterOrderSource订单来源String(16) 
exterMerOrderNo外部商户订单号String(32)同一个订单来源,外部商户订单号不可重复
subject订单标题String(40)账户端限制
orderRemark备注String(50) 
动态二维码响应参数
字段名称内容是否必输备注
qrCode二维码信息商户收款二维码信息
qrCodeUrl二维码地址二维码地址
codeExpiredTime有效期Unix时间戳。13位。
动态二维码请求示例
动态二维码响应示例

微信openid查询

请求URL:

测试环境:https://test.wsmsd.cn/sit/saas/query/wx_openid_query 生产环境:https://s2.lakala.com/saas/query/wx_openid_query

微信openid查询请求接口说明
字段名称内容是否必输最大长度备注
mercId商户号String(32) 
termNo终端号String(32) 
authCode微信付款码String(128)微信:付款码
subAppid微信子商户公众号idString(128) 
微信openid查询响应参数
字段名称内容是否必输备注
openId微信openId 
subOpenId微信subOpenId 
微信openid查询请求示例
微信openid查询响应示例

子商户号查询

请求URL:

测试环境:https://test.wsmsd.cn/sit/saasmgt/submer/query 生产环境:https://s2.lakala.com/saasmgt/submer/query

子商户号查询请求接口说明
字段名称内容是否必输最大长度备注
barcodeMerchantNo822商户号String(32)822290059470417
terminalNo终端号String(32)终端号与渠道号二选一
businessOrgNo从业机构号String(32)1900009211
accessId渠道号String(100)渠道号与终端号二选一
tradeMode钱包类型String(32)枚举值: 微信:WECHAT 支付宝:ALIPAY

备注:

因为银联AT微信的子商户号有多个,需要根据accessId来区分

子商户号查询响应参数
字段名称内容是否必输备注
barcodeMerchantNo商户号 
terminalNo终端号 
businessOrgNo从业机构号 
accessId渠道号 
subMerchantNo账户端子商户号 
tradeMode钱包类型 
serverId账户端ID 
子商户号查询请求示例
子商户号查询响应示例

错误码

BPS错误码
应答码说明
BPS10028主扫支付失败
BPS10029交易支付中,请稍后查询
BPS10030被扫支付失败
BPS10031被扫支付撤销失败
BPS10032原订单不存在
BPS10033退款失败
BPS10034退款处理中
BPS10035退款查询失败
BPS10036订单关闭失败
BPS10037订单查询失败
BPS10038获取userid失败
BPS10039微信刷脸授权码获取失败
BPS10040订单号重复
交易系统错误码
应答码说明
BBS11112交易结果未知
BBS11105用户支付中
BBS00001系统异常
BBS00002系统功能暂未开放
BBS00100网络请求失败
BBS00101网络请求超时
BBS11000参数校验失败
BBS11100通道类型未知
BBS11101交易类型未知
BBS11102交易钱包类型未知
BBS11200验签失败
BBS11103账户端处理失败
BBS11104账户端返回数据格式错误
BBS11106未查到参数
BBS11107交易不存在
BBS11108未找到路由
BBS11196路由信息不存在
BBS11110不允许做该交易
BBS11111订单号已存在
BBS11112交易结果未知
BBS11113D0商户当前不允许做反交易
BBS11114订单不存在
BBS11170机构信息不存在
BBS11172商户信息不存在
BBS11173下游商户【外部商户】信息不存在
BBS11174子商户信息不存在
BBS11199微信子商户信息不存在
BBS11198支付宝子商户信息不存在
BBS11197银联二维码子商户信息不存在
BBS11175未查到子商户
BBS11176商户终端信息不存在
BBS11177该终端不存在
BBS11178该终端卡应用信息不存在
BBS11181bmcp机构已关闭
BBS11182交易权限已关闭
BBS11183交易权限未开通
BBS11184该商户已停用
BBS11185该终端已停用
BBS11186退款交易扣账发清结算失败
BBS11187退款交易扣账发清结算异常
BBS11109交易金额超过单笔限额
BBS11109已超单日累计限额
BBS11109已超单月累计限额
LABS错误码
应答码说明
LABS00000成功
LABS00200用户支付中
LABS00201交易结果未知
LABS00202交易系统处理失败
LABS10000请求参数校验失败
LABS10001订单号必传
LABS10100该交易暂不支持退货
LABS10102该交易暂不支持撤销
LABS10103该交易暂不支持关单
LABS10104订单已退货
LABS10200流水不存在
LABS10201流水号已存在
LABS10202订单号不存在
LABS10203商户订单不存在
LABS10204商户订单已使用

结算接口

公共参数说明

接口文档中,必选栏目:M 必须,C 可选

结算接口版本
说明描述
接口版本v1.0.0
功能描述外部机构接入开放平台
调用方外部机构
请求方法POST
请求签名
响应签名
需要BASE64编码
授权方式LKLAPI-SHA256withRSA
测试环境URLhttps://test.wsmsd.cn/sit/mrss/ledger/
生产环境URLhttps://s2.lakala.com/mrss/ledger/
结算接口公共请求参数
字段说明是否必填类型备注
timestamp时间戳CLongUnix时间戳。13位
rnd随机数CString(32)随机数
ver版本号CString(6)1.0.0
reqId请求序列号CString(32)-
reqData请求参数MObject 
结算接口公共响应参数
属性说明必选类型备注
retCode返回业务代码MString(8)返回业务代码(000000为成功,其余按照错误信息来定)
retMsg返回业务代码描述MString(50)返回业务代码描述
timestamp时间戳MLongUnix时间戳,13位
rnd随机数CString(32)随机数
reqId请求序列号CString(32)请求序列号
respId响应序列号CString(32)响应序列号
ver版本号MString(6)版本号
respData响应参数CObject返回数据.下文定义的响应均为该属性中的内容

订单结算接口

用于分账完成时请求。

请求URL:

测试环境:https://test.wsmsd.cn/sit/mrss/ledger/settle_ledger 生产环境:https://s2.lakala.com/mrss/ledger/settle_ledger

订单结算接口请求参数
属性说明必选类型备注
tranDate交易日期MString(8)20201106
tranTime交易时间MString(6)132455
ledgerType完成类型MString(6)01:完成,02:完成回退
instId机构号MString(32) 
logdat拉卡拉订单日期CString(8)原交易订单日期,完成回退时不必输
logNo拉卡拉订单流水号CString(32) 
txnAmt完成总额MString(15)完成总金额
ledgerTranSid完成请求流水idMString(32)完成发起方请求唯一标识
oledgerTranSid原完成请求流水idMString(32)完成回退时必输
sendMerId完成发起商户号CString(32)完成回退时不必输
sendTermId完成发起终端号CString(32)完成回退时不必输
busyType业务类型MString(4)0:完成到本身,1:完成到多个人
ruleType完成规则MString(2)0:按照指定金额完成 1:按照比例完成
revcData完成接收商终集合MJSONrevcData json 必输 完成接收商终 包含发起商户本身金额;按照比例会校验list所有数据比例之和是否为1;按照金额会校验list数据金额之和是否为完成总额
notifyUrl通知地址MString(128)通知用url
merKey商户密钥MString(512) 
verifycode验证码MString(512)清结算验证身份使用
订单结算接口revcData说明
属性说明必选类型备注
revcMerId完成接收商户号MString(32) 
revcTermId完成接收终端号MString(32) 
ledgerPercent完成百分比例CString(8)完成规则为1(按比例),该值必输
txnAmt完成金额CString(15)单位分;完成规则为0(按金额),该值必输
按比例结算请求示例:
按金额结算请求示例:

说明1:如果商户A发起结算指令,将资金结算给自己,则“完成发起商户号”和“完成发起终端号”都填商户A自己的商户号和终端号,revcData中也要填写自己相关的 json信息。 说明2、如果商户A发起分账指令,revcData中必须要填写自己的信息,满足比例和为1或者金额总和为订单总金额的校验。 说明3:如果商户A发起担保完成指令,则“完成规则”必须使用“0-指定金额完成”

订单结算接口响应参数
属性说明必选类型备注
code响应码CString(32)0000:受理成功 0001:必传值为空 0002:请求流水处理中 –完成交易 0003:原暂缓交易已完成处理 –完成交易请求和兜底发起的判定 0004:原请求流水状态不符 –完成回退 0005:查询失败,原交易不存在 0006:原暂缓交易状态异常:计费失败– 可以重试 0007:原暂缓交易状态异常:记账失败 –可以重试 0008:转入list数量超限 0009: 转入list商终不存在 0010:商终不存在 0011:余额不足 0012:分账金额不符合最大分账比例 0013:商户未开启分账功能 0014:完成分账,分账金额超过交易总金额 0015:累计回退金额超过原分账金额 0016:完成明细入库异常 0099: 系统异常 1000:处理成功
msg描述CString(100) 
订单结算接口请求示例
订单结算接口响应示例

结算结果查询

请求URL:

测试环境:https://test.wsmsd.cn/sit/mrss/ledger/settle_result_query 生产环境:https://s2.lakala.com/mrss/ledger/settle_result_query

结算结果查询请求参数
属性说明必选类型备注
instId机构号MString(32) 
queryId查询流水号MString(32) 
ledgerTranSid分账请求流水idMString(32)分账发起方请求唯一标识
结算结果查询响应参数
属性说明必选类型备注
code响应编码 String(10)0002:查询成功 0003:查询失败,交易不存在
msg响应信息 String(62) 
data分账明细 json 
结算结果查询details说明
属性说明类型备注
instId机构号String(32) 
ledgerTranSid分账请求流水idString(32) 
txnStat状态String(8)00:完成受理中 01:完成失败 02:分账成功
sendMerId发起商户号String(32) 
sendTermId发起终端号String(32) 
tranDate交易日期String(8)20201106
tranTime交易时间String(6)132455
revcData完成接收商终listjson包含发起商户本身金额
结算结果查询revcData说明
属性说明必选类型备注
revcMerId完成接收商户号MString(32) 
revcTermId完成接收终端号MString(32) 
txnAmt完成金额MString(15)充值金额,单位分,分账金额
finishDate完成日期MString(8) 
结算结果查询revcData示例:

 

结算结果查询请求示例
结算结果查询响应示例

结算完成结果通知(异步)

结算完成结果通知请求参数
属性说明必选类型备注
instId机构号MString(32) 
ledgerTranSid分账请求流水idMString(32) 
status状态MString(8)00:完成受理中 01:完成失败 02:分账成功
sendMerId完成发起商户号MString(32) 
sendTermId完成发起终端号MString(32) 
sendDate结果通知日期MString(8)20201106
sendTime结果通知时间MString(6)132455
mac验证码MString(512) 
revcData完成接收商终listMjson 
结算完成结果通知响应参数
属性说明必选类型备注
code响应编码MString(10) 
errmsg响应信息MString(62) 
结算完成结果通知revcData说明
属性说明必选类型备注
revcMerId完成接收商户号MString(32) 
revcTermId完成接收终端号MString(32) 
finishDate完成日期MString(8) 
liqAmt结算金额CString(15)单位分;完成规则为0(按金额),该值必输
结算完成结果通知请求示例

商户入网接口(三代)

公共参数说明

接口文档中,必选栏目:M 必须,C 可选

接口版本说明
说明描述
接口版本v1.0.0
功能描述外部机构接入开放平台
调用方外部机构
请求方法POST
数据格式JSON数据格式
请求签名
响应签名
授权方式LKLAPI-SHA256withRSA
测试环境URLhttps://test.wsmsd.cn/xx
生产环境URLhttps://s2.lakala.com/xx
商户入网接口公共请求参数
字段说明是否必填类型备注
timestamp时间戳CLongUnix时间戳。13位
rnd随机数CString(32)随机数
ver版本号CString(6)1.0.0
reqId请求序列号CString(32)-
reqData请求参数MObject 
商户入网接口公共响应参数
属性说明必选类型备注
retCode返回业务代码MString(8)返回业务代码(000000为成功,其余按照错误信息来定)
retMsg返回业务代码描述MString(50)返回业务代码描述
timestamp时间戳MLongUnix时间戳,13位
rnd随机数CString(32)随机数
reqId请求序列号CString(32)请求序列号
respId响应序列号CString(32)响应序列号
ver版本号MString(6)版本号
respData响应参数CObject返回数据.下文定义的响应均为该属性中的内容

地区码表

地区码表

经营内容字典表

商户入网:经营内容字典表
编号名称
642百货、中介、培训、景区门票等
645交通运输售票
646电气缴费
647政府类
648便民类
649公立医院、公立学校、慈善
650宾馆餐饮娱乐类
651房产汽车类
652批发类
653超市加油类
654一般类商户
655三农商户

POS类型字典表

商户入网:POS类型字典表
POS类型名称POS类型备注
传统POSGENERAL_POS 
智能POSSUPER_POS 
蓝精灵BLUE_WIZARD 
专业化扫码WECHAT_PAY 
收钱吧扫码SQB_SCAN_CODE 
收钱吧码牌SQB_PAPER_CODE 
收钱吧桌码SQB_DESK_CODE 
新云小店CLOUD_STORE_NEW增商专用
云分销CLOUD_DISTRIBUTION 
云分销线上CLOUD_DISTRIBUTION_CB 
云小店线上CLOUD_STORE_CB 
云小店线下CLOUD_STORE_BC 
云小店非收银机CLOUD_STORE_BC_NOTLKL 
收款码(原惠码)线上HM_CB 
收款码(原惠码)线下HM_BC 

结算周期字典表

商户入网:结算周期字典表
代码名称划款时间描述
T+1T+1结算T日5:30-9:304
T+1+NT+1普通结算批次T日12:00-15:0078
D+1+ND+1普通结算批次T日12:00-15:0078
W_T+9999喔噻T+9999不结算批次提款模式25 喔噻专用
D+1收单D+1结算批次D日05:30左右18
D1+24D1+24结算批次D日11:00左右58 乐惠专用
T+9999不结算批次不划款10

证件类型字典表

类型码名称:larIdType、accIdType

商户入网:证件类型字典表
证件类型名称代码备注
身份证01 
护照02 
港澳通行证03 
台胞证04 
其它证件99 

费率类型字典表

类型码名称:feeRateTypeCode

商户入网:费率类型字典表
类型名称代码备注
银联借记卡300 
银联贷记卡301 
微信302 
支付宝303 
翼支付306 
银联二维码借记卡314 
银联二维码贷记卡315 
支付账户319 
微信线上400 
微信刷脸307 
支付宝刷脸308 
云闪付借记-优惠411 
云闪付贷记-优惠412 
银联二维码借记-优惠413 
银联二维码贷记-优惠414 

限额类型字典表

类型码名称:limitTypeCode

商户入网:限额类型字典表
类型名称代码备注
银行借记卡BANK_DEBIT_CARD 
银行贷记卡BANK_CREDIT_CARD 
扫码QR_CODE_CARD 
外卡WILD_CARD 
联机退货RETURNS_ONLINE 
纸码PAPER_CODE 

 

 

 

新增商户进件

接入方通过开放平台新增商户进件

请求地址:

测试环境:https://test.wsmsd.cn/sit/mms/openApi/addMer 生产环境:

增商进件请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
posType必传String32进件POS类型 —按接入系统做控制,参见【POS类型字典表】GENERAL_POS
orgCode必传String32机构代码 
merRegName必传String80商户注册名称 
merBizName可传String80商户经营名称为空时,同商户注册名称
merRegDistCode必传String8商户地区代码地区代码,参看地区文档
merRegAddr必传String80商户详细地址去除省,市,区后的详细地址
mccCode必传String8商户MCC编号银联商户类别代码
merBlisName可传String80营业执照名称小微商户可不传,其它必传
merBlis可传String40营业执照号小微商户可不传,对公进件必传,且不可与法人证件相同
merBlisExpDt可传String10营业执照有效期格式(yyyy-MM-dd)
merBusiContent必传String64商户经营内容参看【经营内容字典表】文档
larName必传String20商户法人姓名 
larIdType必传String8法人证件类型支持其他证件类型,见参数字典
larIdcard必传String40法人身份证号码 
larIdcardExpDt必传String10法人身份证有效期 yyyy-MM-dd 
merContactMobile必传String20商户联系人手机号码 
merContactName必传String32商户联系人 
shopName可传String80网点名称不填,取商户注册名称
shopDistCode可传String8网点地址区划代码不填,取商户地区代码
shopAddr可传String80网点详细地址不填,取商户详细地址
shopContactName可传String32网点联系人名称不填,取商户联系人姓名
shopContactMobile可传String20网点联系人手机号不填,取商户联系人手机号码
openningBankCode必传String20结算账户开户行号 
openningBankName必传String40结算账户开户行名称 
clearingBankCode必传String20结算账户清算行号 
acctNo必传String40结算账户账号 
acctName必传String40结算账户名称 
acctTypeCode必传String8结算账户性质57 对公 58 对私
settlePeriod必传String8结算周期 
acctIdType可选String8结算人证件类型为空时,判断为同法人
acctIdcard可选String40结算人证件号码为空时,判断为同法人
acctIdDt可选String10结算人证件有效期为空时,判断为同法人
devSerialNo可选String64终端设备序列号 
devTypeName可选String32设备型号 
termVer可选String32终端版本号 
retUrl必传String64回调地址url
feeData必传Set集合费率信息集合参看下方【费率信息】
fileData可选Set 附件信息集合 
增商进件请求接口费率信息集合
字段名称约束字段类型字段描述取值说明
feeRateTypeCode必传String费率类型参见【费率类型字典表】
feeRateTypeName必传String费率类型名称银行卡借记卡
feeRatePct必传String手续费率(%)0.6
feeUpperAmtPcnt可选String单笔交易手续费封顶默认不封顶,单位(元)
feeLowerAmtPcnt可选String单笔交易手续费保低默认无保底,单位(元)
feeRateStDt可选String手续费生效日期默认为进件日期
增商进件请求接口附件列表
字段名称约束字段类型字段描述取值说明
attFileId必传String文件编号 附件上传接口返回的编号 
attType必传String附件类型 
增商进件请求接口返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
增商进件请求接口请求报文参考
增商进件请求接口响应报文参考

增网增终进件

四方机构通过开放平台对原有的商户增加网点、增加终端进件。一次接口调用只能增一种类型(posType)的终端。

  1. 新增网点,终端详情的填写内容都新增在新的网点下。(注:此时shopId和termNo的值无意义)。

  2. 不新增网点(shopData数据为空)

    1. 如果shopId和termNo值为空,则将终端详情随机挂在一个历史网点下(适用于该单网点商户)。
    2. 如果shopId和termNo值不为空(优先shopId),根据shopId或者termNo找到对应的网点信息,将终端详情挂在该终端号对应的网点下(适用于多网点商户)。

 

请求地址:

测试环境:https://test.wsmsd.cn/sit/mms/openApi/addTerm 生产环境:

增网增终进件请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
posType必传String32进件POS类型 —按接入系统做控制,参见【POS类型字典表】GENERAL_POS
orgCode必传String32机构代码 
merInnerNo必传String32商户内部商户号(拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准)4002019111800000020
merCupNo必传String32银联商户号82229005411000A
shopData可选Object1新增网点 
shopName可选String64网点名称 
shopDistCode可选String16网点地址区划代码 
shopAddr可选String128网点详细地址 
shopContactMobile可选String32网点联系人手机号 
shopContactName可选String18网点门店联系人名称 
termData必传Object 终端详情 
shopId可选String32网点ID 
termNum必传String8终端数量(1-5) 最大5个终端1
termNo可选String32终端号 
devSerialNo可选String64终端设备序列号 
devTypeName可选String32设备型号 
termVer可选String32终端版本号 
retUrl必传String64回调地址http://
feeData必传Set集合费率信息集合参看下方【费率信息】
fileData可选Set 附件信息集合 
增网增终进件费率信息集合
字段名称约束字段类型字段描述取值说明
feeRateTypeCode必传String费率类型参见【费率类型字典表】
feeRateTypeName必传String费率类型名称银行卡借记卡
feeRatePct必传String手续费率(%)0.6
feeUpperAmtPcnt可选String单笔交易手续费封顶默认不封顶,单位(元)
feeLowerAmtPcnt可选String单笔交易手续费保低默认无保底,单位(元)
feeRateStDt可选String手续费生效日期默认为进件日期
增网增终进件附件列表
字段名称约束字段类型字段描述取值说明
attFileId必传String文件编号 附件上传接口返回的编号 
attType必传String附件类型 
增网增终进件返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
增网增终请求报文参考
增终请求报文参考
增网增终进件响应报文参考

商户信息变更

接入方通过开放平台变更商户的基本信息。 当termNo为空时,对商户层的结算配置信息做变更。 当termNo不为空时,对业务层的结算配置信息做变更(注:如果业务上原来没有配置结算信息,则不变更业务层结算信息)。 变更网点层信息,必须上传终端号(termNo)。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/changeMer 生产环境:

商户信息变更请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
merInnerNo必传String32商户内部商户号(拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准)4002019111800000020
merCupNo必传String32银联商户号82229005411000A
merRegName可传String64商户注册名称 
merBizName可传String64商户经营名称 
merRegDistCode可传String16商户地区代码地区代码,参看地区文档
merRegAddr可传String128商户详细地址去除省,市,区后的详细地址
mccCode可传String8商户MCC编号银联商户类别代码
merBlisName可传String64营业执照名称 
merBlis可传String32营业执照号 
merBlisExpDt可传String10营业执照有效期格式(yyyy-MM-dd)
merBusiContent可传String32商户经营内容参看【经营内容字典表】文档
larName可传String32商户法人姓名 
larIdcard可传String32法人身份证号码 
larIdcardExpDt可传String10法人身份证有效期 yyyy-MM-dd 
merContactMobile可传String32商户联系人手机号码 
merContactName可传String32商户联系人 
fileData可传Set集合附件数据参看下方【附件信息集合】
termNo可传String32终端号 
shopName可传String80网点名称终端号为空时,忽略此项变更
shopDistCode可传String8网点地址区划代码终端号为空时,忽略此项变更
shopAddr可传String80网点详细地址终端号为空时,忽略此项变更
shopContactName可传String32网点联系人名称终端号为空时,忽略此项变更
shopContactMobile可传String20网点联系人手机号终端号为空时,忽略此项变更
openningBankCode可传String20结算账户开户行号终端号为空时,变更商户层结算信息。
openningBankName可传String40结算账户开户行名称终端号为空时,变更商户层结算信息。
clearingBankCode可传String20结算账户清算行号终端号为空时,变更商户层结算信息。
acctNo可传String40结算账户账号终端号为空时,变更商户层结算信息。
acctName可传String40结算账户名称终端号为空时,变更商户层结算信息。
acctTypeCode可传String8结算账户性质终端号为空时,变更商户层结算信息。
settlePeriod可传String8结算周期终端号为空时,变更商户层结算信息。
acctIdType可选String8结算人证件类型终端号为空时,变更商户层结算信息。
acctIdcard可选String40结算人证件号码终端号为空时,变更商户层结算信息。
acctIdDt可选String10结算人证件有效期终端号为空时,变更商户层结算信息。
retUrl必传String64回调地址url
商户信息变更商户信息变更附件列表
字段名称约束字段类型字段描述取值说明
attFileId必传String文件编号 附件上传接口返回的编号 
attType必传String附件类型 
商户信息变更返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
商户信息变更请求报文参考
商户信息变更响应报文参考

费率信息变更

接入方通过开放平台变更商户的费率信息。 如果上送了原来不存在feeRateTypeCode(费率类型代码),将会新增一条费率 如果termNo值为空,将变更商户下的所有费率。 如果termNo值不为空,只变更termNo对应的费率。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/changeFee 生产环境:

费率信息变更请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)接入方编码+14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
merInnerNo必传String32商户内部商户号(拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准)4002019111800000020
merCupNo必传String32银联商户号82229005411000A
termNo可传String32银联终端号 
retUrl必传String64回调地址url
fileData可选Set 附件信息集合 
feeData必传Set 费率信息集合 
费率信息变更:费率信息集合
字段名称约束字段类型字段描述取值说明
feeRateTypeCode必传String费率类型参见【费率类型字典表】
feeRateTypeName必传String费率类型名称银行卡借记卡
feeRatePct必传String手续费率(%)0.6
feeUpperAmtPcnt可选String单笔交易手续费封顶默认不封顶,单位(元)
feeLowerAmtPcnt可选String单笔交易手续费保低默认无保底,单位(元)
feeRateStDt可选String手续费生效日期默认为进件日期
费率信息变更附件列表
字段名称约束字段类型字段描述取值说明
attFileId必传String文件编号 附件上传接口返回的编号 
attType必传String附件类型 
费率信息变更返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
费率信息变更请求报文参考
费率信息变更响应报文参考

结算信息变更

接入方通过开放平台变更商户的基本信息。 当termNo为空时,对商户层的结算配置信息做变更。 当termNo不为空时,对业务层的结算配置信息做变更(注:如果业务上原来没有配置结算信息,则不变更业务层结算信息)

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/changeSett 生产环境:

结算信息变更请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
merInnerNo必传String32商户内部商户号(拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准)4002019111800000020
merCupNo必传String32银联商户号82229005411000A
termNo可传String32银联终端号 
openningBankCode可传String32结算账户开户行号参考《卡BIN信息查询接口》
openningBankName可传String32结算账户开户行名称参考《卡BIN信息查询接口》
clearingBankCode必传String32结算账户清算行号参考《卡BIN信息查询接口》
acctNo可传String32结算账户账号 
acctName可传String64结算账户名称 
acctTypeCode可传String8结算人证件类型57 对公 58 对私 59 支付账户
settlePeriod可传String8结算周期参考《商户入网数据字典》
acctIdType可传String8结算人证件类型参考《商户入网数据字典》
acctIdcard可传String32结算账户证件号码6229301920220928
acctIdDt可传String32结算人证件有效期格式(yyyy-MM-dd)
fileData可选Set 附件信息集合 
retUrl必传String64回调地址url
结算信息变更附件列表
字段名称约束字段类型字段描述取值说明
attFileId必传String文件编号 附件上传接口返回的编号 
attType必传String附件类型 
结算信息变更返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
结算信息变更请求报文参考
结算信息变更响应报文参考

进件信息查询

接入方通过开放平台查询进件信息,返回报文同进件审核完成主动通知报文

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/queryContract 生产环境:

进件信息查询请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
contractId必传String32进件ID 
进件信息查询返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
contractStatusString进件状态未提交:NO_COMMIT 已提交 COMMIT 提交失败:COMMIT_FAIL 转人工审核:MANUAL_AUDIT 审核中:REVIEW_ING 审核通过:WAIT_FOR_CONTACT 审核驳回:INNER_CHECK_REJECTED
contractMemoString进件描述进件审核通过,返回“审核通过”,进件审核驳回,返回具体的驳回理由。
merInnerNoString拉卡拉内部商户号该属性审核通过才有
merCupNoString银联商户号该属性审核通过才有
termDatasSet银联商户号该属性审核通过才有
shopIdString网点编号termDatas的下级属性
termIdString终端编号termDatas的下级属性
termNoString终端号termDatas的下级属性
busiTypeNameString业务名称termDatas的下级属性
productNameString产品名称termDatas的下级属性
productCodeString产品代码termDatas的下级属性
进件信息查询请求报文参考
进件信息查询转人工响应报文参考
进件信息查询审核通过响应报文参考

进件回调通知

签名

认证方式:SHA256withRSA 签名规则:产生签名值signature的签名串拼接一共有3行,每一行为一个参数,包括时间戳timestamp、随机数nonce_str、请求报文主体。行尾以\n(换行符,ASCII编码值为0x0A)结束,包括最后一行。如果参数本身以\n结束,也需要附加一个\n。 {nonceStr}\n 请求报文主体${body}\n

Header中传送下列值:

Authorization: 认证类型 签名信息 如

Authorization: “LKLAPI-SHA256withRSA timestamp=”{nonceStr}”,signature=”${signature}”“

其中 LKLAPI-SHA256withRSA 表示拉卡拉安全接入签名加密方式

进件回调通知加密
名称描述
timestamp发起的系统时间(秒)
nonce_str12个字符的随机字符串
signature签名
进件回调通知报文参数
字段名称约束字段类型长度字段描述取值说明
code必返String 成功返回000000,否则返回具体的错误码000000
message必返String 返回码中文描述成功
data必返Object 返回对象 
orgCode必返String 机构代码 
orderNo必返String 订单号 
contractId必返String 进件ID 
contractStatus必返String 未提交:NO_COMMIT 已提交 COMMIT 提交失败:COMMIT_FAIL 转人工审核:MANUAL_AUDIT 审核中:REVIEW_ING 审核通过:WAIT_FOR_CONTACT 审核驳回:INNER_CHECK_REJECTEDWAIT_FOR_CONTACT
contractMemo必返String 进件描述进件审核通过,返回“审核通过”,进件审核驳回,返回具体的驳回理由。
merInnerNo非必返String 拉卡拉内部商户号该属性审核通过才有
merCupNo非必返String 银联商户号该属性审核通过才有
termDatas非必返Set 银联商户号该属性审核通过才有
shopId非必返String 网点编号termDatas的下级属性
termId非必返String 终端编号termDatas的下级属性
termNo非必返String 终端号termDatas的下级属性
busiTypeName非必返String 业务名称termDatas的下级属性
productName非必返String 产品名称termDatas的下级属性
productCode非必返String 产品代码termDatas的下级属性
进件回调通知响应报文参数
字段名称约束字段类型长度字段描述取值说明
code必返String32应答码SUCCESS:成功 FAIL:失败
message必返String64异常信息 
进件回调通知:提交成功参考
进件回调通知:审核通过报文参考

附件上传

接入方通过开放平台上传商户入网附件。进件前上传附件,上次完成后必须在24小时内根据上传附件时的orderNo提交进件信息,超过24小时附件失效。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/uploadFile 生产环境:

附件上传请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
attType必传String32附件类型附件类型枚举,ID_CARD_FRONT
attExtName必传String32附件扩展名称jpg
attContext必传  附件内容文件内容 BASE64
附件上传请求:附件类型枚举
中文属性枚举值
身份证正面ID_CARD_FRONT
身份证反面ID_CARD_BEHIND
银行卡BANK_CARD
营业执照BUSINESS_LICENCE
商户门头照MERCHANT_PHOTO
商铺内部照片SHOPINNER
电子协议NETWORK_XY
其他OTHERS
附件上传请求:返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
attFileIdString附件ID 
attTypeString附件类型 
附件上传请求报文参考
附件上传请求响应报文参考

附件补充上传

接入方通过开放平台上传附件(适用于进件完成和审核通过的商户补充附件)。 1.仅上送进件ID(contractId)时,如果进件状态为审核通过,无法上传成功,返回“进件已审核通过,请使用商户号补充附件”。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/replenishFile 生产环境:

附件补充上传请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
contractId可传String32进件ID 
merInnerNo可传String32拉卡拉内部商户号拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准。
merCupNo可传String32银联商户号拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准。
attType必传String32附件类型附件类型枚举,ID_CARD_FRONT
attExtName必传String32附件扩展名称jpg
attContext必传  附件内容文件内容 BASE64
附件补充上传:附件类型枚举
中文属性枚举值
身份证正面ID_CARD_FRONT
身份证反面ID_CARD_BEHIND
银行卡BANK_CARD
营业执照BUSINESS_LICENCE
商户门头照MERCHANT_PHOTO
商铺内部照片SHOPINNER
电子协议NETWORK_XY
其他OTHERS
附件补充上传:返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
contractIdString进件ID 
merInnerNoString拉卡拉内部商户号 
merCupNoString银联商户号 
附件补充上传请求报文参考
附件补充上传响应报文参考

商户状态变更

接入方根据拉卡拉内部商户号或银联商户号、终端号将商户的状态变更为“无效”、“有效”。 1.当仅上送拉卡拉内部商户号或银联商户号时,为对整个商户做状态变更,商户下网点、终端、业务都会变更为对应的状态。 2.当上送了终端号时,仅对相应的终端做状态变更。 注意:如果商户的状态为“无效”,且为拉卡拉风控操作,四方机构无权将商户的状态变更为“有效”。接口调用返回详情会明确告知。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/changeMerStatus 生产环境:

商户状态变更请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
merInnerNo必传String32拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准。 
merCupNo必传String32拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准。 
type必传String8操作类型(OPEN,CLOSE)OPEN
remark可传String100操作原因操作类型为CLOSE时必传
termNos可传String64终端号数据串终端号用“
商户状态变更返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
商户状态变更请求报文参考
商户状态变更响应报文参考

进件校验

 

接入方在入网前,对商户名称、法人信息、结算人信息做敏感词和黑名单、反洗钱的校验。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/verifyContractInfo 生产环境:

进件校验请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
merRegName可传String32商户注册名称 
merBizName可传String32商户经营名称 
merBlis可传String32营业执照 
larIdcard可传String32法人身份证号 
acctNo可传String32结算账号 
acctIdcard可传String32结算人证件号 
进件校验返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
进件校验请求报文参考
进件校验响应报文参考

商户信息查询

四方机构根据拉卡拉内部商户号或银联商户号查询商户的基本信息。敏感信息脱敏。 脱敏规则: 身份证号码:保留前四后四显示,中间位以“”号替换。 营业执照号码:保留前四后四显示,中间位以“”号替换。 银行卡号码:保留前六后四显示,中间位以“”号替换。 电话号码:保留前三后四,中间位以“”号替换。 地址信息:保留省份,中间位以“*”号替换。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/queryMerchant 生产环境:

商户信息查询请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
merInnerNo可传String32拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准。 
merCupNo可传String32拉卡拉内部商户号和银联商户号必须传一个,都送以内部商户号为准。 
商户信息查询返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
merRegNameString商户注册名称 
merRegAddrString商户详细地址 
mccCodeString商户MCC编号 
merBlisNameString营业执照名称 
merBlisString营业执照号 
merBlisExpDtString营业执照有效期 
merBusiContentString商户经营内容 
larNameString商户法人姓名 
larIdcardString法人身份证号码 
larIdcardExpDtString法人身份证有效期 
merContactMobileString联系人手机号码 
merContactNameString商户联系人姓名 
openningBankCodeString结算账户开户行号 
openningBankNameString结算账户开户行名称 
clearingBankCodeString结算账户清算行号 
acctNoString结算账户账号 
acctNameString结算账户名称 
acctTypeCodeString结算账户性质 
settlePeriodString结算周期 
openningIdcardString结算账户身份证号 
termDataSet终端数据终端信息集合
feeDataSet费率数据费率信息集合
limitDataSet限额数据限额信息集合
商户信息查询:终端列表
字段名称字段类型字段描述取值说明
shopIdString网点编号 
termIdString终端编号 
termNoString终端号 
busiTypeNameString业务名称 
productNameString产品名称 
商户信息查询:限额列表
字段名称字段类型字段描述取值说明
limitTypeCodeString限额类型代码 
limitTypeCodeNameString限额类型名称 
limitAmtPcntString单笔限额单位(元)
limitAmtPdayString单日限额单位(元)
limitAmtPmonString单月限额单位(元)
商户信息查询:费率信息列表
字段名称约束字段类型字段描述取值说明
feeRateTypeCode必传String费率类型参见【费率类型字典表】
feeRateTypeName必传String费率类型名称银行卡借记卡
feeRatePct必传String手续费率(%)0.6
feeUpperAmtPcnt可选String单笔交易手续费封顶默认不封顶,单位(元)
feeLowerAmtPcnt可选String单笔交易手续费保低默认无保底,单位(元)
feeRateStDt可选String手续费生效日期默认为进件日期
商户信息查询:请求报文参考
商户信息查询:响应报文参考

进件复议提交

接入方在进件被驳回后(由于系统自动校验无法通过),调用此接口提交进件,转人工审核。

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/reconsiderSubmit 生产环境:

进件复议提交请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
contractId必传String32进件ID 
进件复议提交返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
进件复议提交请求报文参考
进件复议提交响应报文参考

卡BIN信息查询

接入方在进件前,通过银行卡号查询到开户行信息

请求地址

测试环境:https://test.wsmsd.cn/sit/mms/openApi/cardBin 生产环境:

卡BIN信息查询请求接口业务参数说明(reqData)
字段名称约束字段类型长度字段描述取值说明
version必传String8接口版本号1.0
orderNo必传String32订单编号(便于后续跟踪排查问题及核对报文)14位年月日时(24小时制)分秒+8位的随机数(不重复)如:2021020112000012345678
orgCode必传String32机构代码 
cardNo必传String32银行卡号 
卡BIN信息查询返回参数(respData)
字段名称字段类型字段描述取值说明
orgCodeString机构代码 
orderNoString订单号 
cardNoString银行卡号 
bankCodeString开户行号 
clearingBankCodeString清算行号 
bankNameString开户行名称 
cardTypeString银行卡类别 
cardNameString卡种名称 
卡BIN信息查询请求报文参考
卡BIN信息查询响应报文参考

 

订单接口

公共说明

接口文档中,必选栏目:M 必须,C 可选

订单接口版本说明
说明描述
接口版本v1.0.0
功能描述外部机构接入开放平台
调用方外部机构
请求方法POST
请求签名
响应签名
需要BASE64编码
授权方式LKLAPI-SHA256withRSA
测试环境URLhttps://test.wsmsd.cn/sit/xx
生产环境URLhttps://s2.lakala.com/xx
订单接口公共请求参数
字段说明是否必填类型备注
timestamp时间戳CLongUnix时间戳。13位
rnd随机数CString(32)随机数
ver版本号CString(6)1.0.0
reqId请求序列号CString(32)-
reqData请求参数MObject 
订单接口公共响应参数
属性说明必选类型备注
retCode返回业务代码MString(8)返回业务代码(000000为成功,其余按照错误信息来定)
retMsg返回业务代码描述MString(50)返回业务代码描述
sign签名CString(32)默认MD5方式签名,签名内容为retData+secret_key。
timestamp时间戳CLongUnix时间戳,13位
rnd随机数CString(32)随机数
reqId请求序列号CString(32)请求序列号
respId响应序列号CString(32)响应序列号
ver版本号CString(6)版本号
respData响应参数CObject返回数据.下文定义的响应均为该属性中的内容

商户下单

为商户系统提供下单服务,基于商户提交的商户订单,生成支付订单,返回支付订单号,用于后序支付服务

请求地址

测试环境:https://test.wsmsd.cn/sit/los/createOrder 生产环境:https://s2.lakala.com/los/createOrder

商户下单请求参数(reqData)
字段名称约束字段类型长度字段描述取值说明
merchantOrderNo必传String64商户订单号 
merchantNo必传String32结算商户号822100041120005
termId可传String12交易所属终端号24865454154
orderInfo可传String100订单信息 
extendInfo可传String100  
channelId必传String32渠道编号24865454154
amount必传int10订单金额,单位:分 范围0~9999999999200
currency必传String3币种,参见国标,默认值:156156
orderCreateTime必传String19商户创建订单时间,格式:YYYY-MM-DD HH:MM:SS2018-12-06 16:58:45
orderEfficientTime必传String19订单有效期,格式:YYYY-MM-DD HH:MM:SS2018-12-08 17:58:45
notifyUrl可传String500通知地址 http://xxx.xxx.com 
supportCancal可传int2是否支持撤销 默认 0 不支持(0 不支持 1支持)
supportRefund可传int2是否支持退款 默认0 不支持(0 不支持 1支持)
supportRepeatPay可传int1是否支持重复支付 默认0 不支持(0 不支持 1支持)
商户下单返回参数(respData)
字段名称字段类型字段描述取值说明
merchantNoString商户号 
channelIdString渠道号 
merchantOrderNoString商户订单号 
createTimeString创建订单时间 
payOrderNoString支付流水号 
商户下单请求报文参考
商户下单响应报文参考

 

订单全量信息查询

用于为商户提供交易查询服务,返回订单数据全量

请求地址

测试环境:https://test.wsmsd.cn/sit/los/queryFullOrder 生产环境:https://s2.lakala.com/los/queryFullOrder

订单全量信息查询请求参数(reqData)
字段名称约束字段类型长度字段描述取值说明
merchantOrderNo必传String64商户订单号 
merchantNo必传String32结算商户号13775821
channelId必传String32渠道编号 
订单全量信息查询返回参数(respData)
字段名称字段类型字段描述取值说明
payOrderNoString支付流水号 
merchantOrderNoString商户订单号 
tradeMerchantNoString交易商户号 
tradeTermIdString交易终端号 
merchantNoString结算商户号 
termIdString结算终端号 
orderInfoString订单描述 
tradeTypeString交易类型 
amountBigInteger订单金额,单位:分 
currencyString币种 
orderCreateTimedatetime订单创建时间 
orderEfficientTimedatetime商户订单有效期 
payStatusString支付状态记录POSP的返回状态 S:成功 F:失败 C:被冲正 U:预记状态 X:发送失败 T: 发送超时 P: 处理中
extendFieldString扩展字段 
remarkString备注 
channelIdString渠道号 
notifyStatusint通知状态0未通知 1通知成功 2通知失败
orderStatusint订单状态NOTPAY(0,”未支付”), PAYING(1,”支付中”), PAID(2,”付款成功”), FAIL(3,”支付失败”), EXPIRED(4,”已过期”), CANCELED(5,”已取消”);
payTimeString支付时间 
payerId2String付款人标记卡号、父级openid、userid等,二期新增字段
payerId2String付款人子标记子openid,二期新增字段
crdFlgString付款方式微信刷脸 支付宝刷脸 微信扫码 支付宝扫码 银联扫码 银联刷脸、刷卡等,二期新增字段
smCrdFlgString扫码卡类型00:不确定 01:借记卡 02:贷记卡 03:微信零钱 04:支付宝花呗 05:支付宝其他
订单全量信息查询请求报文参考
订单全量信息查询响应报文参考

订单结果通知

通知接入方系统,通过延时队列进行散列通知,通知频率:间隔:1s/5s/5s/10s/3m/10m/20m/30m/1h/2h - 总计 4h3m21s。商户返回应答SUCCESS,将终止通知

Header处理

Header中传送下列值:

Authorization: 认证类型 签名信息 如

Authorization: “LKLAPI-SHA256withRSA timestamp=”{nonceStr}”,signature=”${signature}”“

其中 LKLAPI-SHA256withRSA 表示拉卡拉安全接入签名加密方式

订单结果通知加密
名称描述
timestamp发起的系统时间(秒)
nonce_str12个字符的随机字符串
signature签名
订单结果通知报文参数
字段名称约束字段类型长度字段描述取值说明
payOrderNo必返String64支付流水号 
merchantOrderNo必返String64商户订单号 
tradeMerchantNo非必返Object32交易商户号 
tradeTermId非必返String 交易终端号 
merchantNo必返String 结算商户号 
termId必返String 结算终端号 
orderInfo非必返String 订单描述 
tradeType必返String 交易类型 
amount非必返BigInteger 订单金额,单位:分 
currency必返String3币种 
orderCreateTime必返datetime 订单创建时间 
orderEfficientTime必返datetime 商户订单有效期 
payStatus必返String10支付状态记录POSP的返回状态 S:成功 F:失败 C:被冲正 U:预记状态 X:发送失败 T: 发送超时 P: 处理中
extendField非必返String100扩展字段 
remark非必返String256备注 
channelId必返String32渠道号 
notifyStatus必返int2通知状态0未通知 1通知成功 2通知失败
noticeNum必返String2当前通知次数1
payerId1非必返String50付款人标记卡号、父级openid、userid等,二期新增字段
payerId2非必返String50付款人子标记子openid,二期新增字段
crdFlg非必返String10付款方式00:借记卡 01:贷记卡 74 : 数币钱包 75:拉卡拉支付账户 81:银联二维码支付借记 82:银联二维码支付贷记 91:微信 92:支付宝
smCrdFlg非必返String20扫码卡类型00-借记卡,01-贷记卡,02-微信零钱,03-支付宝花呗,04-支付宝其它,05-数字货币,99-未知
tradeTime必返String14交易完成时间 
accountChannelOrderNo必返String50账户方流水 
订单结果通知响应报文参数
字段名称约束字段类型长度字段描述取值说明
code必返String32应答码SUCCESS:成功 FAIL:失败
message必返String64异常信息 
订单结果通知请求报文参考
订单结果通知响应报文参考

签名

认证方式:SHA256withRSA 签名规则:产生签名值signature的签名串拼接一共有3行,每一行为一个参数,包括时间戳timestamp、随机数nonce_str、请求报文主体。行尾以\n(换行符,ASCII编码值为0x0A)结束,包括最后一行。如果参数本身以\n结束,也需要附加一个\n。 {nonceStr}\n 请求报文主体${body}\n

新商服接口

公共说明

接口文档中,必选栏目:M 必须,C 可选

新商服接口版本说明
说明描述
接口版本v1.0.0
功能描述外部机构接入开放平台
调用方外部机构
请求方法POST
请求签名
响应签名
需要BASE64编码
授权方式LKLAPI-SHA256withRSA
测试环境URLhttps://test.wsmsd.cn/sit/xx
生产环境URLhttps://s2.lakala.com/xx
新商服接口公共请求参数
字段说明是否必填类型备注
timestamp时间戳CLongUnix时间戳。13位
rnd随机数CString(32)随机数
ver版本号CString(6)1.0.0
reqId请求序列号CString(32)-
reqData请求参数MObject 
新商服接口公共响应参数
属性说明必选类型备注
retCode返回业务代码MString(8)返回业务代码(000000为成功,其余按照错误信息来定)
retMsg返回业务代码描述MString(50)返回业务代码描述
sign签名CString(32)默认MD5方式签名,签名内容为retData+secret_key。
timestamp时间戳CLongUnix时间戳,13位
rnd随机数CString(32)随机数
reqId请求序列号CString(32)请求序列号
respId响应序列号CString(32)响应序列号
ver版本号CString(6)版本号
respData响应参数CObject返回数据.下文定义的响应均为该属性中的内容

统一退货

提供银行卡和扫码的统一退货业务,根据流水和交易类型判断退货请求发往银行卡(POSP)还是扫码系统

  1. 银行卡(POSP)退货需上送系统参考号
  2. 扫码(LABS)退货需上送商户订单号或SAAS流水号,若商户通过通过终端交易通知则无法得到SAAS流水号, 需使用POSP截取的系统参考号

 

请求URL

测试环境:https://test.wsmsd.cn/sit/openapi/lams/refund 生产环境:

统一退货请求接口说明
字段名称内容是否必输最大长度备注
mercId商户号String(32)拉卡拉分配的商户号
termId终端号String(32)拉卡拉分配的终端号
merReqSno商户请求流水号String(64)商户系统唯一
refundAmount退款金额String(12)单位分,整数数字型字符
originBizType原业务类型String(1)原交易类型:1 银行卡,2 外卡,3 扫码 产品表——PosType-卡应用-产品映射关系表
originTradeDate原交易日期String(8)原交易日期:yyyyMMdd 20200326
originLogNo原交易平台交易参考号String(14)交易返回的拉卡拉统一交易单号,扫码交易为6621开头,数币交易为6631开头,POSP交易为年份后两位开头
originLklOrderNo原交易拉卡拉交易订单号String(32)下单成功时,返回的扫码系统生成的送往账户方的交易流水号,在微信或支付宝交易信息界面显示为商户订单号
originOSNo原交易拉卡拉内部订单号String(32)拉卡拉订单系统生成的订单号
originCardNo原交易银行卡号String(32)原交易银行卡号,银行卡退款必填,如无完整卡号可送交易通知时的脱敏卡号如6226**8223
extField扩展信息String(6000)各类交易的扩展字段

orginLogNo、originLklOrderNo、originOsNo必填一个

统一退货响应
字段名称内容是否必输备注
logNo拉卡拉退款单号平台交易单号
tradeTime平台交易时间平台交易时间yyyyMMddHHmmss
merReqSno商户请求流水号如果请求中携带,则返回
totalAmount交易金额单位分,整数数字型字符串
payerAccountAmt实际退款金额单位分,整数数字型字符串
refundAmount申请退款金额单位分,整数数字型字符串
payRefundNo账户端交易订单号账户端交易订单号
originLogNo原交易平台交易参考号如果请求中携带,则返回
originLklOrderNo原交易拉卡拉交易订单号如果请求中携带,则返回
originMerReqSno原商户请求流水号如果请求中携带,则返回
extField扩展信息 
统一退货请求示例
统一退货响应示例

核心交易接口

公共说明

接口文档中,必选栏目:M 必须,C 可选

核心交易接口版本
说明描述
接口版本v1.0.0
功能描述外部机构接入开放平台
调用方外部机构
请求方法POST
请求签名
响应签名
需要BASE64编码
授权方式LKLAPI-SHA256withRSA
测试环境URLhttps://test.wsmsd.cn/sit/saas/txn/xx
生产环境URLhttps://s2.lakala.com/saas/txn
测试环境商户终端号商户号:822290070111135 终端号: 29034705 商户号:822126090640003 终端号: 47781282
核心交易接口公共请求参数
字段说明是否必填类型备注
tradeCode交易码MString(10) 
version版本号CString(8)版本号1.0.0
barcodeMerchantNo商户号MString(32) 
terminalNo终端设备号MString(32) 
opUserId操作员CString(32) 
location地理位置(城市)String(100)纬度,经度
terminalIp终端IPMString(16) 
baseStation基站信息String(128) 
termSN终端序列号CString(64) 
termType设备类型String(2)01:PC 02:手机 03:收银机 04:移动终端 05:静态码
termSerialNo设备串号CString(64)静态码台卡没有
appVersion应用程序版本号String(8) 
核心交易接口公共响应参数
属性说明必选类型备注
resCode返回码MString(16) 
resMsg返回码描述MString(50) 
data返回数据CObject返回数据.下文定义的响应均为该属性中的内容
sign签名CString(1000) 
signType签名类型CString(8)签名类型,取值:sha-256默认:sha-256
nonceStr随机字符串CString(32)随机字符串,不长于32位。推荐随机数生成算法

SaaS退款申请

请求URL

测试环境:https://test.wsmsd.cn/sit/saas/txn/order_refund 生产环境:https://s2.lakala.com/saas/txn/order_refund

 

SaaS退款申请tradeCode
钱包tradeCode
微信010202
支付宝020202
银联030202
数字货币070202
SaaS退款申请请求参数
属性说明必选类型备注
tradeNo拉卡拉订单号MString(32)拉卡拉唯一订单号
refundReason退款原因MString(64) 
refundAmount退款金额MString 
dealOrderId外部退款订单号MString(32) 
describe商品描述CString(128)单品优惠传
goodsDetail商品详情CString(6000)单品优惠传
outMerchOrderNo外部商户订单号CString 
SaaS退款申请响应参数
属性说明必选类型备注
payRefundNo退款订单号MString(32)账户端退款订单号
refundNo拉卡拉退款订单号MString(32) 
dealOrderRefundNo商户退款订单号MString(32)商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
settlementRefundFee退款金额CString去掉非充值代金券退款金额后的退款金额,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额
totalAmount订单金额MString订单总金额,单位为分,只能为整数,详见支付金额
totalAmount申请退款金额CString商家发起的申请退款金额(含优惠部分)
gmtRefundPay退款完成时间CString(14)退款时间
issAddnData单品营销 附加数据CString 
couponInfo单品营销 优惠信息CString 

 

 

对文档存在疑问的,请联系您的项目对接经理。