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

When using the SDK to implement the logic of these actions, you can track the order status in the following ways:

• subscribe to order status changes (recommended)
• request order status

Subscribe to order status changes

Use Store library method

To subscribe to order status changes, use the getOrderStatus SDK method from the Store library and pass the following parameters to the method:

• listener — listener object of type OrderStatusListener.
• orderId — order ID received from the purchase via the shopping cart, one-click purchase, or purchase for virtual currency as the parameter.

SDK reference documentation

Learn more about SDK methods and its parameters.

Example of calling the XStore.getOrderStatus method:

XStore.getOrderStatus(object : OrderStatusListener() {

               override fun  onStatusUpdate(status: OrderResponse.Status) {

                   if(status == OrderResponse.Status.DONE) {

                       Log.d("MainActivity", "Success")

                   }

               }

               override fun  onFailure() {

                   Log.d("MainActivity", "Failure")

               }

           }, orderId)

We recommend to call XStore.getOrderStatus method when opening payment UI.

Purchase methods encapsulate several methods for tracking the order status. Tracking is performed according to the following algorithm:

1. A web socket connection is established.
2. If the web socket connection is established successfully and order status changes to done or cancel, tracking stops. If a web socket connection fails or the response contains incorrect data, the order status is tracked using short-polling.
3. 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 done or cancel.

Use Payments library method

1. When creating the XPayments.IntentBuilder object, pass the StatusReceivedCallback callback using the setStatusReceivedCallback method.
2. Implement the onSuccess method in the StatusReceivedCallback callback, which is called with every unique status change.

Example:

val intent = XPayments.createIntentBuilder(this)
               .accessToken(<accessToken>)
               .isSandbox(<isSandbox>)
           	.setStatusReceivedCallback(object : StatusReceivedCallback {
               	override fun onSuccess(data: InvoicesDataResponse) {
                   		Log.d(TAG, "StatusReceivedCallback is fired. Result data = $data")
               	}
           	})
           	.build()

Request order status

To request the current status of the payment, call the getOrder method from the Store library, passing the following parameters to it:

• orderId — the order ID, which was received from the purchase via the shopping cart, one-click purchase, or purchase for virtual currency.
• callback — the callback for successfully retrieving order information. When implementing a callback, use the GetStatusCallback interface, and implement the onSuccess and onError methods.

Example:

XPayments.getStatus(<token>, <isSandbox>, object : GetStatusCallback {
            override fun onSuccess(data: InvoicesDataResponse?) {
                Log.d(TAG, "onSuccess is fired. Result data = $data")
            }

           override fun onError(throwable: Throwable?, errorMessage: String?) {
                Log.d(TAG, "onError is fired. ErrorMessage = $errorMessage")
            }

})

Useful links