扫码支付API接口说明文档

1、.1扫码支付API接口开发指南商户接口规版本(3.0.7)修订时间：2021-08-01目录 TOC o 1-3 h z u HYPERLINK l _Toc12501 第一章 文档描述 PAGEREF _Toc12501 3 HYPERLINK l _Toc15479 1、 文档说明 PAGEREF _Toc15479 3 HYPERLINK l _Toc24957 2、 阅读对象 PAGEREF _Toc24957 3 HYPERLINK l _Toc29143 3、 名词定义 PAGEREF _Toc29143 3 HYPERLINK l _Toc31989 第二章 接口定义 PAGER

2、EF _Toc31989 3 HYPERLINK l _Toc14280 1、 扫码支付 PAGEREF _Toc14280 3HYPERLINK l _公众号支付2、 公众号支付 PAGEREF _Toc14280 3HYPERLINK l _支付异步通知3、 支付异步通知 PAGEREF _Toc190 10HYPERLINK l _交易查询4、 交易查询 PAGEREF _Toc20412 12HYPERLINK l _对账查询5、 对账查询 PAGEREF _Toc25234 14 HYPERLINK l _Toc29269 第三章签名说明 PAGEREF _Toc29269 12 H

3、YPERLINK l _Toc21290 1、 签名算法 PAGEREF _Toc21290 12 HYPERLINK l _Toc1405 2、 密钥生产 PAGEREF _Toc1405 12 HYPERLINK l _Toc8321 附录1错误码说明 PAGEREF _Toc8321 14文档描述文档说明本说明文档用于指导商户接入扫码支付API系统进展的对接，目前支持支付宝、微信扫码。请相关技术人员详细阅读本文档。阅读对象商户开发人员。扫码支付API接口相关技术人员。名词定义合作方：指对接扫码支付平台的机构。商户：指委托收单的营业机构，如超市、便利店等。用户：指在商户系统进展消费的企业或

4、者个人。商户ID： 指支付系统为使用外部接入接口的商户统一分配的唯一标识。商户密钥：指商户在和支付系统进展数据签名认证的密钥，采用RSA加密算法。接口定义扫码支付接入URL： 118.178.126.35:8088/payservice/pay/smzf接入方式：POST方式均可请求协议参数：参数名参数数据类型必填说明订单IDorderIdVARCHARY交易订单ID支付通道payTypeVARCHARY支付通道：W*ZF-微信支付，ZFBZF-支付宝支付商户编码merchantCodeVARCHARY商户编码，接入时系统分配交易金额totalAmountVARCHARY交易金额，单位：元，最

5、小2元交易标题subjectVARCHARY交易标题，显示在微信或支付宝支付页面交易描述descVARCHARY交易描述商户操作员idoperatorIdVARCHARN操作员编号，如员工编码门店编号storeIdVARCHARN商户的门店编号商户终端编号terminalIdVARCHARY商户机器的终端编号支付方式limitPayVARCHARN微信/支付宝：1-不能使用信用卡支付宝：2-不适用花呗3-不使用信用卡/花呗来源信息sourceVARCHARN支付宝分配给下游的pid识别号，2088开头的一串16位数字,对应支付宝的sys_service_provider_id字段商品标记goo

6、dsTagVARCHARN微信渠道可选上送，代金券或立减优惠功能参数，对应微信的goods_tag字段支付宝目前用不到该参数。支付有效时间e*pireTimeVARCHARN指定订单的支付有效时间分钟数，超过有效时间用户将无法支付。假设不指定该参数则系统默认设置24小时支付有效时间。参数允许设置围：1-1440区间的整数值，超过1440默认设置1440支付宝：用户扫码后开场计算支付有效时间微信：用户下单后开场计算支付有效时间回调通知地址notifyurlVARCHARY支付成功失败的通知地址交易终端ipcreateipVARCHARY交易终端IP备注e*tend1VARCHARN备注信息，测试

7、系统必填签名signVARCHARYRSA签名返回协议参数：参数名参数数据类型必填说明返回状态rspCodeVARCHARY返回的错误码，000000代表成功，其它为失败返回信息rspMsgVARCHARY返回信息二维码qrCodeVARCHARY订单的二维码，商户生成二维码提供给用户扫码支付签名signVARCHARYRSA签名接入实例：请求提交方法： payType: ZFBZF, orderId: WE1124567810, merchantCode: , totalAmount: 2, subject: first test, desc: test product, body: tes

8、t product, terminalId: 1213412134, e*tend1: test, notifyurl: 118.178.126.35:8088/payservice/pay/notifytestsucc, createip: 192.168.0.1返回值： rspCode: 000000, rspMsg: OK, qrCode: s: /qr.alipay./ba*02559bawzwz2erezj00d4, sign: Ek7H4c6f5OgechohLFr*cgPoGC/vVy0Bg5*DzYGVIReHYaFtEBfSU*hS*Cf/rDMhM+DZKJaw5jhTU1

9、mE1ijEQoguj6c6gKDSg6f*uEEwbKODlQDW9cHRF*MVki2THe*o*/g8KgipUiEW5HOdNNm4LcwQe8YC+8gauHcKE*SW7Rw=公众号支付接入URL： 118.178.126.35:8088/payservice/pay/pn接入方式：POST方式均可请求协议参数：参数名参数数据类型必填说明订单IDorderIdVARCHARY交易订单ID支付通道payTypeVARCHARY支付通道：W*ZF-微信支付商户编码merchantCodeVARCHARY商户编码，接入时系统分配交易金额totalAmountVARCHARY交易金额，单位

10、：元，最小2元交易标题subjectVARCHARY交易标题，显示在微信或支付宝支付页面交易描述descVARCHARY交易描述商户操作员idoperatorIdVARCHARN操作员编号，如员工编码门店编号storeIdVARCHARN商户的门店编号商户终端编号terminalIdVARCHARY商户机器的终端编号支付方式limitPayVARCHARN微信/支付宝：1-不能使用信用卡支付宝：2-不适用花呗3-不使用信用卡/花呗商品标记goodsTagVARCHARN微信渠道可选上送，代金券或立减优惠功能参数，对应微信的goods_tag字段支付宝目前用不到该参数。支付有效时间e*pireT

11、imeVARCHARN指定订单的支付有效时间分钟数，超过有效时间用户将无法支付。假设不指定该参数则系统默认设置24小时支付有效时间。参数允许设置围：1-1440区间的整数值，超过1440默认设置1440支付宝：用户扫码后开场计算支付有效时间微信：用户下单后开场计算支付有效时间回调通知地址notifyurlVARCHARY支付成功失败的通知地址交易终端ipcreateipVARCHARY交易终端IP跳转路径callbackUrlVARCHARN支付成功跳转路径；form表单形式提交商户后台；子商户公众号标识subAppIdVARCHARY子商户公众号标识子商户公众号下关注的用户openidsub

12、OpenIdVARCHARY子商户公众号下关注的用户openid微信子商户号w*SubMchIdVARCHARN微信支付分配的子商户号是否开具电子发票receiptVARCHARN是否开具电子发票是否原生公众号isRawVARCHARY1:原生公众号(返回json串给jsapi拉起支付)备注e*tend1VARCHARN备注信息，测试系统必填签名signVARCHARYRSA签名返回协议参数：参数名参数数据类型必填说明返回状态rspCodeVARCHARY返回的错误码，000000代表成功，其它为失败返回信息rspMsgVARCHARY返回信息支付码信息payCodeVARCHARYpayCo

13、de:sign:D9F4C32B8F20D348DDFA85C95B291E55,timestamp:1476774382,noncestr:368c7e90e499484e901edbbd501a8dd9,partnerid:15233133,prepayid:w*33454fd6f1dc,package:Sign=W*Pay,appid:w*b5d8ad7674532882)签名signVARCHARYRSA签名接入实例：请求提交方法： payType: ZFBZF, orderId: WE1124567810, merchantCode: , totalAmount: 2, subjec

14、t: first test, body: test product, terminalId: 1213412134, e*tend1: test,6.35:8088/payservice/pay/notifytestsucc, createip: 192.168.0.1 callbackUrl : 118.178.126.35:8088/payservice/pay/callbackurl subAppId : w*a3dbb6050f553164 subOpenId : 9efi3dbb6050f653164 返回值： rspCode: 000000, rspMsg: OK,payCode:

15、timeStamp:74,signType:MD5,package:prepay_id=w*2657a0,paySign:6B0EEA6AE668593A6A290F8247CE46B7,nonceStr:05571626a6f6415f8cb11c91e64b8450,appId:w*a3dbb6050f353164， sign: Ek7H4c6f5OgechohLFr*cgPoGC/vVy0Bg5*DzYGVIReHYaFtEBfSU*hS*Cf/rDMhM+DZKJaw5jhTU1mE1ijEQoguj6c6gKDSg6f*uEEwbKODlQDW9cHRF*MVki2THe*o*/g8

16、KgipUiEW5HOdNNm4LcwQe8YC+8gauHcKE*SW7Rw=支付异步通知接入URL：过程1 中请求参数 notifyurl值接入方式：POST 方式通知请求协议参数：参数名参数数据类型必填说明订单号orderidVARCHARY商户请求订单号商户编码merchantidVARCHARY商户编码交易金额totalAmountVARCHARY交易金额，单位：元交易成功时间payTimeVARCHARY支付成功的时间交易状态trade_stateVARCHARY交易状态：INIT-初始化SUCCESS-成功USERPAYING-等待用户支付NOTPAY-未支付ERROR-支付失败

17、支付系统订单号transcation_idVARCHARY支付系统部交易号签名signVARCHARYRSA签名返回协议参数：参数名参数数据类型必填说明返回状态rspCodeVARCHARY返回的错误码，000000代表成功，其它为失败。返回成功后，将不会再次通知。返回信息rspMsgVARCHARY返回信息签名signVARCHARYRSA签名接入实例： 请求提交方法： orderid: WE1124567810, merchantid: , totalAmount: 2, payTime: 433, trade_state: SUCCESS, transcation_id: BJ55124

18、,返回值： rspCode: 000000, rspMsg: OK, sign: Ek7H4c6f5OgechohLFr*cgPoGC/vVy0Bg5*DzYGVIReHYaFtEBfSU*hS*Cf/rDMhM+DZKJaw5jhTU1mE1ijEQoguj6c6gKDSg6f*uEEwbKODlQDW9cHRF*MVki2THe*o*/g8KgipUiEW5HOdNNm4LcwQe8YC+8gauHcKE*SW7Rw=特别说明：支付异步通知过程在整个支付流程中一定存在。商户系统在收到异步通知过程后， 需向接口返回rspCode为“000000。支付接口根据该返回值判断商户系统是否已经收到结

19、果。假设返回结果不是“000000，支付系统会再次反复向 notifyurl 发送结果，直到商户返回“000000或者到达重复发送次数。当支付系统在异步通知过程中返回在线支付结果时，商户系统在收到数据后， 应该通过sign值判断是否是有效的返回数据，防止数据在网络传输过程中被恶意篡改。本卷须知在收到支付接口订单下行异步通知结果时，商户系统需首先验证订单通知的合法性， 如果不合法，则不要更新商户系统上的订单状态。商户系统订单状态和订单实际金额务必以此次接口订单异步通知的结果为准。商户系统在成功提交订单后，在未没有收到此接口异步通知结果时，请不要更新商户系统上的订单状态在交易异步通知过程中商户系统

20、返回结果值rspCode“00000回支付接口时，“000000并不是将支付接口在交易异步通知的结果原样返回。商户系统返回值“000000时表示商户系统已经成功接收到了结果不管结果是什么，总之是收到了，而其他值表示因为*些原因商户系统并不认为支付接口的返回是有效的。支付接口在收到商户系统的返回后，如果返回的值为“000000支付接口将不再次发送结果，否则支付接口会根据同商户的约定 再次发送结果。交易查询接入URL：118.178.126.35:8088/payservice/pay/query接入方式：POST方式，JSON格式请求协议参数：参数名参数数据类型必填说明订单号orderIdVAR

21、CHARY商户请求订单号商户编码merchantCodeVARCHARY商户编码签名signVARCHARYRSA签名返回协议参数：参数名参数数据类型必填说明返回值rspCodeVARCHARY返回的错误码，000000代表成功，其它为失败返回信息rspMsgVARCHARY返回信息订单号orderIdVARCHARY商户请求订单号支付通道payTypeVARCHARY支付通道交易金额totalAmountVARCHARY交易金额交易时间orderTimeVARCHARY订单生成时间交易状态statusVARCHARY交易状态：INIT-初始化USERPAYING-等待用户支付SUCCESS-

22、成功NOTPAY-未支付ERROR-支付失败交易标题subjectVARCHARY交易标题，显示在微信或支付宝支付页面交易描述descVARCHARY交易描述门店编号storeIdVARCHARY门店编号终端编号terminalIdVARCHARY终端编号签名signVARCHARYRSA签名接入实例： 请求提交方法： orderId: WE1124567810, merchantCode: ,返回值： rspCode: 000000, rspMsg: OK, orderId: WE1124567810, payType: ZFBZF, totalAmount: 2, status: SUCC

23、ESS, subject: first test, desc: test product, storeid: 333333, terminalId: 1213412134对账查询接入URL：118.178.126.35:8088/payservice/pay/settlement接入方式：POST方式请求协议参数：参数名参数数据类型必填说明商户编码merchantCodeVARCHARY商户编码对账日期settleDateVARCHARY对账日期签名signVARCHARYRSA签名返回协议参数：参数名参数数据类型必填说明返回值rspCodeVARCHARY返回的错误码，000000代表成功，

24、其它为失败返回信息rspMsgVARCHARY返回信息对账单contentVARCHARY对账单容签名signVARCHARYRSA签名对账单格式： 请求提交方法：hzf001|87623|950|2.00|20210811|S|000000|success|0.00|ZFBZF|0|*1|每个字段以“| 分割,字段含义参见下表对账流水只包含状态为成功的交易域字段名称类型要求备注1agentNumVARCHAR(32)M代理商编号2merchantCodeVARCHAR(32)M商户编号3transcationIdVARCHAR(32)M平台流水号4 orderIdVARCHAR(32)M代理

25、商请求订单号5amountNumberic(12,2)M交易金额保存两位6settleDateCHAR(8)M对账日期7respTypeCHAR(1)MS成功;8respCodeCHAR(6)M响应码9respMsgVARCHAR(256)O响应描述10feeNumberic(12,2)M商户手续费保存两位11payWayVARCHAR(32)M12storeIdVachar2(32)0商户的门店编号13terminalIdVachar2(32)0商户机具终端编号接入实例： 请求提交方法： merchantCode: , settleDate: 20210624,返回值： rspCode: 000000, rspMsg: OK, content: hzf001|87623|950|2.00|20210811|S|000000|success|0.00|ZFBZF|0|*1|,第三章签名说明签名算法 为了保证网络数据的传输平安， 防止数据在传输过程中被截取、 篡改等， 在调用 API 时双方约定使用 S和 RSA加密算法对通讯数据进展加解密处理。RSA通用加密算法，加密后需要转换为 Base64， 解密前需要将 Base64 加密串转换为