Namespace: merchantApi

Playbasis. merchantApi

Playbasis Merchant API

Methods


<static> availableBranchForGoodsGroup(goodsGroup)

Return list of available branch of goods group.

Parameters:
Name Type Description
goodsGroup String

name of goods group

Returns:

Promise object

Type
Object

<static> redeemCoupon(goodsGroup, couponCode, options)

Merchant redeems couple from player.

Parameters:
Name Type Description
goodsGroup String

goods group name.

couponCode String

coupon code of goods to redeem

options Object

(optional) options as object.
It can include.
{
pin_code: String = merchant PIN code generated from admin dashboard
player_id: String = player id
}

Returns:

Promise object

Type
Object

<static> redeemGoods(goodsName, playerId, options)

Merchant redeems normal goods from player

Parameters:
Name Type Description
goodsName String

goods name

playerId String

player id

options Object

options as object. It can include
amount: Number = amount of goods to redeem from player (default = 1)

Returns:

Promise object

Type
Object

<static> verifyCoupon(goodsGroup, couponCode, options)

Verify coupon code available to be redeemed.

Parameters:
Name Type Description
goodsGroup String

goods group name

couponCode String

coupon code of goods to verify

options Object

(optional) options as object.
It can include
{
pin_code: String = merchant PIN code generated from admin dashboard
player_id: String = player id
}

Returns:

Promise object

Type
Object