回调发货URL的协议说明_V3

特别声明
1. 本文档基于V3版OpenAPI协议。
2. Hosting应用发货URL只需HTTP协议即可;Non-hosting应用发货URL必须使用HTTPS协议。

目录

1 什么是发货URL?

发货URL即提交支付接入申请时填写的“发货URL”(详见:支付接入申请说明#3. 支付接入申请时需填写的基本资料)。
开发者请按照下列协议进行发货URL的开发。
发货URL用于提供给腾讯后台回调。用户付费成功后,腾讯后台将回调该URL给用户发货,将道具发给用户。

本接口在以下场景使用:
(1)Q点直购模式
(2)道具寄售模式-直购应用道具
(3)道具寄售模式-游戏币快捷支付

属于以下流程中的第7步:
unipay_4.png

2 协议参数

请开发者特别关注:
平台后续可能对协议进行扩展,产生随机参数,因此请不要将参与签名的参数写死。
计算签名时,请以每笔交易接收到的参数为准,接收到的所有参数除sig和cee_extend以外都要参与签名。


参数名称 类型 描述
openid string 与APP通信的用户key,跳转到应用首页后,URL后会带该参数。由平台直接传给应用,应用原样传给平台即可。

根据APPID以及QQ号码生成,即不同的appid下,同一个QQ号生成的OpenID是不一样的。

appid string 应用的唯一ID。可以通过appid查找APP基本信息。
ts string linux时间戳。

注意开发者的机器时间与腾讯计费开放平台的时间相差不能超过15分钟。

payitem string 物品信息。

(1)接收标准格式为ID*price*num,回传时ID为必传项。批量购买套餐物品则用“;”分隔,字符串中不能包含"|"特殊字符。
(2)ID表示物品ID,price表示单价(以Q点为单位,单价最少不能少于2Q点,1Q币=10Q点。单价的制定需遵循道具定价规范),num表示最终的购买数量。
示例:
批量购买套餐,套餐中包含物品1和物品2。物品1的ID为G001,该物品的单价为10Q点,购买数量为1;物品2的ID为G008,该物品的单价为8Q点,购买数量为2,则payitem为:G001*10*1;G008*8*2 。

token string 应用调用v3/pay/buy_goods接口成功返回的交易token。

注意,交易token的有效期为15分钟,必须在获取到token后的15分钟内传递该token,否则将会返回token不存在的错误。

billno string 支付流水号(64个字符长度。该字段和openid合起来是唯一的)。
version string 协议版本号,由于基于V3版OpenAPI,这里一定返回“v3”。
zoneid string 支付营销分区配置说明页面,配置的分区ID即为这里的“zoneid”。

如果应用不分区,则为0。
回调发货的时候,根据这里填写的zoneid实现分区发货。
注:2013年后接入的寄售应用,此参数将作为分区发货的重要参数,如果因为参数传错或为空造成的收入损失,由开发商自行承担。

providetype string 发货类型,这里请传入0。

0表示道具购买,1表示营销活动中的道具赠送,2表示交叉营销任务集市中的奖励发放。

amt string Q点/Q币消耗金额或财付通游戏子账户的扣款金额。可以为空,若传递空值或不传本参数则表示未使用Q点/Q币/财付通游戏子账户。

允许游戏币、Q点、抵扣券三者混合支付,或只有其中某一种进行支付的情况。用户购买道具时,系统会优先扣除用户账户上的游戏币,游戏币余额不足时,使用Q点支付,Q点不足时使用Q币/财付通游戏子账户。
这里的amt的值将纳入结算,参与分成。
注意,这里以0.1Q点为单位。即如果总金额为18Q点,则这里显示的数字是180。请开发者关注,特别是对账的时候注意单位的转换。

payamt_coins string 扣取的游戏币总数,单位为Q点。可以为空,若传递空值或不传本参数则表示未使用游戏币。

允许游戏币、Q点、抵扣券三者混合支付,或只有其中某一种进行支付的情况。用户购买道具时,系统会优先扣除用户账户上的游戏币,游戏币余额不足时,使用Q点支付,Q点不足时使用Q币/财付通游戏子账户。
游戏币由平台赠送或由好友打赏,平台赠送的游戏币不纳入结算,即不参与分成;好友打赏的游戏币按消耗量参与结算(详见:货币体系与支付场景)。

pubacct_payamt_coins string 扣取的抵用券总金额,单位为Q点。可以为空,若传递空值或不传本参数则表示未使用抵扣券。

允许游戏币、Q点、抵扣券三者混合支付,或只有其中某一种进行支付的情况。用户购买道具时,可以选择使用抵扣券进行一部分的抵扣,剩余部分使用游戏币/Q点。
平台默认所有上线支付的应用均支持抵扣券。自2012年7月1日起,金券银券消耗将和Q点消耗一起纳入收益计算(详见:货币体系与支付场景)。

sig string 请求串的签名,由需要签名的参数生成。

(1)签名方法请见文档:腾讯开放平台第三方应用签名参数sig的说明
(2)按照上述文档进行签名生成时,需注意回调协议里多加了一个步骤:
在构造源串的第3步“将排序后的参数(key=value)用&拼接起来,并进行URL编码”之前,需对value先进行一次编码 (编码规则为:除了 0~9 a~z A~Z !*() 之外其他字符按其ASCII码的十六进制加%进行表示,例如“-”编码为“%2D”)。
(3)以每笔交易接收到的参数为准,接收到的所有参数除sig以外都要参与签名。为方便平台后续对协议进行扩展,请不要将参与签名的参数写死。
(4)所有参数都是string型,进行签名时必须使用原始接收到的string型值。 开发商出于本地记账等目的,对接收到的某些参数值先转为数值型再转为string型,导致字符串部分被截断,从而导致签名出错。如果要进行本地记账等逻辑,建议用另外的变量来保存转换后的数值。

3 协议返回包

应用的返回包应该包含如下参数:

ret: 返回码。

msg: 道具发放操作的结果,成功为“OK”,失败则表明错误原因(必须使用utf8编码)。

腾讯设置的调用开发者发货超时是2秒钟,请开发者注意超时时间设置不要超过2秒,否则腾讯后台将返回“系统繁忙”的错误消息。
返回建议:
1.在发货接口中记录被调用的log,用于查看是否发货回调接口能够被腾讯支付服务器回调, 发起一笔支付请求,查看发货回调接口是否有被调用。
2.联调回调发货接口时先在接口上固定返回发货成功的标准json字符串{"ret":0,"msg":"OK"}, 测试一次支付,查看支付服务器是否能正常接收到回调发货接口返回的标准json内容。
注意:返回的内容中不能有空格、tab等字符、不能有其它多余的内容。
3.以上两步都能顺利通过,说明回调接口能正常被支付服务器调用,然后再在回调接口中加入游戏发货的业务逻辑。

4 协议错误码

应用的错误码应该从0开始,按照整数递增的方式进行定义,建议应用按照如下描述定义错误码:


0: 成功

1: 系统繁忙

2: token已过期

3: token不存在

4: 请求参数错误:(这里填写错误的具体参数)

5 请求示例

Hosting应用发货URL只需HTTP协议即可;Non-hosting应用发货URL必须使用HTTPS协议。
回调发货请求的签名生成较为复杂,许多应用在此出错,因此下面演示了sig签名的生成细节。开发者可以下面的示例来验证sig的详细过程,但不能直接复制。

第一步: 应用接收到腾讯支付后台发送过来的请求
该请求通过后台发送,因此所有参数都未进行URL编码。但是该请求中所带的sig却进行了URL编码(这一点请开发者关注,在回调协议中这里比较特殊)。
请求示例如下:
http://ip/cgi-bin/temp.py?openid=test001&
appid=33758&ts=1328855301&payitem=323003*8*1&token=53227955F80B805B50FFB511E5AD51E025360&
billno=-APPDJT18700-20120210-1428215572&version=v3&zoneid=1&providetype=0&amt=80&payamt_coins=20&
pubacct_payamt_coins=10&sig=VvKwcaMqUNpKhx0XfCvOqPRiAnU%3D

特别提示:
请求中的红色部分为应用指定的发货URL,是开发者提交支付接入申请时填写的“发货URL”(详见:支付接入申请说明#3. 支付接入申请时需填写的基本资料)。

第二步: 应用对该请求进行解析,根据得到的请求源参数来计算sig
对上面的请求进行解析,得到源参数如下:

method:GET
url_path: /cgi-bin/temp.py
假设appkey为: 12345f9a47df4d1eaeb3bad9a7e54321


请求源参数以及对应的值为:(注意:请以接收到的参数为准,除sig外的所有参数都需要参与签名) 
amt: 80
appid: 33758
billno: -APPDJT18700-20120210-1428215572 (计算sig时,本接口billno中的“-”符号必需手动转换成%2D)
openid: test001
payamt_coins: 20
payitem: 323003*8*1
ts: 1328855301
providetype: 0
pubacct_payamt_coins: 10
token: 53227955F80B805B50FFB511E5AD51E025360
version: v3
zoneid: 1


在回调发货协议中,在进行签名生成时,回调协议里多加了一个步骤: 
在构造源串第3步之前(sig生成通用步骤说明详见这里),需对value先按照如下编码规则进行编码(注意这里不是urlencode):
除了 0~9 a~z A~Z !*() 之外其他字符按其ASCII码的十六进制加%进行表示,例如“-”编码为“%2D”。
payitem中,单价如果有小数点“.”,请编码为“%2E”。


编码后的参数为:
amt: 80
appid: 33758
billno: %2DAPPDJT18700%2D20120210%2D1428215572 
openid: test001
payamt_coins: 20
payitem: 323003*8*1
ts: 1328855301
providetype: 0
pubacct_payamt_coins: 10
token: 53227955F80B805B50FFB511E5AD51E025360
version: v3
zoneid: 1


执行构造源串的第3步:“将排序后的参数(key=value)用&拼接起来,并进行URL编码”(sig生成通用步骤说明详见这里)。


则源串为:GET&%2Fcgi-bin%2Ftemp.py&amt%3D80%26appid%3D33758%26billno%3D%252DAPPDJT18700%252D20120210%
252D1428215572%26openid%3Dtest001%26payamt_coins%3D20%26payitem%3D323003%2A8%2A1%26providetype%3D0%26
pubacct_payamt_coins%3D10%26token%3D53227955F80B805B50FFB511E5AD51E025360%26ts%3D1328855301%26
version%3Dv3%26zoneid%3D1


密钥为:12345f9a47df4d1eaeb3bad9a7e54321&


生成的签名为: VvKwcaMqUNpKhx0XfCvOqPRiAnU=



第三步: 应用将自己生成的sig与腾讯支付后台发送的请求中的sig进行比对
注意: 应用接收到的腾讯支付平台发送过来的请求后,请先对请求中的sig值做一次URL解码;
然后再将解码后的sig值与应用自己生成的sig值进行比对。
在PHP中,通过$_GET['sig']获取sig值,PHP语言本身对sig值进行了URL解码,不需要再次解码。

如果sig值一致,表示该请求合法,应用可以处理该请求并将结果返回给腾讯支付后台。

6 返回示例

正确返回示例:(必须在2秒内发货并返回此应答。)

{"ret":0,"msg":"OK"}


错误返回示例:

{"ret":4,"msg":"请求参数错误:(sig)"}

相关文档

上一步:fusion2.dialog.buy

下一步:v3/pay/confirm_delivery


其他相关文档:支付接入#支付接入文档索引 | 支付测试环境说明 | 支付错误码说明 | 支付功能开发相关FAQ

防重逻辑说明

回调发货接口需要对支付服务器发起的发货回调进行防重处理,避免因为触发补发发货逻辑导致业务重复发货。

以上信息是否解决您的问题?

Copyright © 1998 - 2017 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部