《京东收银接口文档_会员码_V3.0.0》由会员分享，可在线阅读，更多相关《京东收银接口文档_会员码_V3.0.0（48页珍藏版）》请在金锄头文库上搜索。
1、京东收银接口文档V3.0.0京东收银接口文档版本 (V3.0.0)目录1 文档说明61.1功能描述61.2阅读对象61.3术语62支付流程73接口规范84接口安全规范94.1签名算法94.2加密算法94.2.1接口的加密方式：94.2.2接收到京东收银加密报文后的处理方式105参数类型定义115.1PayRequest-支付基础请求密文信息115.2PayResponse-支付基础返回密文信息115.3GoodsInfo 商品信息115.4TermInfo 设备信息126接口136.1刷卡支付136.1.1接口介绍136.1.2参数列表136.1.3参数特殊说明156.1.4样例156.2查询
2、订单196.2.1接口介绍196.2.2参数列表196.2.3参数特殊说明196.2.4样例206.3退款申请226.3.1说明226.3.2参数列表226.3.3参数特殊说明236.3.4样例236.4撤销订单256.4.1接口介绍256.4.2参数列表266.4.3参数特殊说明266.4.4样例266.5查询退款286.5.1接口介绍286.5.2参数列表296.5.3参数特殊说明296.5.4样例296.6查询会员326.6.1接口介绍326.6.2参数列表326.6.3参数特殊说明326.6.4样例336.7核销Loc券346.7.1接口介绍346.7.2参数列表346.7.3参数特殊
3、说明366.7.4样例366.8支付结果通知396.8.1接口介绍396.8.2返回参数列表396.8.3参数特殊说明406.8.4样例406.9退款结果通知416.9.1接口介绍416.9.2返回参数列表426.9.3参数特殊说明436.9.4样例437主要接入步骤457.1商户信息设置。457.2后台代码458附录468.13DES密钥468.2错误码列表46文档修订记录：日期版本说明作者2018-04-032.0新建路会盼、贾建军、张美宁2018-04-212.0修订路会盼、邰广有、胡彦丽2018-05-032.0修订：1：刷卡支付增加 outTradeIp、productName两个参
4、数；2：刷卡支付businessData 改为 会员码业务必填；3：刷卡支付virtualType 改为 必填；4：刷卡支付piType改为 聚合业务必填，会员码业务非必填邰广有2018-05-082.0修订： 新增会员权益接口孙慧强2018-05-112.0修订：1：businessData增加bizId（经营主体）字段2：刷卡支付减少SystemId字段邰广有、孙慧强2018-05-152.0修订：1：“关闭订单”接口增加两个会员码必填参数；2：“查询订单退款状态接口”返回状态修改：处理中改为PROCESSING，去除REFUND状态；3：“查询订单支付状态接口”返回状态修改：处理中改为P
5、ROCESSING邰广有2018-05-172.0修订：1：“关闭订单接口”返回参数resultCode 删除处理中状态PROCESSING，SUCCESS定义为：关单申请接收成功，结果通过查询接口查询；删除返回参数中的payStatus参数；2：“退款申请接口”返回参数resultCode 中SUCCESS定义为：退款申请接收成功，结果通过退款查询接口查询；删除处理中状态PROCESSING邰广有2018-05-212.0修订:1. 刷卡支付接口添加TLECARD业务2. 会员查询接口添加MEMBER业务孙慧强2018-05-232.0修订：1. 刷卡支付接口中productName说明改为
6、聚合付款码业务必填；2. 刷卡支付接口错误码列表增加“C100137 请使用您的京东会员码”邰广有2018-05-252.0修订：增加6.12撤销订单接口邰广有2018-06-012.0会员码业务接口文档独立邰广有2018-06-253.0修改返回信息统一路会盼2018-06-263.0修改piType孙慧强2018-07-093.0优化接口字段描述孙慧强2018-08-213.0异步通知支付退款拆分孙慧强2018-09-063.0优化目录孙慧强2018-09-133.0优化接口描述及样例孙慧强1 文档说明1.1 功能描述京东收银为商户提供一整套支付接口。商户使用这些接口可以便捷的发起支付请求
7、,并引导用户完成支付过程。支付完成以后，通过同步、异步两种方式通知商户的应用服务器。它的优势是支持多支付渠道的组合支付（包括银行卡、白条等支付渠道），支付金额即时从消费者的银行账户或者京东白条账户（若用户开通白条服务）等支付渠道扣除，用户支付过程简便、安全。同时，京东收银又提供了自动退款，以及交易结果查询接口。交易结果查询接口是为了防止商户长时间没有接收到同步、异步结果通知的情况而设计，在这种情况下，商户可以通过交易查询接口查询交易结果，进而更新用户订单状态。1.2 阅读对象本文档面向商户系统设计人员、编程人员及测试人员。该人员需要具备一定的网站开发能力，了解ASP、PHP、JAVA、ASP.
8、NET等开发语言中的一种及SQL数据库语言。1.3 术语名词解释商户指已注册成为京东收银产品的用户、并使用京东收银产品实现其收付费功能需求、为其用户提供各类产品或者相关服务的企业或个人。消费者（用户）指在商户网站等系统购物的企业或个人。请求通过HTTP/HTTPS协议把数据发送给接收方的过程。通知京东收银服务器异步通知。京东收银服务器根据接收到的数据处理完成后，会主动发起通知给商户的服务器，同时携带处理结果信息。返回 页面跳转同步通知。京东收银服务器根据接收到的数据处理完成后，当前页面从京东收银的页面自动跳转回商户页面，同时携带处理结果信息。支付失败 手机号被冻结、商户违约被冻结支付功能、余额
9、不足、超额、订单已支付、订单金额和支付金额不一致等都会导致支付失败。2 支付流程1) 用户首先在商户系统的页面上选择商品并下单，点击支付按钮以后，商户系统向京东收银服务支付接口发起支付请求。2) 商户要根据京东收银接口要求，通过程序得到签名结果以及要传给京东收银服务的订单信息以及商户信息数据集合。在支付请求的时候把数据集合发送到京东收银服务器。3) 京东收银服务会首先验证商户的合法性，以及验证订单金额是否被篡改，如果商户非法，或者订单信息被篡改，京东收银服务会直接拒绝此支付请求；反之，则重定向到支付页面，引导用户填入支付相关信息，在用户确认之后，从用户的各资金账户（银行卡、白条等）扣除相应的金
10、额。4) 支付完成以后京东收银服务会跳转到商户支付请求时传入的URL，并携带支付结果。如果支付成功，京东收银服务后台会发送异步通知到商户传入的通知地址，把支付结果通知商户。3 接口规范京东收银包含两类接口，一种是Form表单接口，另一种是JSON接口。JSON接口规范如下：1) 外层商户号,systemId需要明文传输2) 加密后的密文数据置于cipherJson中3) 接口参数区分大小写4) 空值参数不参与验签、加密。为防止接口数据被篡改或窃听，接口报文数据均进行签名并加密传输，加解密以及签名算法参考“接口安全规范”章节4 接口安全规范4.1 签名算法签名过程分为两步，首先是将原始参数按照规
11、则拼接成一个字符串S1，然后再将S1根据签名算法生成签名字符串sign。参数原始字符串的拼接规则：所有参数按照参数名的ASCII码顺序从小到大排序（字典序），使用json字符串方式拼接成字符串。签名的过程如下：1.对拼接的参数字符串再次在尾部拼接分配给商户的盐（salt）。2.使用UTF-8编码获得byte数组，使用标准MD5算法签名。3.转换为16进制的固定长度32的字符串。注意事项：1.空参数不参与签名2.参数列表中的sign字段不参与签名3.参数区分大小写4.2 加密算法除特定说明外，商户和京东收银接口调用报文采用3DES加密，再转换为16进制字符串 。4.2.1 接口的加密方式：如果商
12、户通过表单方式提交支付请求至收银台，为保证信息安全，表单中的各个字段除了systemId、merchantNo（商户号）、sign(签名)以外，其余字段全部采用3DES进行加密4.2.2 接收到京东收银加密报文后的处理方式4.2.2.1 收到京东收银返回的加密报文后，先判断merchantNo(商户号)是属于商户4.2.2.2 检查接口调用是否正常返回4.2.2.3 再读取cipherJson内的密文内容进行base64解码，再进行3DES解密，4.2.2.4 对解密得到的明文,做验签处理，防止结果被篡改。5 参数类型定义5.1 PayRequest-支付基础请求密文信息参数名称参数编码参数类
13、型必填描述商户号merchantNoString(32)是分配给商户的商户号密文cipherJsonString是加密后的密文签名signString是对原始明文的签名系统名称systemIdString是接入系统名称，统一分配(由京东金融提供)5.2 PayResponse-支付基础返回密文信息参数名称参数编码参数类型必返描述商户号merchantNoString(32)是分配给商户的商户号密文cipherJsonString是加密后的密文签名signString是对原始明文的签名通讯结果successboolean是调用成功返回true否则false此字段是通信标识，非交易标识返回状态码errCodeString否返回状态码返回信息errCodeDesString否返回信息系统名称systemIdString否接入系统名称5.3 GoodsInfo 商品信息名称编码类型必返描述商品编号id是String(30)商品名称nam
