收卡宝API点卡接口说明文档

收卡宝API点卡接口说明收卡宝API点卡接口开发指南商户接口规范版本(2.0.0)收卡宝API点卡接口说明目录第一章文档描述................................................................................................................31、文档说明....................................................................................................................32、阅读对象....................................................................................................................3第二章系统原理................................................................................................................31、术语定义....................................................................................................................32、消费流程....................................................................................................................43、查询流程....................................................................................................................64、系统加密....................................................................................................................6第三章点卡接口定义........................................................................................................61、同步过程接口定义（商户系统发起请求）............................................................62、下行异步通知过程接口定义（收卡宝接口发起请求）........................................8附录1：收卡宝支付接口卡类型说明.................................................................................10收卡宝API点卡接口说明第一章文档描述1、文档说明本说明文档用于指导收卡宝API商户实现与收卡宝API点卡接口的顺利对接。请相关技术人员详细阅读本文档。2、阅读对象商户开发人员。株洲龙脉网络科技限公司收卡宝API点卡接口相关技术人员。第二章系统原理1、术语定义商户：指已独立拥有在线销售系统，并成为收卡宝API点卡接口系统会员，且已使用或者将使用收卡宝API点卡接口实现收付费或其他相关功能需求的企业或者个人。外部接入接口：指收卡宝API通过统一的方式接受外部请求的接口。商户系统：指使用收卡宝API外部接入接口的计算机系统，一般指商户所拥有的在线销售系统。用户：指在商户系统内进行消费的企业或者个人。商户ID：指收卡宝API为使用外部接入接口的商户统一分配的唯一标识。商户密钥：指商户在和收卡宝API确定合作意向时收卡宝API为商户提供的16位字符串。该信息作为商户系统和收卡宝API交互时身份确认的依据，需商户妥善保管。收卡宝API点卡接口说明2、消费流程一般地，在商户系统进行消费时，用户需要向商户支付一定的相关费用。在集成了收卡宝销卡接口后，收卡宝销卡将为商户提供方便的收付费服务。用户在商户系统发起消费请求后，商户系统和收卡宝销卡卡类接口系统（简写为收卡宝接口）的交互流程如下图：图1商户系统和收卡宝接口交互流程具体地，用户的一次消费中，商户系统和收卡宝接口之间会发生2次直接交互过程。收卡宝API点卡接口说明1、同步过程用户在商户系统选择产品或服务，填写订单（如用户选择卡面值、输入卡号、密码等）后，商户系统将用户填写的信息（如卡号、密码、类型、商户系统订单号等）以及相应的参数（如订单金额、商户ID和密钥、异步通知地址等信息）组织为订单信息，通过httpget/post方式提交到收卡宝接口，该过程如图1箭头1所示。当商户系统提交订单到收卡宝接口时，收卡宝接口将同步返回数据给商户系统。商户系统根据该同步返回结果判断订单是否成功提交到收卡宝接口。若订单提交成功，商户系统需等待收卡宝接口的异步通知结果。注意，在收到异步结果之前，商户系统不能对系统内的订单进行成功或者失败处理。若订单提交失败，商户系统需将系统内订单做失败处理。该过程如图1箭头2所示。2、异步过程收卡宝接口将订单处理完成后会异步通知商户系统订单处理结果（通过httpget方式），商户系统需要先验证返回结果的合法性，并根据合法的异步通知的结果，对商户系统的订单进行操作。若异步通知返回充值成功，则商户系统可对订单进行成功操作。注意，实际的订单金额可能和用户提交的订单金额不一致，商户系统必须以收卡宝接口异步通知返回的订单实际金额为准。若异步通知返回充值失败，则商户系统可对订单进行失败操作。该过程如图1箭头4所示。商户系统在成功接收收卡宝接口异步通知的订单结果后，需同步返回1个结果“ok”（页面内不能有其他的任何代码）给收卡宝接口（不论订单结果成功与否），当收卡宝接口收到该结果“ok”后便不再通知商户系统，否则收卡宝接口将根据同商户的约定重复通知商户系统。该过程如图1箭头5所示。如果商户系统将订单成功提交到收卡宝接口后，未收到收卡宝接口的异步通知结果，商户可登陆收卡宝接口商户系统手动重发订单结果通知。需特别注意，当未收到收卡宝接口异步通知结果时，商户系统不能对订单状态进行任何操作，否则造成的损失商户自己承担。收卡宝API点卡接口说明3、查询流程在商户系统将订单成功提交给收卡宝接口后的任意时间，商户系统可发起请求查询订单的处理结果。该流程由商户系统发起，由接口返回相应结果。4、系统加密收卡宝API采用MD5加密方式对传输数据进行签名验证，具体请参考相关接口定义。对MD5加密后的签名值，请注意结果的大小写务必正确。为了确保签名值不是因为MD5加密算法而导致结果不正确，请各商户在调用接口前对字符串1234567890abcdefghijklmnopqrstuvwxyz使用MD5加密算法进行加密，若加密结果为928f7bcdcd08869cc44c1bf24e7abec6则表示MD5加密正常。第三章点卡接口定义1、同步过程接口定义（商户系统发起请求）1、接入URL：(最新地址)2、接入方式：GET方式3、请求协议参数：表1同步过程请求协议参数说明参数名参数可空加入签名说明商户IDpartnerNY商户id,由收卡宝API分配卡类型cardtypeNY卡类型，具体参考附录1卡号cardnoNY卡号密码cardpwdNY密码金额paymoneyNY单位元（人民币），无小数商户订单号ordernumberNY商户系统订单号，该订单号将作为收卡宝接口的返回数据。该值需在商户系统内唯一，收收卡宝API点卡接口说明卡宝系统暂时不检查该值是否唯一下行异步通知地址callbackurlNY下行异步通知的地址，需要以http://开头且没有任何参数备注信息attachYN备注信息，下行中会原样返回。若该值包含中文，请注意编码MD5签名signNN32位小写MD5签名值，GB2312编码4、返回协议参数参数名参数说明操作结果状态状态结果中文说明，详情参见附录25、MD5签名说明：待签名数据为表1中加入签名列值为Y的参数以及商户密钥，签名顺序为表1中partner到callbackurl的顺序加商户密钥。具体MD5签名源串及格式如下：partner={}&cardtype={}&cardno={}&cardpwd={}&paymoney={}&ordernumber={}&callbackurl={}key其中，key为商户签名。6、接入实例：（假设商户Id为10000，商户密钥为4272fafab8869dbd292d959b7542530c）请求提交方法：=10000&cardtype=JUNNET&cardno=123123&cardpwd=123123&paymoney=100.00&orderid=1234567890&callbackurl===jrapi&sign=fde74a4c040b5022cd9c4d9e6b917fcc实际进行MD5加密的串是partner=10000&cardtype=JUNNET&cardno=123123&cardpwd=123123&paymoney=100.00&orderid=1234567890&callbackurl=该串MD5加密结果为a628a914bb149d6e0fc47e5977c47603收卡宝API点卡接口说明7、注意事项：1）商户系统在提交订单时，需在程序内部模拟发起订单的http请求，并且获取同步返回结果。用户在商户平台上进行消费均在商户系统上实现，页面无需跳转到收卡宝接口。2）若商户系统订单提交不成功，请联系收卡宝商务检查在收卡宝接口内，商户是否开通了相应权限。3）订单提交成功，并不是订单充值已经成功，是指收卡宝接口已经成功接收到商户系统的订单(卡号密码面值等信息)，商户系统需要等待订单异步通知结果，即下行过程。4）根据HTTP协议要求，提交参数的值中若存在特殊字符（如：空格、@等）时，为使收卡宝接口能接收到正确的参数，这些特殊字符需要做URLEncoding。需特别注意的是，此时待签名数据应该是原生值而不是encoding之后的值。2、下行异步通知过程接口定义（收卡宝接口发起请求）1、接入URL：过程1中请求参数callbackurl值2、接入方式：GET方式3、请求协议参数：表2下行过程请求协议参数说明参数名参数加入签名说明商户IDpartnerY商户id,由收卡宝API分配商户订单号ordernumbery上行过程中商户系统传入的ordernumber订单结果orderstatusY状态结果中文说明，详情参见附录3订单金额paymoneyY单位元（人民币）收卡宝订单号sysnumberN此次交易中收卡宝接口系统内的订单ID备注信息attachN备注信息，上行中attach原样返回订单结果中文说明msgN状态结果中文说明，详情参见附录2MD5签名signN32位小写MD5签名值，GB