com.ingenico.sdk.transaction

Class Transaction

java.lang.Object

com.ingenico.sdk.ServiceConnector

com.ingenico.sdk.transaction.Transaction

All Implemented Interfaces:

IIngenicoApi, ITransaction

public final class Transaction
extends ServiceConnector
implements ITransaction

Transaction Service

Nested Class Summary

Nested classes/interfaces inherited from class com.ingenico.sdk.ServiceConnector

ServiceConnector.InternalServiceConnection

Field Summary

Fields inherited from class com.ingenico.sdk.ServiceConnector

ACTION_BIND_V2, SERVICES_PACKAGE

Method Summary

Modifier and Type	Method and Description
boolean	abortOngoingTransaction() Abort the started transaction in case of any event happening at the cash register after a start has been triggered but before the payment mean is detected.
java.util.List<Currency>	getAvailableCurrencies() Get the list of any available currencies supported by the Point Of Sale (POS) or payment terminal.
java.util.List<java.lang.Integer>	getAvailablePaymentMeans() Get the list of any available payment means supported by the POS such as swipe, smart card, contactless, QR Code...
java.util.List<TransactionType>	getAvailableTransactionTypeList() Get the list of any available transaction types supported by the POS.
java.util.List<java.lang.Integer>	getAvailableTransactionTypes() Get the list of any available transaction types supported by the POS.
static ITransaction	getInstance(android.content.Context context) Return a global instance of Transaction, which is the default implementation of ITransaction, and instantiate it if needed.
protected java.lang.String	getServiceName() Must be overrided to provide service class name used for binding.
protected void	onServiceReady(android.os.IBinder service) Internal callback when service is connected.
protected void	onServiceUnbinded() Internal callback when service is disconnected.
TransactionResult	recover(RecoveryInputData inputData) Start a transaction recovering to the parameter filled in recoverId field.
void	registerTransactionDoneListener(ITransactionDoneListener listener) Register a new listener for TransationDone event sent within a transaction result.
TransactionRequest	start(TransactionInputData inputData) Start a transaction according to the parameters filled in inputData field.
void	unregisterTransactionDoneListener(ITransactionDoneListener listener) Unregister an existing transaction listener.

Methods inherited from class com.ingenico.sdk.ServiceConnector

connect, connectSync, disconnect, ensureServiceIsReady, getBindIntent, getContext, isConnected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ingenico.sdk.IIngenicoApi

connect, disconnect, isConnected

Method Detail

getInstance

public static ITransaction getInstance(android.content.Context context)

Return a global instance of Transaction, which is the default implementation of ITransaction, and instantiate it if needed.

Be aware that only one instance will be created for the whole application, so the associated context should not be a component which could be destroyed at some point, ie. an Activity. Passing the Application to this method is preferred over other context types.

Parameters:

context - A valid context to initialize the instance.

Returns:

getAvailableCurrencies

public java.util.List<Currency> getAvailableCurrencies()
                                                throws IngenicoException

Get the list of any available currencies supported by the Point Of Sale (POS) or payment terminal.

Usage example:

ITransaction transaction = Transaction.getInstance(context);
// Get the available currencies
List<Currency> currencies = transaction.getAvailableCurrencies();
// Check that EUR is available
boolean euroIsAvailable = false;
for (Currency currency : currencies) {
    if (currency.getNumericCode() == 978L) {
        euroIsAvailable = true;
        break;
    }
}
if (euroIsAvailable) {
    // Do things with euro
}

Specified by:

getAvailableCurrencies in interface ITransaction

Returns:

currencies

Throws:

IngenicoException

getAvailableTransactionTypes

public java.util.List<java.lang.Integer> getAvailableTransactionTypes()
                                                               throws IngenicoException

Get the list of any available transaction types supported by the POS.

Usage example:

ITransaction transaction = Transaction.getInstance(context);
// Get the available transaction types
List<Integer> transactionTypes = transaction.getAvailableTransactionTypes();
// Check that SALE is available
boolean saleIsAvailable = false;
for (Integer transactionType : transactionTypes) {
    if (transactionType == TransactionTypes.SALE) {
        saleIsAvailable = true;
        break;
    }
}
if (saleIsAvailable) {
    // Ok, we can proceed with a transaction sale
}

Specified by:

getAvailableTransactionTypes in interface ITransaction

Returns:

transaction types

Throws:

IngenicoException

See Also:

TransactionTypes for predefined values

getAvailableTransactionTypeList

public java.util.List<TransactionType> getAvailableTransactionTypeList()
                                                                throws IngenicoException

Get the list of any available transaction types supported by the POS.

Usage example:

ITransaction transaction = Transaction.getInstance(context);
// Get the available transaction types
List<TransactionType> transactionTypes = transaction.getAvailableTransactionTypeList();
// Check that SALE is available
boolean saleIsAvailable = false;
for (TransactionType transactionType : transactionTypes) {
    if (transactionType.getValue() == TransactionTypes.SALE
            && transactionType.getLabel().equals("Sale")) {
        saleIsAvailable = true;
        break;
    }
}
if (saleIsAvailable) {
    // Ok, we can proceed with a transaction sale
}

Specified by:

getAvailableTransactionTypeList in interface ITransaction

Returns:

transaction types

Throws:

IngenicoException

getAvailablePaymentMeans

public java.util.List<java.lang.Integer> getAvailablePaymentMeans()
                                                           throws IngenicoException

Get the list of any available payment means supported by the POS such as swipe, smart card, contactless, QR Code...

Usage example:

ITransaction transaction = Transaction.getInstance(context);
// Get the available payment means
List<Integer> paymentMeans = transaction.getAvailablePaymentMeans();
// Check that CONTACT_CHIP is available
boolean contactChipIsAvailable = false;
for (Integer mean : paymentMeans) {
    if (mean == PaymentMeans.CONTACT_CHIP) {
        contactChipIsAvailable = true;
        break;
    }
}
if (contactChipIsAvailable) {
    // ok, we can process transactions with contact chip
}

Specified by:

getAvailablePaymentMeans in interface ITransaction

Returns:

payment means

Throws:

IngenicoException

See Also:

PaymentMeans for predefined values

abortOngoingTransaction

public boolean abortOngoingTransaction()
                                throws IngenicoException

Abort the started transaction in case of any event happening at the cash register after a start has been triggered but before the payment mean is detected.

Usage example:

if (!transaction.abortOngoingTransaction()) {
    // Could not abort the ongoing transaction
} else {
    // Transaction aborted, the transaction done event status will state that the
    // transaction was aborted
}

Specified by:

abortOngoingTransaction in interface ITransaction

Returns:

true : the abort request has been correctly sent, should wait for the DoneEvent, false : could not request abort

Throws:

IngenicoException

start

public TransactionRequest start(TransactionInputData inputData)
                         throws IngenicoException

Start a transaction according to the parameters filled in inputData field.

Specified by:

start in interface ITransaction

Parameters:

inputData - transaction parameters

Throws:

IngenicoException

recover

public TransactionResult recover(RecoveryInputData inputData)
                          throws IngenicoException

Start a transaction recovering to the parameter filled in recoverId field.

Specified by:

recover in interface ITransaction

Parameters:

inputData - transaction recovering parameters

Throws:

IngenicoException

registerTransactionDoneListener

public void registerTransactionDoneListener(ITransactionDoneListener listener)

Description copied from interface: ITransaction

Register a new listener for TransationDone event sent within a transaction result.

Specified by:

registerTransactionDoneListener in interface ITransaction

unregisterTransactionDoneListener

public void unregisterTransactionDoneListener(ITransactionDoneListener listener)

Description copied from interface: ITransaction

Unregister an existing transaction listener.

Specified by:

unregisterTransactionDoneListener in interface ITransaction

getServiceName

protected java.lang.String getServiceName()

Description copied from class: ServiceConnector

Must be overrided to provide service class name used for binding.

Specified by:

getServiceName in class ServiceConnector

Returns:

onServiceReady

protected void onServiceReady(android.os.IBinder service)

Description copied from class: ServiceConnector

Internal callback when service is connected. This is where we should retrieve the aidl interface.

Specified by:

onServiceReady in class ServiceConnector

onServiceUnbinded

protected void onServiceUnbinded()

Description copied from class: ServiceConnector

Internal callback when service is disconnected.

Specified by:

onServiceUnbinded in class ServiceConnector