Track order status
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
To implement the logic of these actions, track the order status using the OrderTracker.checkPendingOrder
SDK method. Pass the following parameters to the method:
accessToken
— user authorization tokenorderId
— order ID received from the purchase via the shopping cart, one-click purchase, or purchase for virtual currencyonSuccess
— callback in case the order transitions to thedone
statusonError
— callback in case Xsolla server returns an error
This method encapsulates several methods for tracking the order status. Tracking is performed according to the following algorithm:
- A web socket connection is established.
- If the order status hasn’t changed to
done
orcancel
within 5 minutes, the web socket connection is re-established. If the order status is changed todone
orcancel
, tracking stops.
Note
If a web socket connection fails, the order status is tracked using short-polling. Once every 3 seconds, a simple HTTP order status request is sent. Tracking stops if:
- order status changed to
done
orcancel
- the order status does not change to
done
orcancel
within 10 minutes
You can also implement:
- requesting the order status and order contents using the
XsollaOrders.checkOrder
SDK method - webhook handling on the server side of your application for Xsolla transaction events
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: June 30, 2023Found a typo or other text error? Select the text and press Ctrl+Enter.