com.ingenico.sdk.transaction

Interface ITransaction

All Superinterfaces:

IIngenicoApi

All Known Implementing Classes:

Transaction

public interface ITransaction
extends IIngenicoApi

Transaction Service Interface.

Usage example for a simple payment:

ITransaction transaction = Transaction.getInstance(context);

// First register to transactionDone to show up transaction result
transaction.registerTransactionDoneListener(transactionListener);

// Prepare transaction input data
TransactionInputData inputData = TransactionInputData.builder()
        .setTransactionType(TransactionTypes.SALE)
        .setAmount(new BigDecimal("10.00"))
        .setCurrency(978L) // 978: "EUR"
        .addPaymentMean(PaymentMeans.CONTACT_CHIP)
        .setTipAmount(new BigDecimal("1.00"))
        .setSurchargeAmount(new BigDecimal("0.45"))
        .build();

// Start the transaction
TransactionRequest request = transaction.start(inputData);

// Check if request has been accepted
if (request.isRequestAccepted()) {
    // Ok, the transaction is being processed
}

Usage example for a void request:

ITransaction transaction = Transaction.getInstance(context);

// First register to transactionDone to show up transaction result
transaction.registerTransactionDoneListener(transactionListener);

// Prepare transaction input data
TransactionInputData inputData = TransactionInputData.builder()
        .setTransactionType(TransactionTypes.VOID)
        .setAmount(new BigDecimal("10.00"))
        .setCurrency(978L) // 978: "EUR"
        .addPaymentMean(PaymentMeans.CONTACT_CHIP)
        .setTransactionId("ABCD-123")
        .setTipAmount(new BigDecimal("1.00"))
        .setSurchargeAmount(new BigDecimal("0.45"))
        .build();

// Start the transaction
TransactionRequest request = transaction.start(inputData);

// Check if request has been accepted
if (request.isRequestAccepted()) {
    // Ok, the void transaction is being processed
}

Usage example for a refund request:

ITransaction transaction = Transaction.getInstance(context);

// First register to transactionDone to show up transaction result
transaction.registerTransactionDoneListener(transactionListener);

// Prepare transaction input data
TransactionInputData inputData = TransactionInputData.builder()
        .setTransactionType(TransactionTypes.REFUND)
        .setAmount(new BigDecimal("10.00"))
        .setCurrency(978L) // 978: "EUR"
        .addPaymentMean(PaymentMeans.CONTACT_CHIP)
        .setTransactionId("ABCD-123")
        .setStan("123-456-789")
        .build();

// Start the transaction
TransactionRequest request = transaction.start(inputData);

// Check if request has been accepted
if (request.isRequestAccepted()) {
    // Ok, the void transaction is being processed
}

Usage example for a cash back amount request:

ITransaction transaction = Transaction.getInstance(context);

// First register to transactionDone to show up transaction result
transaction.registerTransactionDoneListener(transactionListener);

// Prepare transaction input data
TransactionInputData inputData = TransactionInputData.builder()
        .setTransactionType(TransactionTypes.PAYMENT_WITH_CASH_OUT)
        .setAmount(new BigDecimal("10.00"))
        .setCurrency(978L) // 978: "EUR"
        .addPaymentMean(PaymentMeans.CONTACT_CHIP)
        .setCashAmount(new BigDecimal("5.00"))
        .build();

// Start the transaction
TransactionRequest request = transaction.start(inputData);

// Check if request has been accepted
if (request.isRequestAccepted()) {
    // Ok, the void transaction is being processed
}

Usage example for a recover transaction request:

ITransaction transaction = Transaction.getInstance(context);

// First register to transactionDone to show up transaction result
transaction.registerTransactionDoneListener(transactionListener);

// Prepare start transaction input data
TransactionInputData inputData = TransactionInputData.builder()
        .setTransactionType(TransactionTypes.REFUND)
        .setAmount(new BigDecimal("10.00"))
        .setCurrency(978L) // 978: "EUR"
        .addPaymentMean(PaymentMeans.CONTACT_CHIP)
        .setTransactionId("ABCD-123")
        .setStan("123-456-789")
        .build();

// Start the transaction
TransactionRequest request = transaction.start(inputData);

// Check if request has been accepted
if (request.isRequestAccepted()) {
    // Ok, the void transaction is being processed
}

// Prepare recover transaction input data
RecoveryInputData recoverData = RecoveryInputData.create(request.getRecoveryId());

// Recover the transaction
TransactionResult result = transaction.recover(recoverData);

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() Deprecated. since 2.15.0, use ITransaction.getAvailableTransactionTypeList().
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 interface com.ingenico.sdk.IIngenicoApi

connect, disconnect, isConnected

Method Detail

start

TransactionRequest start(TransactionInputData inputData)
                  throws IngenicoException

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

Parameters:

inputData - transaction parameters

Throws:

java.io.IOException - when the start transaction call fails

IngenicoException

recover

TransactionResult recover(RecoveryInputData inputData)
                   throws IngenicoException

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

Parameters:

inputData - transaction recovering parameters

Throws:

java.io.IOException - when the recover transaction call fails

IngenicoException

Since:

2.8.0

getAvailableCurrencies

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
}

Returns:

currencies

Throws:

java.io.IOException - when could not retrieve the currencies

IngenicoException

getAvailableTransactionTypes

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

Deprecated. since 2.15.0, use ITransaction.getAvailableTransactionTypeList().

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
}

Returns:

transaction types

Throws:

java.io.IOException - when could not retrieve the transaction types

IngenicoException

See Also:

TransactionTypes for predefined values

getAvailableTransactionTypeList

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
}

Returns:

transaction types

Throws:

java.io.IOException - when could not retrieve the transaction types

IngenicoException

Since:

2.15.0

getAvailablePaymentMeans

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
}

Returns:

payment means

Throws:

java.io.IOException - when could not retrieve the data

IngenicoException

See Also:

PaymentMeans for predefined values

abortOngoingTransaction

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
}

Returns:

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

Throws:

java.io.IOException - when the abort call fails

IngenicoException

registerTransactionDoneListener

void registerTransactionDoneListener(ITransactionDoneListener listener)

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

Parameters:

listener -

unregisterTransactionDoneListener

void unregisterTransactionDoneListener(ITransactionDoneListener listener)

Unregister an existing transaction listener.

Parameters:

listener -