v3/pay/get_balance

目录

What's New?

2012年9月27日,新增返回参数“comm_balance”,用于返回公共游戏币账户余额。

1 功能说明

获取用户游戏币余额。

游戏币属于二级货币,其获取方式及使用规则详见:货币体系与支付场景#附录III:游戏币使用场景以及规则

2 接口调用说明

2.1 URL

http://[域名]/v3/pay/get_balance

正式环境域名或测试环境IP详见:API3.0文档#请求URL说明

2.2 格式

json

2.3 HTTP请求方式

GET, POST

2.4 IP限制

TRUE

2.5 输入参数说明

各个参数请进行URL编码,编码时请遵守 RFC 1738

(1)公共参数
发送请求时必须传入公共参数,详见公共参数说明

(2)私有参数

参数名称 是否必须 类型 描述
pfkey 必须 string 跳转到应用首页后,URL后会带该参数。由平台直接传给应用,应用原样传给平台即可。

表示平台的信息加密串,根据openid,openkey,pf,appid等生成。
注:有的应用调用本接口时会返回pfkey非法的错误,这种错误可能由以下原因引起:
(1)传入的pf与平台不一致(例如进入的平台是Qzone,但传入的pf是pengyou),导致生成的pfkey错误。
pf值是由平台直接传给应用,应用原样传给平台即可,出现这种错误的原因是开发者自己手动构造的pf值,而不是使用平台传递的值。
(2)传入的openkey不是当前页面返回的openkey。同一个用户如果在不同时间打开多个应用页面,页面返回的openkey是不一样的,这些openkey在各自的页面都可用。当前页面的pfkey应该使用当前页面的openkey来生成。

ts 必须 string linux时间戳。

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

zoneid 必须 string 支付接入页面,配置的分区ID即为这里传入的“zoneid”。

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

2.6 请求示例

注:下面的请求示例用来演示sig的生成,开发者可以用来验证计算方法,但不能直接复制。

http://119.147.19.43/v3/pay/get_balance?openid=00000000000000000000000014BDF6E4&openkey=8A0B10E704DBD4571B93E5CBC8CE2295&appid=15499&pf=qzone&
format=json&pfkey=865599BED0D095E8AD5A7D1B4C18EF5B&ts=1334541877&sig=WgnmvsAV8vYAE0ScpGtqt8/58M4=


下面演示了sig签名的生成细节:

method:GET
url_path:/v3/pay/get_balance
假设appkey为: 56abfbcd12fe46f5ad85ad9f2faf36d7


请求参数包括:
params:

 openid:00000000000000000000000014BDF6E4
 openkey:8A0B10E704DBD4571B93E5CBC8CE2295
 appid:15499
 pf:qzone
 format:json
 pfkey:865599BED0D095E8AD5A7D1B4C18EF5B
 ts:1334541877


则源串为:GET&%2Fv3%2Fpay%2Fget_balance&appid%3D15499%26format%3Djson%26openid%3D00000000000000000000000014BDF6E4%26
openkey%3D8A0B10E704DBD4571B93E5CBC8CE2295%26pf%3Dqzone%26pfkey%3D865599BED0D095E8AD5A7D1B4C18EF5B%26ts%3D
1334541877


密钥为:56abfbcd12fe46f5ad85ad9f2faf36d7&


生成的签名为:WgnmvsAV8vYAE0ScpGtqt8/58M4=

2.7 返回参数说明

参数名称 描述
ret 私有返回码说明如下:

1001:请求参数错误;
1059:TOKEN超时(确认的订单必须是2个小时内的订单,否则返回该错误码);
1060:订单已回滚;
1061:订单已确认;
1099:系统繁忙。
公共返回码详见公共返回码说明#OpenAPI V3.0 返回码
注意支付API接口返回-5错误通常是由于sig生成错误引起的,请根据腾讯开放平台第三方应用签名参数sig的说明详细检查sig的生成是否正确。

msg 如果出错,返回错误信息。
is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

0或者不返回:没有数据丢失,可以缓存。
1:有部分数据丢失或错误,不要缓存。

balance 获取到的游戏币余额。
comm_balance 已接入支付且做货币分区的应用或接入寄售系统的应用,需关注此参数。

如果存在公共游戏币账户,则这里返回公共游戏币账户中游戏币余额,否则不返回该参数。

2.8 正确返回示例

Content-type: text/html; charset=utf-8
{
"ret":0,
"is_lost":0,
"msg":"OK",
"balance":200
}

2.9 错误返回示例

Content-type: text/html; charset=utf-8
{
"ret":1002,
"msg":"请先登录"
}

相关文档

游戏币充值和查询开发说明

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

Copyright © 1998 - 2019 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部