布优API网银接口说明文档.doc

《布优API网银接口说明文档.doc》由会员分享，可在线阅读，更多相关《布优API网银接口说明文档.doc（9页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、布优API网银接口开发指南商户接口规范版本(2.0.0)目录第一章文档描述31、文档说明32、阅读对象3第二章系统原理31、术语定义32、消费流程43、查询流程44、查询流程4第三章网银接口定义41、同步过程接口定义（商户系统发起请求）42、下行异步通知过程接口定义（布优接口发起请求）63、下行同步通知过程接口定义（布优接口发起请求）8附录 1：布优支付网关银行类型说明8第一章 文档描述1、 文档说明本说明文档用于指导布优API商户实现与布优API网银接口的顺利对接。请相关技术人员详细阅读本文档。2、 阅读对象商户开发人员。四川布优网络科技限公司布优API网银接口相关技术人员。第二章 系统原理

2、1、 术语定义商户：指已独立拥有在线销售系统，并成为布优API网银接口系统会员，且已使用或者将使用布优API网银接口实现收付费或其他相关功能需求的企业或者个人。外部接入接口：指布优API通过统一的方式接受外部请求的接口。商户系统：指使用布优API外部接入接口的计算机系统，一般指商户所拥有的在线销售系统。用户：指在商户系统内进行消费的企业或者个人。商户ID： 指布优API为使用外部接入接口的商户统一分配的唯一标识。商户密钥：指商户在和布优API确定合作意向时布优API为商户提供的16 位字符串。该信息作为商户系统和布优API交互时身份确认的依据，需商户妥善保管。2、 消费流程通常，一次支付最少包

3、括2 个交互过程。第一个过程是商户系统将在线支付等信息提交布优支付网关说明文档到布优接口的过程，称之为上行过程。第二个过程是在支付完成后，布优接口通过server to server 方式将支付结果告知商户系统的过程，称之为下行异步通知过程。如果用户在跳转到布优API接口完成支付操作后，需要布优API接口将处理结果立即返回给商户系统的下一步页面，让用户继续完成整个操作流程，此时支付还应包括第三个流程，下行同步通知过程。该过程需要在上行过程中提交参数hrefbackurl。3、 查询流程在商户系统将订单成功提交给布优接口后的任意时间，商户系统可发起请求查询订单的处理结果。该流程由商户系统发起，由

4、接口返回相应结果。4、 查询流程布优API采用MD5 加密方式对传输数据进行签名验证，具体请参考相关接口定义。对MD5 加密后的签名值，请注意结果的大小写务必正确。为了确保签名值不是因为MD5 加密算法而导致结果不正确，请各商户在调用接口前对字符串abcdefghijklmnopqrstuvwxyz 使用MD5 加密算法进行加密，若加密结果为928f7bcdcd08869cc44c1bf24e7abec6 则表示MD5 加密正常。第三章 网银接口定义1、 同步过程接口定义（商户系统发起请求）1、 接入URL： (最新地址)2、 接入方式：GET 方式3、 请求协议参数：表1 同步过程请求协议参

5、数说明参数名参数可空加入签名说明商户IDpartnerNY商户id,由布优API分配银行类型banktypeNY银行类型，具体参考附录1,default为跳转到布优接口进行选择支付金额paymoneyNY单位元（人民币）商户订单号ordernumberNY商户系统订单号，该订单号将作为布优接口的返回数据。该值需在商户系统内唯一，布优系统暂时不检查该值是否唯一下行异步通知地址callbackurlNY下行异步通知的地址，需要以http:/开头且没有任何参数下行同步通知地址hrefbackurlYN下行同步通知过程的返回地址(在支付完成后布优接口将会跳转到的商户系统连接地址)。注：若提交值无该参数

6、，或者该参数值为空，则在支付完成后，布优接口将不会跳转到商户系统，用户将停留在布优接口系统提示支付成功的页面。备注信息attachYN备注信息，下行中会原样返回。若该值包含中文，请注意编码MD5签名signNN32位小写MD5签名值，GB2312编码4、 MD5签名说明：待签名数据为表1 中加入签名列值为Y 的参数以及商户密钥，签名顺序为表1 中partner到callbackurl 的顺序加商户密钥。具体MD5 签名源串及格式如下：partner=&banktype=&paymoney=&ordernumber=&callbackurl=key其中，key为商户签名。5、 接入实例：（假设商

7、户 Id 为 10000，商户密钥为 4272fafab8869dbd292d959bc） 请求提交方法：实际进行 MD5 加密的串是partner=10000&banktype=ICBC&paymoney=100.00&orderid=&callbackurl=该串 MD5 加密结果为 b2f6c044f52a09f1c926f9eef535b7ce6、 特别说明： 在接口使用中，商户系统内发起请求时应使用页面跳转的方式跳转到接口地址。如在JSP中，使用response.sendRedirect(接口地址及参数)，在.net中使用 Response.Redirect(接口地址及参数)。 若

8、hrefbackurl 有效，则在跳转返回通知过程中，布优接口将使用相同方法跳转回商 户系统，跳转地址是 hrefbackurl。 根据 HTTP 协议要求，提交参数的值中若存在特殊字符（如：空格、等）时，为 使布优接口能接收到正确的参数，这些特殊字符需要做 URL Encoding。需特别注意的是， 此时待签名数据应该是原生值而不是 encoding 之后的值。2、 下行异步通知过程接口定义（布优接口发起请求）1、 接入URL：过程1 中请求参数 callbackurl 值2、 接入方式：GET 方式3、 请求协议参数：表 2 下行过程请求协议参数说明参数名参数加入签名说明商户IDpartn

9、erY商户id,由布优API分配商户订单号ordernumbery上行过程中商户系统传入的ordernumber订单结果orderstatusY1:支付成功，非1为支付失败订单金额paymoneyY单位元（人民币）布优订单号sysnumberN此次交易中布优接口系统内的订单ID备注信息attachN备注信息，上行中attach原样返回MD5签名signN32位小写MD5签名值，GB2312编码4、 MD5签名说明：待签名数据为表2中加入签名列值为Y的参数以及商户密钥，签名顺序为表2中partner到paymoney的顺序加商户密钥。具体 MD5 签名源串及格式如下：partner=&order

10、number=&orderstatus=&paymoney=key其中,key为商户签名5、 特别说明： 下行异步通知过程在整个支付流程中一定存在。商户系统在收到下行通知过程后， 需向布优接口返回“ok”。布优接口根据该返回值判断商户系统是否已经收到结果。若返回结果不是“ok”，布优接口会根据商家和布优接口的约定，再次反复向 callbackurl 发送结果，直到商户返回“ok”或者达到和商户约定的重复发送次数。 当布优接口在下行异步通知过程中返回在线支付结果时，商户系统在收到数据后， 应该通过sign值判断是否是有效的返回数据，防止数据在网络传输过程中被恶意篡改。6、 注意事项 在收到布优接

11、口订单下行异步通知结果时，商户系统需首先验证订单通知的合法性， 如果不合法，则不要更新商户系统上的订单状态。 商户系统内订单状态和订单实际金额务必以此次布优接口订单异步通知的结果为准。 商户系统在成功提交订单后，在未没有收到布优接口异步通知结果时，请不要更新商户系统上的订单状态 在下行异步通知过程中商户系统返回结果值“ok”回布优接口时，“ok”并不是将布优接口在下行异步通知的结果原样返回。商户系统返回值“ok”时表示商户系统已经成功接收到了结果（不论结果是什么，总之是收到了），而其他值表示因为某些原因商户系统并不认为布优接口的返回是有效的。布优接口在收到商户系统的返回后，如果返回的值为“ok

12、”布优接口将不再次发送结果，否则布优接口会根据布优接口同商户的约定 再次发送结果。3、 下行同步通知过程接口定义（布优接口发起请求）1、 接入URL：过程1 中请求参数 hrefbackurl值2、 接入方式：GET 方式3、 请求协议参数：该过程参数同表2所示4、 特别说明:如果用户在跳转到布优数卡接口完成支付操作后，需要布优销卡接口将处理结果立即返回给商户系统的下一步页面，让用户继续完成整个操作流程，此时支付还应包括下行同步通知过程。该过程需要在上行过程中提交参数hrefbackurl。当布优接口在下行同步通知过程中返回在线支付结果时，商户系统在收到数据后，应该 通过sign值判断是否是有效的返回数据，防止数据在网络传输过程中被恶意篡改。附录 1：布优支付网关银行类型说明银行编码银行名称ICBC工商银行ABC农业银行CCB建设银行BOC中国银行CMB招商银行BCCB北京银行BOCO交通银行CIB兴业银行NJCB南京银行CMBC民生银行CEB光大银行PINGANBANK平安银行CBHB渤海银行HKBEA东亚银行NBCB宁波银行CTTIC中信银行GDB广发银行SHB上海银行SPDB上海浦东发展银行PSBS中国邮政HXB华夏银行BJRCB北京农村商业银行SRCB上海农商银行SDB深圳发展银行CZB浙江稠州商业银行ALIPAY支付宝TENPAY财付通WEIXIN微信