com.yello.api.payment.emv

Interface TransactionStatus

All Known Subinterfaces:

TransactionRecord

public interface TransactionStatus

The Transaction Status Interface

The TransactionStatus interface represents the outcome of an EMV transaction, following a call to the method Transaction.startTransaction(com.yello.api.payment.emv.TransactionType, java.math.BigDecimal, java.math.BigDecimal) or the method Transaction.startTransaction(com.yello.api.payment.emv.TransactionConfiguration, com.yello.api.payment.emv.TransactionType, java.math.BigDecimal, java.math.BigDecimal) of the Transaction singleton class.

For more information about starting an EMV transaction see the Transaction singleton class.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Gets the amount of the transaction
java.math.BigDecimal	getCashBackAmount() Gets the cash-back amount for the transaction If transaction is a purchase transaction with cashback option (identified by TransactionType.CASHBACK)
java.lang.String	getCurrencyAlphabeticCode() Gets the Currency Alphabetic Code as defined by ISO 4217
java.util.Map<java.lang.String,java.lang.String>	getGatewayData() Get the custom data sent back by the gateway
TransactionReceipt[]	getReceipt() Returns a list of TransactionReceipt representing the receipt in Json Format Two receipts are available MERCHANT and CARDHOLDER receipts
java.util.Date	getTransactionDateTime() Gets the date and time of the transaction
java.lang.String	getTransactionID() Gets the transaction identifier
TransactionResult	getTransactionResult() Gets the TransactionResult of the EMV transaction.
TransactionState	getTransactionState() Gets the TransactionState of the EMV transaction.
TransactionType	getTransactionType() Gets the type for the transaction characterized by TransactionType
boolean	isEMVConfigAvailable() Indicates if gateway has indicated that there are new EMV configs available during the transaction
boolean	isOnlineAuthorized() Checks if the EMV transaction is an online authorized transaction
boolean	isReceiptAvailable() Indicates if a receipt is available following the completion of the EMV transaction.

Method Detail

getTransactionID

java.lang.String getTransactionID()

Gets the transaction identifier

Returns:

an String representing the transaction identifier

getTransactionDateTime

java.util.Date getTransactionDateTime()

Gets the date and time of the transaction

Returns:

transaction date

getTransactionResult

TransactionResult getTransactionResult()

Gets the TransactionResult of the EMV transaction.

Returns:

TransactionResult

getTransactionState

TransactionState getTransactionState()

Gets the TransactionState of the EMV transaction.

Returns:

TransactionState

getTransactionType

TransactionType getTransactionType()

Gets the type for the transaction characterized by TransactionType

Returns:

the transaction type defined by TransactionType

getAmount

java.math.BigDecimal getAmount()

Gets the amount of the transaction

Returns:

BigDecimal representing the amount for the transaction

getCashBackAmount

java.math.BigDecimal getCashBackAmount()

Gets the cash-back amount for the transaction
If transaction is a purchase transaction with cashback option (identified by TransactionType.CASHBACK)

Returns:

BigDecimal representing the cashback amount

getCurrencyAlphabeticCode

java.lang.String getCurrencyAlphabeticCode()

Gets the Currency Alphabetic Code as defined by ISO 4217

Returns:

String representing the Currency Alphabetic Code

isOnlineAuthorized

boolean isOnlineAuthorized()

Checks if the EMV transaction is an online authorized transaction

Returns:

true if the transaction is an online authorized transaction

isReceiptAvailable

boolean isReceiptAvailable()

Indicates if a receipt is available following the completion of the EMV transaction.

Returns:

true if a receipt is available.

getReceipt

TransactionReceipt[] getReceipt()

Returns a list of TransactionReceipt representing the receipt in Json Format Two receipts are available MERCHANT and CARDHOLDER receipts

Returns:

an array of TransactionReceipt representation of the receipts if available, otherwise returns null

isEMVConfigAvailable

boolean isEMVConfigAvailable()

Indicates if gateway has indicated that there are new EMV configs available during the transaction

Returns:

true if new EMV configs are available

getGatewayData

java.util.Map<java.lang.String,java.lang.String> getGatewayData()

Get the custom data sent back by the gateway

Returns:

gatewayData