POS SDK Method Details

Following are the available APIs with requests and response params. To access the respective params, click on + button.

Usecase

Start a new Sale transaction on the connected EDC device. If the EDC device is not connected a Timeout error will be thrown. If the request parameters are valid and the device is not busy with another transaction then a SALE transaction will be initiated on the device.

/**
 * @param request      	Sale Request

 * @param responseListener A listener which will listen for the response

 * @see Config#isStatusCheckOnSaleRequestEnabled()

 * @see Config#getStatusCheckStartSeconds()

 * @see Config#getStatusCheckIntervalSeconds()

 * @see Config#getSaleRequestTimeoutSeconds()

 * If the statusCheckOnSaleRequestEnabled flag is true then the sdk will keep checking the

 * status of the SALE transaction at regular interval(statusCheckIntervalSeconds) after initial

 * delay of statusCheckStartSeconds and till saleRequestTimeoutSeconds. And in this case the

 * response returned will be of the type

 * {@link com.paytm.ecr.bluetooth.sdk.model.response.StatusCheckResponse}

 * <p>

 * If the statusCheckOnSaleRequestEnabled is false, then sdk will immediately return

 * the response of the type {@link com.paytm.ecr.bluetooth.sdk.model.response.SaleResponse} ,

 * this response will only give information whether the SALE transaction was initiated on the

 * device or not. And in this case the calling app needs to call the

 * @see #doStatusCheck(Request, ResponseListener) API to know the final status of the SALE

 * transaction on the device

 * <p>

 * If the device does not initiate the SALE transaction due to any reason, then the response

 * of the type {@link com.paytm.ecr.bluetooth.sdk.model.response.SaleResponse} will immediately

 * be returned to the calling App

 * @see SaleRequest

 * @see com.paytm.ecr.bluetooth.sdk.model.response.SaleResponse

 * @see com.paytm.ecr.bluetooth.sdk.model.response.StatusCheckResponse

 */

@Keep

void doSale(@NonNull Request<SaleRequest> request, @NonNull ResponseListener responseListener);


*****************************************************************************************

Usecase

Check the status of a particular transaction on the Paytm POS machine. 

 Note- The Paytm POS machine stores only the transactions done on the current day, the status of older transactions cannot be checked through this API.

/**

 * @param request      	Status check request

 * @param responseListener A listener which will listen for the response

 * @see StatusCheckRequest

 * @see com.paytm.ecr.bluetooth.sdk.model.response.StatusCheckResponse

 */

@Keep

void doStatusCheck(@NonNull Request<StatusCheckRequest> request, @NonNull ResponseListener responseListener);


*****************************************************************************************

Usecase

Cancels the currently ongoing SALE or VOID transaction initiated by the Merchant Billing System on the Paytm POS machine

/**

 * @param request      	Cancel request

 * @param responseListener A listener which will listen for the response

 * @see CancelRequest

 * @see com.paytm.ecr.bluetooth.sdk.model.response.CancelResponse

 */

@Keep

void doCancel(@NonNull Request<CancelRequest> request, @NonNull ResponseListener responseListener);


*****************************************************************************************

Usecase

Generate receipt for a SALE / VOID transaction through the Paytm POS machine

 Note: The Paytm POS machines store the transactions done on the current day, therefore receipt of older transactions could not be printed through this API

/**
 *

 * @param request      	Print request

 * @param responseListener A listener which will listen for the response

 * @see PrintRequest

 * @see com.paytm.ecr.bluetooth.sdk.model.response.PrintResponse

 */

@Keep

void doPrint(@NonNull Request<PrintRequest> request, @NonNull ResponseListener responseListener);

*****************************************************************************************

Usecase

Initiate VOID for a successful SALE transaction.

 Note: The Paytm POS machines store only the transactions done on the current day, therefore VOID of older transactions could not be initiated through this API

/**

 * @param request      	Void request

 * @param responseListener A listener which will listen for the response

 * @see VoidRequest

 * @see com.paytm.ecr.bluetooth.sdk.model.response.VoidResponse

 */

@Keep

void doVoid(@NonNull Request<VoidRequest> request, @NonNull ResponseListener responseListener);

*****************************************************************************************

Usecase

Check if the Merchant Billing System and Paytm POS machine are ready to communicate over Bluetooth. If this method returns timeout or any other error, then it may mean that the Merchant Billing System is connected to any other Bluetooth device and not the Paytm POS machine. 

/**

 * @param request      	Connection Check request

 * @param responseListener A listener which will listen for the response

 * @see ConnectionCheckRequest

 * @see com.paytm.ecr.bluetooth.sdk.model.response.ConnectionCheckResponse

 */

@Keep

void doConnectionCheck(@NonNull Request<ConnectionCheckRequest> request, @NonNull ResponseListener responseListener);

*****************************************************************************************

Merchant needs to add the below code of Constant and LifeCycleTracker on their application server.

package com.paytm.ecr.bluetooth.sample;

public interface Constants {
    String TXN_TYPE = "txn_type";
    String SALE = "sale";
    String CANCEL = "cancel";
    String STATUS_CHECK = "status_check";
    String CONNECTION_CHECK = "connection_check";
    String VOID = "void";
    String PRINT = "print";
}

package com.paytm.ecr.bluetooth.sample;

import android.app.Activity;
import android.app.Application;
import android.os.Bundle;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

/**
 * This Class can be used for managing connection lifecycle aware.
 * This enables the application to open and close connection,
 * as the application comes to foreground and goes in background respectively
 *
 * @see SampleApp
 * @see com.paytm.ecr.bluetooth.sample.ui.BaseActivity
 */
public class LifeCycleTracker implements Application.ActivityLifecycleCallbacks {

    private int activityCount = 0;

    private boolean appStopped = true;

    private LifeCycleListener lifeCycleListener = null;


    @Override
    public void onActivityCreated(@NonNull Activity activity, @Nullable Bundle savedInstanceState) {

    }

    @Override
    public void onActivityStarted(@NonNull Activity activity) {
        activityCount += 1;
        if (activityCount == 1) {
            if (appStopped) {
                if (lifeCycleListener != null) {
                    lifeCycleListener.comingToForeGround(true);
                }
                appStopped = false;
            } else {
                if (lifeCycleListener != null) {
                    lifeCycleListener.comingToForeGround(false);
                }
            }
        }
    }

    @Override
    public void onActivityResumed(@NonNull Activity activity) {

    }

    @Override
    public void onActivityPaused(@NonNull Activity activity) {

    }

    @Override
    public void onActivityStopped(@NonNull Activity activity) {
        activityCount -= 1;
        if (activityCount == 0) {
            appStopped = activity.isFinishing();
            if (lifeCycleListener != null) {
                lifeCycleListener.goingToBackground(appStopped);
            }
        }
    }

    @Override
    public void onActivitySaveInstanceState(@NonNull Activity activity, @NonNull Bundle outState) {

    }

    @Override
    public void onActivityDestroyed(@NonNull Activity activity) {

    }

    public boolean isAppInForeground() {
        return activityCount > 0;
    }

    public void setLifeCycleListener(LifeCycleListener lifeCycleListener) {
        this.lifeCycleListener = lifeCycleListener;
    }

    public interface LifeCycleListener {

        void goingToBackground(boolean isAppFinishing);

        void comingToForeGround(boolean isAppStarting);
    }
}