支付系统介绍
1. 什么是Currency & Commerce Service
在梦宝谷开放平台中游戏内是可以销售道具的。这个功能在MobageSDK中由Bank API来提供。合作开发者利用该API可进行销售道具等交易服务。
游戏中所销售的道具列表可以是存放在合作开发者的游戏服务器中,也可以存放在开放平台服务器中。如果存放在游戏服务器中,处理虽说会变得有些复杂,但是数据可以由游戏服务器统一管理。如果存放在开放平台服务器中的话,处理将会相对简单,但是道具的登录管理将会花些时间。物品登录可以在开发者网站的道具管理页面登录。
关于玩家购入道具使用的虚拟货币,在安卓平台上是使用梦宝谷金币(即M币)。在iOS平台上可以使用各游戏独自的虚拟货币,虚拟货币请在开发者网站上登录。
2. 三个交易流程比较
梦宝谷平台提供以下三种交易流程,他们有各自的优缺点和适用的场景,可根据开发者的实际情况进行选择。
| 交易流程名称 | 道具是否需要登记到开发者网站 | 客户端需要调用的方法SDK API | 服务器端需要做的操作(RESTful API) | 优点 | 缺点 | |
|---|---|---|---|---|---|---|
流程一: 通过客户端SDK的交易流程 | √ | Bank.Debit.createTransaction Bank.Debit.openTransaction Bank.Debit.closeTransaction |
|
|
| |
通过服务器RESTful API的交易流程 | 流程二: 物品为交易指定 | X |
Bank.Debit.continueTransaction
|
|
|
|
流程三: 物品登记在开发者网站 | √ | Bank.Debit.createTransaction
|
|
|
| |
如果没有发布到Mobage海外平台的计划,推荐使用流程一:通过客户端SDK的交易流程
3. 流程一:通过客户端SDK的交易流程
在这个交易过程中,客户端通过调用SDK提供的各种API来完成交易,SDK将负责所有与平台通信的过程。
在完成最后closeTransaction后,梦宝谷服务器会调用开发者在开发者平台上填写的URL通知游戏服务器。(仅在大中华区简繁体平台提供)
前提:
大致步骤:
- 客户端调用createTransaction
- 客户端在createTransaction的onSuccess回调里面调用openTransaction
- 在openTransaction的成功之后给用户发放道具
- 客户端在openTransaction的onSuccess回调函数里面调用closeTransaction。
- 梦宝谷回调游戏服务器的一个URL告知交易成功完成,游戏服务器处理该回调请求。
详细步骤如下:
- 用户需要购买时,应用调用createTransaction。(道具请事先注册到开发者平台)
- 梦宝谷将会检查道具信息,生成交易,并将交易状态设置成为new。
- SDK会弹出对话框询问用户是否承认这笔交易。
- 用户点确定后,交易状态会被设置为 authorized
- SDK会告知应用新生成的transaction id。
- 应用使用该transaction id来调用openTransaction。
- 梦宝谷平台将会暂时扣除用户的余额,并将交易状态设置成open。(10分钟内,未调用closeTransaction,交易会被置为cancel,费用会返回到用户账户。)
- SDK会告知应用交易状态已经变成open。
- 游戏应在这一步将道具发送给用户。(通常这一步是游戏服务器完成)
- 然后应用调用closeTransaction来完成交易。
- 梦宝谷服务器将会把用户消费额转移到游戏账户,并将交易状态变更为closed。
- SDK会告知应用交易正常close。
- (可选,如果注册了回调地址则会发生)梦宝谷平台会回调游戏服务器的一个URL告知交易成功完成。

4. 通过服务器RESTful API的交易流程
在下面两个交易过程中,开发者通过调用服务器的RESTfulAPI以及SDK提供的相关API来完成交易。
在成功关闭交易之后,梦宝谷服务器会调用开发者在开发者平台上填写的URL通知游戏服务器。(此步骤可选,仅在大中华区简繁体平台提供)
4.1 流程二:如果道具为各交易(Transaction)所指定
即道具不需要事先登录在梦宝谷开发者平台,而是由每次生成交易时在RESTful的请求里指定。
本流程需要客户端调用SDK相关的API,和游戏服务器调用RESTful相关API来共同完成交易。由于RESTful API需要获取到访问令牌才能访问,所以需要先做Oauth认证。
前提:
大致步骤:
- 客户端发送一个请求给游戏服务器(开发者自定义),以触发游戏服务器调用RESTful API来创建交易。(create transaction)
- 客户端收到从游戏服务器的创建成功的响应,调用continueTransaction方法,等待用户确认。
- 用户确认之后,客户端发送一个带transactionId的请求给游戏服务器(开发者自定义),以触发游戏服务器调用RESTful API来打开交易. (open transaction)
- 游戏给用户发放道具
- 服务器调用RESTful API来关闭交易。(close transaction)
- 如果发生超时的情况,如有必要确认交易状态,游戏服务器可以利用RESTful API向平台发出交易确认要求。(get transaction) (该步骤可选)
详细步骤如下:

生成交易
-
利用XHR从游戏客户端向游戏服务器发出要求让游戏服务器向平台服务器请求生成交易。
-
游戏服务器利用RESTful API向平台要求生成交易。
-
平台生成交易。
-
返回交易情报。
-
将交易情报返回给游戏客户端。
认证交易
-
执行 Bank.Debit.continueTransaction() 。
-
向用户表示道具购入的确认画面。
-
如果用户许可购入,平台将承认该笔交易。
-
返回结果给回调函数。
确定交易
-
利用XHR从游戏客户端向游戏服务器发出要求让游戏服务器向平台服务器请求确认交易。
-
游戏服务器利用RESTful API向平台要求开始交易。
-
平台将指定的交易改变为开始状态。
-
返回结果。
-
游戏服务器上进行物品给予。
-
游戏服务器利用RESTful API向平台要求结束交易。
-
平台将指定的交易改变为结束状态。
-
返回结果。
-
流程17如果发生超时的情况,如有必要确认交易状态,游戏服务器可以利用RESTful API向平台发出交易确认要求。
-
平台确认指定的交易状态。
-
返回结果。
-
游戏客户端可以利用XHR向游戏服务器发出要求以确认物品给予的状况。
-
返回结果。
4.2 流程三:如果道具登录在开放平台中
本流程需要事先注册道具到开发者平台,然后在客户端调用SDK相关的API,在游戏服务器调用RESTful相关API 来共同完成交易。由于RESTful API需要获取到访问令牌才能访问,所以需要先做Oauth认证。
前提:
大致步骤:
- 客户端调用createTransaction
- 客户端在createTransaction的onSuccess回调函数里得到transaction id,发送一个带transactionId的请求给游戏服务器(开发者自定义),以触发游戏服务器调用RESTful API来打开交易. (open transaction)
- 游戏给用户发放道具
- 服务器调用RESTful API来关闭交易。(close transaction)
- 如果发生超时的情况,如有必要确认交易状态,游戏服务器可以利用RESTful API向平台发出交易确认要求。(get transaction) (该步骤可选)
详细步骤如下:

认证交易
-
执行 Bank.Debit.createTransaction() 。
-
向用户表示物品购入的确认画面。
-
如果用户许可购入,平台将承认该笔交易。
-
返回结果给回调函数。
确定交易
-
利用XHR从游戏客户端向游戏服务器发出要求让游戏服务器向平台服务器请求确认交易。
-
游戏服务器利用RESTful API向平台要求开始交易。
-
平台将指定的交易改变为开始状态。
-
返回结果。
-
游戏服务器上进行物品给予。
-
游戏服务器利用RESTful API向平台要求结束交易。
-
平台将指定的交易改变为结束状态。
-
返回结果。
-
流程12如果发生超时的情况,如有必要确认交易状态,游戏服务器可以利用RESTful API向平台发出交易确认要求。
-
平台确认指定的交易状态。
-
返回结果。
-
游戏客户端可以利用XHR向游戏服务器发出要求以确认物品给予的状况。
-
返回结果。
5. 交易的状态
状态变更图

状态列表
New:新建的交易。
Authorized:经由用户确认过的交易;SDK的createTransaction生成的交易状态也是Authorized,原因是该API会弹出确认框,用户确认完后才会继续。
Open:交易变为Open时,梦宝谷开放平台将从用户账号扣款(虚拟货币或梦宝币)。
Closed:已经完成的交易。只有交易为这个状态,开发者账号才能收到相应的资金。
Canceled:取消的交易。如果交易由Open变为Canceled,开放平台会将之前的扣款退回给用户账号。
注:每一个梦宝谷开放平台的交易,生命期只有10分钟;也就是说,新建交易后,如果10分钟之内开发者未将交易的状态设置为"closed"或者"canceled",开放平台会自动取消这个交易(将交易状态置为"canceled")。