Track order status
Notice
The SDK allows you to track the order status on the client side of your application. However, we recommend setting up a Payment webhook handler to receive order information in the back end of your application. This allows you to implement additional validation of completed purchases.
After a user makes a purchase, your application can perform the following actions:
- show the order status in the application UI
- credit a user’s balance after a successful payment
- grant the purchased items after a successful payment
Order tracking logic is included in the following SDK methods:
Cart.Purchase— used to buy a cartCart.PurchaseFreeCart— used to purchase free items via cartCatalog.Purchase— used to purchase items in one clickCatalog.PurchaseForVirtualCurrency— used to purchase items for virtual currencyCatalog.PurchaseFreeItem— used to purchase free items in one click
To handle a successful purchase, you only need to pass a function that is called when the order transitions to the done status in the onSuccess parameter.
Purchase methods encapsulate several methods for tracking the order status. The mechanism differs depending on the platform for which the application is built:
- For WebGL builds, tracking is based on the
postMessageevents of the payment interface widget. If the Pay Station widget sends a message that the order status changed todoneorcancel, tracking stops.
- For builds for other platforms, tracking uses simple HTTP requests (short-polling) and WebSocket requests. Tracking is performed according to the following algorithm:
- A web socket connection is established.
- If the order status does not change to
doneorcancelwithin 5 minutes, the web socket connection is closed. If the order status changes todoneorcancel, tracking stops. - Order status tracking continues with short-polling. A simple HTTP order status request is sent once every 3 seconds. Tracking stops if:
- order status changes to
doneorcancel - the order status does not
doneorcancelwithin 10 minutes
- order status changes to
Note
If a web socket connection fails, the order status is tracked using short-polling.
You can also implement processing an order content data that is passed to the onSuccess callback function of the purchase methods.
Was this article helpful?
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.Rate this page
Rate this page
Don’t want to answer
Thank you for your feedback!
Useful links
Last updated:
October 24, 2023
Found a typo or other text error? Select the text and press Ctrl+Enter.
