支付

抖音小游戏提供虚拟充值的能力，用户可以在游戏内下单，进行游戏内道具的购买。本文主要对游戏内的支付能力进行简单概述说明。

支付方式

在不同的设备环境中，因相关策略限制，SDK实现支付能力的方式有所区别，如下所示：

支付方式	说明
虚拟支付	利用 tt.requestGamePayment() 接口发起抖音虚拟支付，并直接购买游戏内服务或道具，适用于 Android 设备
钻石兑换	利用 tt.openAwemeCustomerService() 接口发起抖音钻石支付，购买抖音钻石；“钻石”是抖音平台向用户提供的，用于在抖音平台上进行相关消费的虚拟道具，用户可以使用钻石兑换游戏中的服务或道具，适用于 iOS 设备；使用钻石兑换能力需要登录《抖音开放平台控制台》进行开通，详情请参考《钻石兑换功能》文档说明

注意事项

接入支付相关能力前，需先完成IM客服能力接入，确保及时处理用户反馈，保证用户体验！关于客服能力的接入说明，详情请查看本文档《打开客服会话》章节！

游戏客户端在接入SDK支付接口时，无需关心用户所处的设备环境，SDK将在内部自行识别并选择相应的支付方式以发起支付。

准备事项

添加安全域名

根据游戏的发行企业或主体，登录《抖音开放平台控制台》 (opens new window)后台，进入“开发 > 开发设置”，在“服务器域名（request 合法域名）”一栏中添加相应的安全域名，详见前文《准备工作 > 添加安全域名》介绍。

开通虚拟支付&钻石兑换

登录《抖音开放平台控制台》 (opens new window)后台，进入“商业化 > 虚拟支付”，申请开通虚拟支付和钻石兑换能力（超级管理员通过顶部提示条开通钻石兑换能力），详情请参考《小游戏支付接入流程》 (opens new window)文档说明，若有其他疑问请咨询SDK开放平台开发人员。

游戏道具价格设置

游戏在设置道具价格时，请务必根据抖音小游戏官方API的限定价格等级 (opens new window)进行设置！

配置支付回调接口

游戏服务器需按照《服务端对接 > 登录支付 > 支付回调》文档要求，向相关运营人员提供支付回调接口，并由运营人员配置至SDK开放平台后台，用于在用户支付成功后通知游戏发放相应购买商品！

接口说明

用于游戏内发起支付，仅在登录成功后可用。

sdkInstance.pay(options);

最低基础库版本要求

• 在Android设备中，若用户客户端基础库版本低于 1.55.0，调用 sdkInstance.pay(options) 接口将中断用户当前操作并弹出升级提示，不会报错！
• 若为iOS设备，则要求用户客户端基础库版本不低于 2.64.0！

参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
options	object	是	--	支付参数
options.areaId	string / number	否	1	游戏大区ID，若游戏无大区概念，可不填，默认值为 1，表示初始大区编号
options.areaName	string	否	1	游戏大区名称，若游戏无大区概念，可不填，默认值为 1
options.roleId	string / number	否	同 accountId	角色ID，若游戏无角色概念，可不填，默认值同 accountId 账号ID
options.roleName	string	否	--	角色昵称
options.roleLevel	number	否	1	角色等级，若游戏无角色及等级概念，可填关卡等级或不填，默认值为 1
options.itemId	string	是	--	商品ID
options.itemName	string	是	--	商品名称
options.itemNum	number	否	1	商品数量，一般固定传 1
options.itemPrice	number	是	--	商品单价，单位为分！！！
options.currency	string	否	CNY	货币类型，默认为 CNY；在iOS设备中，该选项无效，SDK将强制设为 DIAMOND！！！
options.rate	number	是	--	游戏币兑换汇率，用于计算游戏币购买数量；例如：后台配置为 1:10，则 rate 为 10，表示1人民币=10游戏币；可登录《抖音开放平台控制台》后台，进入“商业化 > 虚拟支付 > 支付设置 > 基础信息 > 货币汇率”栏目中查看
options.memo	string	否	--	透传参数，支付完成后，SDK服务器将通过支付回调原样返回给游戏服务器
options.remark	string	否	--	备用透传参数
options.success	function	否	--	接口调用成功的回调函数（注意，该回调函数被触发时，仅表示当前接口调用成功，并非代表用户实际完成了支付流程，支付且发货成功应以游戏服务端下发通知为准）
options.fail	function	否	--	接口调用失败的回调函数
options.complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 在Android设备中，若用户客户端基础库版本低于 1.55.0，调用此接口将中断用户当前操作并弹出升级提示，不会报错！
// 若为iOS设备，则要求用户客户端基础库版本不低于 2.64.0
sdkInstance.pay({
  areaId: 1001,
  areaName: "1区",
  roleId: "123456",
  roleName: "小朋友",
  roleLevel: 1,
  itemId: "com.dh.test",
  itemName: "60钻石",
  itemNum: 1, // 一般固定传1
  itemPrice: 600, // 商品单价单位为分，请注意换算！例如此示例中的600表示600分，即6元
  currency: "CNY",
  rate: 10,
  memo: "123456789123456789", // 透传参数，字符串类型；支付完成后，SDK服务器将通过支付回调原样返回给游戏服务器；这里演示透传游戏业务订单号
  remark: "", // 备用透传参数
  success: function(response) {
    // 该回调函数被触发时，仅表示当前接口调用成功，并非代表用户实际完成了支付流程，支付且发货成功应以游戏服务端下发通知为准
    console.log(response);
  },
  fail: function(error) {
    // 此处返回接口调用失败的错误信息，error.code为cancel时，表示用户主动点击了取消按钮，此时可以不向用户弹出提示
    if (error.code == "cancel") {
      return;
    }

    // 此处可向用户弹出接口返回的错误消息或统一弹出“支付失败”
    sdkInstance.modal.message(error.message);
  },
  complete: function(result) {
    // do something here...
  }
});

支付回调

游戏服务器需按照《服务端对接 > 登录支付 > 支付回调》文档要求，向相关运营人员提供支付回调接口，并由运营人员配置至SDK开放平台后台，用于在用户支付成功后通知游戏发放相应购买商品！

注意事项

若有接口方面疑问，请咨询SDK服务端开发：陈肖军！