# pay_v2.cancelPay

本接口应在服务器端调用，详细说明参见服务端API。

退回扣除游戏币。本接口开通了虚拟支付的小游戏可用。若扣除游戏币的订单在有效时间内，可以通过本接口退回原扣除订单的全部或者部分游戏币。若部分退，可以支持多次发起，总额不超过即可。

调用方式：

HTTPS 调用

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/game/cancelpay?access_token=ACCESS_TOKEN&signature=SIGNATURE&sig_method=SIG_METHOD&pay_sig=PAY_SIGNATURE

# 请求参数

# Query参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证
signature	string	是	用户登录态签名
sig_method	string	是	用户登录态签名的哈希方法，只支持hmac_sha256，请传入"hmac_sha256"
pay_sig	string	是	支付请求签名（pay_sig）算法说明

# POST Body

属性	类型	必填	说明
openid	string	是	用户唯一标识符
offer_id	string	是	支付应用ID（OfferId）
ts	number	是	当前UNIX时间戳（请尽可能确保时间准确），单位：秒如：1668136271
zone_id	string	是	已发布的分区ID（MP-分区配置-分区ID）需要和env对应
env	number	是	环境配置 0：现网环境（也叫正式环境） 1：沙箱环境
user_ip	string	是	用户外网ip
amount	number	是	本次退回的退游戏币的数量（支持部分、多次退）（新增字段）
bill_no	string	是	扣除游戏币订单号，业务需要保证全局唯一，相同的订单号多次请求不会重复扣除；长度不超过63，只能是数字、英文大小写字母及_-的组合；不能以下划线（_）开头（2.0新增约束）
pay_bill_no	string	是	扣除游戏币订单号（原1.0的bill_no字段）；与pay_v2.Pay接口中的bill_no对应

# 返回值

# Object

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
bill_no	string	退回游戏币订单号

errcode 的合法值

值	说明	最低版本
0	请求成功
-1	系统繁忙，此时请开发者稍候再试
90000	订单不存在
90010	signature签名错误
90011	pay_sig签名错误
90012	订单号重复
90014	请求退回到游戏币的数量超过原有订单剩余数量
90015	原有订单游戏币已全部退回
90016	sessionkey fail，用户sessionkey过期，需要重走登录流程
90018	参数错误，具体参数见errmsg描述

# cURL请求

curl -d '{
  "offer_id": "12345678",
  "openid": "oUrsfxxxxxxxxxx",
  "ts": 1668512806,
  "zone_id": "1",
  "env": 0,
  "bill_no": "test_cancel_pay_1668512806",
  "pay_bill_no": "test_pay_1668512428",
  "amount": 1
}' \
  -H "Content-Type: application/json" \
  -X POST \
  'https://api.weixin.qq.com/wxa/game/cancelpay?access_token=62_so84Zyl5MuPCjXGiR3eb1ysa1lr6aRpcprEnNpZ9ds8676ivjqRn5Zroi2Rxxx9-Yvh2zIl9oEt1hIzK0x2OrMCT5zk8nB_TG98obD_ad3tFPftfFmB7xXtcZv4PVPcbFATZT&signature=a5ec09b5677b5004495ac78eecc0aa78a4aa53c1bfa82850e4dcf1650c8a5d69&pay_sig=e654d5725976945f738caf3485c260b129dc586c797d7616ca15176fd31b5e8b&sig_method=hmac_sha256'

# 成功返回

{
  "errcode": 0,
  "errmsg": "ok",
  "bill_no": "test_cancel_pay_1668512806"
}

# 错误返回

{
    "errcode":90018,
    "errmsg":"[openid] openid is invalid"
}