Documentation

Namespace: redeemApi

Playbasis. redeemApi

Playbasis Redeem API

Methods

<static> redeem(goodsId, playerId, options)

Redeem goods for player.

Parameters:
Name Type Description
goodsId String

goods id
playerId String

player id
options Object

(optional) options as object.
It can include
{
amount: Number = amount of goods to give to player
}
Returns:

Promise object

Type
Object

<static> redeemGoodsGroup(playerId, group, options)

Redeem Goods from given group.

Parameters:
Name Type Description
playerId String

player id
group String

goods group
options Object

(optional) options as object.
It can include
{
amount: Number = amount of goods to give to player
}
Returns:

Promise object

Type
Object

<static> redeemSponsor(goodsId, playerId, options)

Redeem sponsored Goods for player.

Parameters:
Name Type Description
goodsId String

goods id
playerId String

player id
options Object

(optional) options as object.
It can include
{
amount: Number = amount of goods to give to player
}
Returns:

Promise object

Type
Object

<static> redeemSponsoredGoodsGroup(playerId, group, options)

Redeem sponsored goods given goods group.

Parameters:
Name Type Description
playerId String

player id
group String

goods group
options Object

(optional) options as object.
It can include
{
amount: Number = amount of goods to give to player
}
Returns:

Promise object

Type
Object

<static> redeemVerify(goodsGroup, couponCode, pinCode)

Redeem verification for merchant using PIN code.

Parameters:
Name Type Description
goodsGroup String

goods group
couponCode String

coupon code
pinCode String

pin code
Returns:

Promise object

Type
Object