v3/pay/get_pubacct_balance

特别声明
本接口仅针对已经接入支付的应用。

目录

1 功能说明

获取用户的金券、银券、铜券余额。
抵扣券是由平台通过抽奖方式发放给用户,用户在应用内购买道具时可直接抵扣Q点消费的现金券。
抵扣券使用规则详见:货币体系与支付场景#附录II:抵扣券使用场景以及规则

2 接口调用说明

2.1 URL

http://[域名]/v3/pay/get_pubacct_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后会带该参数。

表示平台的信息加密串。由平台直接传给应用,应用原样传给平台即可。

ts 必须 string linux时间戳。

2.6 请求示例

https://113.108.20.23/v3/pay/get_pubacct_balance?
appid=15499&openid=00000000000000000000000014111111&openkey=0F439EE1282F21F13E2332BA11111111&
pf=qzone&pfkey=0B7B3E7F246B361639F97C9BE1FB9F49&ts=1331561610&sig=Fk3sNoHBD5%2BqXSmquZzMOqSIoak%3D

假设上述应用的appkey为123456789876543,则按照上述请求示例生成sig签名的细节如下:

method=GET
url=/v3/pay/get_pubacct_balance
secretkey=123456789876543&
key=appid,value=15499
key=openid,value=00000000000000000000000014111111
key=pf,value=qzone
key=pfkey,value=0B7B3E7F246B361639F97C9BE1FB9F49
key=ts,value=1331561610


则源串为:
GET&%2Fv3%2Fpay%2Fget_pubacct_balance&appid%3D15499%26openid%3D00000000000000000000000014111111%26
openkey%3D0F439EE1282F21F13E2332BA11111111%26pf%3Dqzone%26
pfkey%3D0B7B3E7F246B361639F97C9BE1FB9F49%26ts%3D1331561610
密钥为:123456789876543&


生成的签名为: Fk3sNoHBD5%2BqXSmquZzMOqSIoak=
由于所有参数传输前都要进行URL编码,因此上面的请求示例中的签名为:Fk3sNoHBD5%2BqXSmquZzMOqSIoak%3D

2.7 返回参数说明

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

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

msg 如果错误,返回错误信息。

is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

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

gold 金券数额 (不返回该字段也表示数额为0)。

silver 银券数额 (不返回该字段也表示数额为0)。

cuprum 铜券数额 (不返回该字段也表示数额为0)。

2.8 正确返回示例

JSON示例:

Content-type: text/html; charset=utf-8
{
"ret":0,
"is_lost":0,
"gold": 2
}

2.9 错误返回示例

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

相关文档

抽奖送礼包

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

Copyright © 1998 - 2018 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部