Beamable.Api.Payments.PaymentService Class Reference

This class defines the main entry point for the Payment feature. More...

Public Member Functions
	PaymentService (PlatformService platform, PlatformRequester requester)
Promise< EmptyResponse >	Track (TrackPurchaseRequest trackPurchaseRequest)
	Handles starting the coroutine to track a purchase request client-authoritatively Note: This is disabled by default, and requires the developer to enable it via the Portal. More...
Promise< PurchaseResponse >	BeginPurchase (string purchaseId)
	Handles starting the coroutine to make the begin purchase request. More...
Promise< EmptyResponse >	CompletePurchase (CompletedTransaction transaction)
	This request is made after the provider has charged the player. It is used to verify the legitimacy of the purchase by verifying the receipt as well as completing the item fulfillment process. More...
Promise< EmptyResponse >	CancelPurchase (long txid)
	Handles starting the coroutine to make the cancel purchase request. More...
Promise< EmptyResponse >	FailPurchase (long txid, string reason)
	Handles starting the coroutine to make the fail purchase request. More...
Promise< PurchaseResponse >	RedeemCoupon (string purchaseId)
	Attempts to consume a coupon to redeem an offer More...
Promise< GetSKUsResponse >	GetSKUs ()
	Get commerce SKUs from platform More...
Promise< GetOffersResponse >	GetOffers (string[] stores=null)
	Get catalog from platform More...
Promise< CouponsCountResponse >	GetCouponsCount ()
	Get the count of coupons More...
void	RefreshCoupons ()
void	SubscribeCoupons (Action< int > callback)

Detailed Description

This class defines the main entry point for the Payment feature.

Related Links

• See the Store feature documentation
• See Beamable.API script reference

Member Function Documentation

BeginPurchase()

Promise<PurchaseResponse> Beamable.Api.Payments.PaymentService.BeginPurchase ( string  purchaseId )

inline

Handles starting the coroutine to make the begin purchase request.

Parameters

purchaseId

The id of the item the player wishes to purchase.

CancelPurchase()

Promise<EmptyResponse> Beamable.Api.Payments.PaymentService.CancelPurchase ( long  txid )

inline

Handles starting the coroutine to make the cancel purchase request.

Parameters

txid	The id of the transaction the player wishes to cancel.

CompletePurchase()

Promise<EmptyResponse> Beamable.Api.Payments.PaymentService.CompletePurchase ( CompletedTransaction  transaction )

inline

This request is made after the provider has charged the player. It is used to verify the legitimacy of the purchase by verifying the receipt as well as completing the item fulfillment process.

Parameters

transaction

The completed transaction.

FailPurchase()

Promise<EmptyResponse> Beamable.Api.Payments.PaymentService.FailPurchase ( long  txid, string  reason  )

inline

Handles starting the coroutine to make the fail purchase request.

Parameters

txid	The id of the transaction the player wishes to mark failed.
reason	The reason the transaction failed

GetCouponsCount()

Promise<CouponsCountResponse> Beamable.Api.Payments.PaymentService.GetCouponsCount ( )

inline

Get the count of coupons

GetOffers()

Promise<GetOffersResponse> Beamable.Api.Payments.PaymentService.GetOffers ( string[]  stores = null )

inline

Get catalog from platform

GetSKUs()

Promise<GetSKUsResponse> Beamable.Api.Payments.PaymentService.GetSKUs ( )

inline

Get commerce SKUs from platform

RedeemCoupon()

Promise<PurchaseResponse> Beamable.Api.Payments.PaymentService.RedeemCoupon ( string  purchaseId )

inline

Attempts to consume a coupon to redeem an offer

Parameters

purchaseId

The id of the item the player wishes to purchase.

Track()

Promise<EmptyResponse> Beamable.Api.Payments.PaymentService.Track ( TrackPurchaseRequest  trackPurchaseRequest )

inline

Handles starting the coroutine to track a purchase request client-authoritatively Note: This is disabled by default, and requires the developer to enable it via the Portal.

Parameters

trackPurchaseRequest

The request structure for tracking the purchase.

---

The documentation for this class was generated from the following file:

• client/Packages/com.beamable/Runtime/Core/Platform/SDK/Payments/PaymentService.cs