口袋支付API接口文档

口袋支付平台商户支付功能接口规范

版本号修订日期

2.0 2013年4月17日

3.0 2015年6月15日

3.2 2015年10月27日

功能说明：

本接口主要目的是为了让商户自有系统自由接入口袋支付平台，完成网站支付接入，用户支付后，平台会即时返回结果给商户。

接口商户是根据口袋支付提供的接口文档传递相关的请求参数到平台里，口袋支付平台验证参数后，会引导用户到相应的页面进行支付操作，用户成功填入支付信息后，口袋支付平台将用户的支付成功与失败状态通知商户。

接口商户可以在自己的页面带入一些附加信息，口袋支付平台在回调时将该信息原样返回。

本接口支持那些语言？

本平台接口支持大部分web语言，比如ASP，PHP，ASPX，JSP。

接口支持的协议方式？

本平台使用http+GET/POST方式，如需https协议，请与平台客服联系。

- 1 –

口袋支付

接口应用类型？

接口是面向所有需要支付购买的行业，软件、商城、游戏等均可以进行集成接入。

接口提交编码？

口袋支付接口统一编码为：GB2312，编码错误可能导致乱码订单错误或者不能正确返回结果。支付流程图

- 2 –

口袋支付

网关接口规范

（1）网关接口提交参数：

商户向平台网关提交的参数

卡类网关地址：/pay/Card.aspx

网银网关地址：/pay/Bank.aspx

兼容易宝卡类网关地址：/gateway/yeepay/Card.aspx

兼容易宝网银网关地址：/gateway/yeepay/Bank.aspx

网银网关包括支付宝、微信、财付通等非卡类支付方式具体通道编码详见具体参数详见附录参数参数说明参与签名类型备注

P_UserId商户ID 是整型数字必须（商户管理中心查看）

P_OrderId 商户订单号是字符串，最长32位必须，在商户系统中保持唯一P_CardId 卡类交易时的卡号是字符串，最长20位卡类交易时必须，网银支付为空P_CardPass 卡类交易时的卡密是字符串，最长20位卡类交易时必须，否则可为空P_FaceValue 面值是float，保留2位小数必须

P_ChannelId 充值类型是整型数字必须(具体参数详见附录)

P_Subject 产品名称否字符串，最长20位可为空

P_Price 产品价格否float，保留2位小数必须，可传0

- 3 –

口袋支付

P_Quantity 产品数量否整型数字必须

P_Description 银行ID 否字符串，最长20位充值类型为在线银行时必填

P_Notic 用户附加信息否字符串，最长50位可为空

P_Result_URL 充值状态通知地址否字符串，最长100位必须

P_Notify_URL 充值后网页跳转地址否字符串，最长100位可为空

P_PostKey 签名认证串－字符串必须

说明：

1.签名认证P_PostKey的生成：必须按照“参与签名”状态为“是”的参数按其顺序用“|”组合，最后加上用户密钥，然后进行32位的md5编码，比如：P_PostKey=md5_32(P_UserId| P_OrderId| P_CardId| P_CardPass |P_FaceValue| P_ChannelId|SalfStr)，SalfStr是您的安全码，如安全码被泄漏可通过平台重置。注意：非卡类支付时P_CardId、P_CardPass虽然为空但也须要参与P_PostKey的生成

2. P_Result_URL必须填写，而且是http://开头的绝对网络地址，否则充值成功后，您将获取不到充值结果，提交信息结果错误代码详见附录

3. 接口提交例：

/pay/Card.aspx?P_UserId=1000001&P_OrderId=90898089890we8r098erewr&&P_CardId=S0989899809342343443&P_ CardPass=908932849&&P_FaceValue=10.00&&P_ChannelId=3&P_Subject=MyPay&P_Price=10.00&P_Quantity=1&P_Description=10001&& P_Notic=sometext&&P_PostKey=SDFS098KLJLKSJDFSKLJLKKLSF&P_Result_url=http://您的域名/result_url.asp&P_Notify_URL= http:// 您的域名/notify_Url.asp

示例中：是平台地址，http://您的域名/result_url.asp是您用于接收充值报告的回调地址，当用户通过接口充值成功后，平台后台自动调用这个地址；http://您的域名/notify_Url.asp是用户充值成功后的转向地址。

（2）充值状态回调/商户取货转向参数说明

充值状态回调：用户通过本平台网关支付后，本平台接收到充值报告状态时，立即向您在提交网关参数中的P_Result_URL（充值状态回调地址），传递充值报告，您根据这个充值报告的状态，决定给是否给用户增加网站服务（常用：触发加款、触发续费等）；提醒：写结果回调时别忘了判断该订单是否已经处理过，以免造成重复处理叠加服务

商户取货转向：在提交到API接口的时候，如果正确传递了P_Notify_URL参数，那么在商户充值成功后时，就自动转向到P_Notify_URL所指的地址，同时跟上以下参数表的所有参数。

- 4 –

口袋支付

参数参数说明参与签名类型备注

P_UserId商户ID 是整型数字必须

P_OrderId 商户订单号是字符串，最长32位必须，在商户系统中保持唯一

P_CardId 卡类充值时的卡号是字符串，最长20位卡类充值时必须，否则可为空

P_CardPass 卡类充值时的卡密是字符串，最长20位卡类充值时必须，否则可为空

P_FaceValue 面值是float，保留2位小数必须

P_ChannelId 充值类型是整型数字必须(具体参数详见附录)

P_PayMoney 实际充值金额否float，保留2位小数必须

P_Subject 产品名称否字符串，最长20位可为空

P_Price 产品价格否float，保留2位小数必须，可传0

P_Quantity 产品数量否整型数字必须

P_Description 银行ID（点击查看）否字符串，最长20位充值类型为在线银行时必填

P_Notic 用户附加信息否字符串，最长50位可为空

P_ErrCode 错误代码否整型数字必须(错误代码详见附录)

P_ErrMsg 错误描述否字符串可为空

P_PostKey 签名认证串－字符串必须

- 5 –

口袋支付