TransactionResult (ingenico-api API)

java.lang.Object
- com.ingenico.sdk.transaction.data.TransactionResult

All Implemented Interfaces:: android.os.Parcelable

public abstract class TransactionResult
extends java.lang.Object
implements android.os.Parcelable

Result of a transaction, returned by a ITransactionDoneListener.

Example:

ITransaction transaction = Transaction.getInstance(context);
ITransactionDoneListener transactionListener = new ITransactionDoneListener() {
    @Override
    public void onTransactionDone(TransactionResult result) {
        if (result.getStatus() == TransactionStatus.TXN_STATUS_TXN_APPROVED) {
            Log.i(TAG, "Transaction successful"
                    + ", amount: " + result.getAuthorizedAmount()
                    + ", payment mean used: " + result.getEffectivePaymentMean());

            // Handle result
        } else {
            Log.e(TAG, "Transaction failed, error code:" + result.getStatus());
        }
    }
};
transaction.registerTransactionDoneListener(transactionListener);

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TransactionResult.Builder
Builder (internal usage).
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`TransactionResult.Builder` Builder (internal usage).

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<TransactionResult> CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<TransactionResult>`	`CREATOR`

Constructor Summary

Constructors
Constructor and Description

TransactionResult()

Constructors
Constructor and Description
`TransactionResult()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static TransactionResult.Builder`	`builder()` Builder.
`static TransactionResult`	`create(TransactionStatus status)`
`static TransactionResult`	`create(TransactionStatus status, java.lang.Integer paymentMean)`
`abstract java.lang.String`	`getAccountId()` Account ID.
`abstract java.lang.String`	`getAcquirerCode()` (not yet implemented) This identifier is defined at national level to recognize the acquirer of the transaction (see AIIC , bit 32 of ISO8583).
`abstract byte[]`	`getAcquirerToken()` Acquirer token.
`abstract java.lang.String`	`getActionCode()` Code assigned by the bank describing the reason of the non-acceptance of the processed transaction (see bit 39 in ISO8583); "00" for approved transaction.
`abstract java.lang.String`	`getAdditionalInformation()` (not yet implemented) Additionnal Information (free).
`abstract java.math.BigDecimal`	`getAmount()` Requested Amount is the transaction amount for goods and services without additional fees (does not include cash back amount or other fees, such as tips, donation, ...).
`abstract java.lang.String`	`getApprovalCode()` Approval code as defined in bit 38 ISO8583.
`abstract java.math.BigDecimal`	`getAuthorizedAmount()` Authorized amount is the amount paid by the customer (can be different from the requested amount since it includes other fees such as tip, donation...).
`abstract java.lang.Integer`	`getCardBrand()` (not yet implemented) AMEX/VISA/MasterCard...
`abstract java.lang.Integer`	`getCardType()` Debit / credit / EBT / Loyalty...
`abstract java.math.BigDecimal`	`getCashAmount()` Cash Tendered Amount.
`abstract java.math.BigDecimal`	`getCashbackAmount()` Cash back Amount.
`abstract java.lang.Long`	`getCurrency()` Currency Code (Iso4217).
`abstract java.lang.String`	`getCustomerId()` Customer ID.
`abstract java.lang.Integer`	`getCustomerStatus()` Customer Status.
`abstract java.math.BigDecimal`	`getDonationAmount()` Donation Amount.
`abstract java.lang.Integer`	`getEffectivePaymentMean()` Card technology used : Contactless Swipe Smart Card QR Code Custom Technologies ...
`abstract java.lang.Integer`	`getEmvAtc()` EMV ATC.
`java.lang.String`	`getEmvCardAid()` EMV Card Application Identifier.
`abstract byte[]`	`getEmvCvmResults()` EMV CVM Results.
`abstract java.lang.Integer`	`getEmvPanSequenceNumber()` EMV PAN Sequence Number.
`abstract byte[]`	`getEmvTsi()` EMV TSI.
`abstract byte[]`	`getEmvTvr()` EMV TVR.
`abstract java.lang.String`	`getExpirationDate()` ASCII.
`abstract java.lang.String`	`getInvoiceId()` Sale reference identifier.
`abstract java.lang.String`	`getIssuerIdentificationNumber()` Issuer Identification Number.
`abstract java.lang.String`	`getMaskedPan()` PAN truncated with last 4 digits in clear (eg.
`abstract java.lang.String`	`getMerchantId()` (not yet implemented) Merchant Identifier.
`abstract java.lang.Integer`	`getMotoType()` MOTO type for manual input.
`abstract java.lang.String`	`getNgoId()` NGO (Non-Governmental Organization) identifier.
`abstract java.math.BigDecimal`	`getOtherFeesAmount()` Other Fees Amount.
`abstract java.lang.String`	`getProductCodeId()` Product code id
`abstract java.lang.String`	`getRetrievalReferenceNumber()` Optional, original authorization request message identifier.
`abstract java.lang.String`	`getStan()` System Trace Audit Number assigned to the transaction (see bit 11 ISO8583).
`abstract TransactionStatus`	`getStatus()` Transaction request Status.
`abstract java.math.BigDecimal`	`getSurchargeAmount()` Surcharge amount added to the payment amount and defined according to the used card brand.
`abstract java.lang.String`	`getTerminalId()` (not yet implemented) Terminal Identification.
`abstract java.lang.String`	`getTimeStamp()` (not yet implemented) Date/time (14 bytes : yyyymmddhhmmss).
`abstract java.math.BigDecimal`	`getTipAmount()` Tip Amount.
`java.math.BigDecimal`	`getTotalAmount()` Total amount paid by customer (including tip, donation, etc...).
`abstract java.lang.String`	`getTransactionId()` Transaction Identifier.
`abstract UsedApplication`	`getUsedApplication()` Informations about the payment application used for transaction.
`java.lang.Boolean`	`isOnlineTransaction()` (not yet implemented) Authorization Type: Online / Offline.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.os.Parcelable
describeContents, writeToParcel

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<TransactionResult> CREATOR
```
- Constructor Detail
  - TransactionResult
```
public TransactionResult()
```
- Method Detail
  - getStatus
```
public abstract TransactionStatus getStatus()
```
    Transaction request Status.
  - getCurrency
```
@Nullable
public abstract java.lang.Long getCurrency()
```
    Currency Code (Iso4217).
  - getAuthorizedAmount
```
@Nullable
public abstract java.math.BigDecimal getAuthorizedAmount()
```
    Authorized amount is the amount paid by the customer (can be different from the requested amount since it includes other fees such as tip, donation...).
  - getTotalAmount
```
@Nullable
public java.math.BigDecimal getTotalAmount()
```
    Total amount paid by customer (including tip, donation, etc...). Is currently equal to getAuthorizedAmount. Subject to further evolutions.
  - getEffectivePaymentMean
```
@Nullable
public abstract java.lang.Integer getEffectivePaymentMean()
```
    Card technology used :
    Contactless
    Swipe
    Smart Card
    QR Code
    Custom Technologies
    ...
    
    This field has a value only for approved transaction, null otherwise.
    
    Returns:
    
    the payment mean used for the transaction
    
    See Also:
    
    PaymentMeans for predefined values
  - getTransactionId
```
@Nullable
public abstract java.lang.String getTransactionId()
```
    Transaction Identifier.
  - getInvoiceId
```
@Nullable
public abstract java.lang.String getInvoiceId()
```
    Sale reference identifier. Basket identifier or sale receipt number.
  - getActionCode
```
@Nullable
public abstract java.lang.String getActionCode()
```
    Code assigned by the bank describing the reason of the non-acceptance of the processed transaction (see bit 39 in ISO8583); "00" for approved transaction.
  - getCardType
```
@Nullable
public abstract java.lang.Integer getCardType()
```
    Debit / credit / EBT / Loyalty...
    
    See Also:
    
    CardTypes for predefined values
  - getProductCodeId
```
@Nullable
public abstract java.lang.String getProductCodeId()
```
    Product code id
  - isOnlineTransaction
```
@Nullable
public java.lang.Boolean isOnlineTransaction()
```
    (not yet implemented) Authorization Type: Online / Offline.
  - getCardBrand
```
@Nullable
public abstract java.lang.Integer getCardBrand()
```
    (not yet implemented) AMEX/VISA/MasterCard...
    
    See Also:
    
    for predefined values
  - getAcquirerCode
```
@Nullable
public abstract java.lang.String getAcquirerCode()
```
    (not yet implemented) This identifier is defined at national level to recognize the acquirer of the transaction (see AIIC , bit 32 of ISO8583).
  - getAdditionalInformation
```
@Nullable
public abstract java.lang.String getAdditionalInformation()
```
    (not yet implemented) Additionnal Information (free).
  - getTimeStamp
```
@Nullable
public abstract java.lang.String getTimeStamp()
```
    (not yet implemented) Date/time (14 bytes : yyyymmddhhmmss).
  - getStan
```
@Nullable
public abstract java.lang.String getStan()
```
    System Trace Audit Number assigned to the transaction (see bit 11 ISO8583).
  - getMaskedPan
```
@Nullable
public abstract java.lang.String getMaskedPan()
```
    PAN truncated with last 4 digits in clear (eg. ************0034 ). This field has a value only for approved transaction, null otherwise.
  - getRetrievalReferenceNumber
```
@Nullable
public abstract java.lang.String getRetrievalReferenceNumber()
```
    Optional, original authorization request message identifier. Can be used in case of refund or cancellation. RRN (retrieval reference number) ISO field 37.
  - getAcquirerToken
```
@Nullable
public abstract byte[] getAcquirerToken()
```
    Acquirer token.
    
    Returns:
    
    Since:
    
    2.4.0
  - getExpirationDate
```
@Nullable
public abstract java.lang.String getExpirationDate()
```
    ASCII.
    4 bytes : YYMM for Swipe and Manual Entry.
    6 bytes : YYMMDD for Contact and ContactLess.
    
    Returns:
  - getTerminalId
```
@Nullable
public abstract java.lang.String getTerminalId()
```
    (not yet implemented) Terminal Identification.
    
    Returns:
    
    Since:
    
    2.4.0
  - getMerchantId
```
@Nullable
public abstract java.lang.String getMerchantId()
```
    (not yet implemented) Merchant Identifier.
    
    Returns:
    
    Since:
    
    2.4.0
  - getCashbackAmount
```
@Nullable
public abstract java.math.BigDecimal getCashbackAmount()
```
    Cash back Amount. Cash back amount is added to the requested amount to compute the authorized amount.
    
    Since:
    
    2.4.0
  - getTipAmount
```
@Nullable
public abstract java.math.BigDecimal getTipAmount()
```
    Tip Amount. Tip is added to the requested amount to compute the authorized amount.
    
    Since:
    
    2.4.0
  - getDonationAmount
```
@Nullable
public abstract java.math.BigDecimal getDonationAmount()
```
    Donation Amount. Donation amount is added to the requested amount to compute the authorized amount.
    
    Since:
    
    2.4.0
  - getOtherFeesAmount
```
@Nullable
public abstract java.math.BigDecimal getOtherFeesAmount()
```
    Other Fees Amount. Other fees amount is added to the requested amount to compute the authorized amount.
    
    Since:
    
    2.4.0
  - getNgoId
```
@Nullable
public abstract java.lang.String getNgoId()
```
    NGO (Non-Governmental Organization) identifier.
    
    Since:
    
    2.4.0
  - getIssuerIdentificationNumber
```
@Nullable
public abstract java.lang.String getIssuerIdentificationNumber()
```
    Issuer Identification Number.
    
    Since:
    
    2.4.0
  - getApprovalCode
```
@Nullable
public abstract java.lang.String getApprovalCode()
```
    Approval code as defined in bit 38 ISO8583. Initial Pre Authorization transaction approval code. As an alternative to Approval Code the Invoice Number can be used under particular circumstances.
    
    Since:
    
    2.4.0
  - getAmount
```
@Nullable
public abstract java.math.BigDecimal getAmount()
```
    Requested Amount is the transaction amount for goods and services without additional fees (does not include cash back amount or other fees, such as tips, donation, ...).
  - getSurchargeAmount
```
@Nullable
public abstract java.math.BigDecimal getSurchargeAmount()
```
    Surcharge amount added to the payment amount and defined according to the used card brand.
    
    Since:
    
    2.7.0
  - getUsedApplication
```
@Nullable
public abstract UsedApplication getUsedApplication()
```
    Informations about the payment application used for transaction.
    
    Since:
    
    2.7.0
  - getCashAmount
```
@Nullable
public abstract java.math.BigDecimal getCashAmount()
```
    Cash Tendered Amount.
    
    Since:
    
    2.8.0
  - getEmvCardAid
```
@Nullable
public java.lang.String getEmvCardAid()
```
    EMV Card Application Identifier.
    
    Since:
    
    2.9.1
  - getEmvPanSequenceNumber
```
@Nullable
public abstract java.lang.Integer getEmvPanSequenceNumber()
```
    EMV PAN Sequence Number.
    
    Since:
    
    2.10.0
  - getEmvAtc
```
@Nullable
public abstract java.lang.Integer getEmvAtc()
```
    EMV ATC.
    
    Since:
    
    2.10.0
  - getEmvTvr
```
@Nullable
public abstract byte[] getEmvTvr()
```
    EMV TVR. 5 bytes.
    
    Since:
    
    2.10.0
  - getEmvTsi
```
@Nullable
public abstract byte[] getEmvTsi()
```
    EMV TSI. 2 bytes.
    
    Since:
    
    2.10.0
  - getEmvCvmResults
```
@Nullable
public abstract byte[] getEmvCvmResults()
```
    EMV CVM Results. 3 bytes.
    
    Since:
    
    2.10.0
  - getMotoType
```
@Nullable
public abstract java.lang.Integer getMotoType()
```
    MOTO type for manual input.
    
    Since:
    
    2.11.0
    
    See Also:
    
    MotoType, PaymentMeans.MANUAL_ENTRY
  - getCustomerId
```
@Nullable
public abstract java.lang.String getCustomerId()
```
    Customer ID.
    
    Since:
    
    2.11.0
  - getAccountId
```
@Nullable
public abstract java.lang.String getAccountId()
```
    Account ID.
    
    Since:
    
    2.11.0
  - getCustomerStatus
```
@Nullable
public abstract java.lang.Integer getCustomerStatus()
```
    Customer Status.
    
    Since:
    
    2.14.0
  - create
```
public static TransactionResult create(TransactionStatus status,
                                       java.lang.Integer paymentMean)
```
  - create
```
public static TransactionResult create(TransactionStatus status)
```
  - builder
```
public static TransactionResult.Builder builder()
```
    Builder.

Class TransactionResult

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface android.os.Parcelable

Field Detail

CREATOR

Constructor Detail

TransactionResult

Method Detail

getStatus

getCurrency

getAuthorizedAmount

getTotalAmount

getEffectivePaymentMean

getTransactionId

getInvoiceId

getActionCode

getCardType

getProductCodeId

isOnlineTransaction

getCardBrand

getAcquirerCode

getAdditionalInformation

getTimeStamp

getStan

getMaskedPan

getRetrievalReferenceNumber

getAcquirerToken

getExpirationDate

getTerminalId

getMerchantId

getCashbackAmount

getTipAmount

getDonationAmount

getOtherFeesAmount

getNgoId

getIssuerIdentificationNumber

getApprovalCode

getAmount

getSurchargeAmount

getUsedApplication

getCashAmount

getEmvCardAid

getEmvPanSequenceNumber

getEmvAtc

getEmvTvr

getEmvTsi

getEmvCvmResults

getMotoType

getCustomerId

getAccountId

getCustomerStatus

create

create

builder