TransactionInputData (ingenico-api API)

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

All Implemented Interfaces:: android.os.Parcelable

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

Transaction Input Data.

Example of a transaction request: Transaction debit using ContactChip 3€

ITransaction transaction = Transaction.getInstance(context);

TransactionInputData inputData = TransactionInputData.builder()
        .setTransactionType(TransactionTypes.SALE)
        .setPaymentMeans(Arrays.asList(PaymentMeans.CONTACT_CHIP))
        .setAmount(new BigDecimal("3.0"))
        .setTipAmount(new BigDecimal("1.00"))
        .setSurchargeAmount(new BigDecimal("0.45"))
        .build();

TransactionRequest request = transaction.start(inputData);

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TransactionInputData.Builder
Builder.
- 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`	`TransactionInputData.Builder` Builder.

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<TransactionInputData> 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<TransactionInputData>`	`CREATOR`

Constructor Summary

Constructors
Constructor and Description

TransactionInputData()

Constructors
Constructor and Description
`TransactionInputData()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static TransactionInputData.Builder`	`builder()`
`abstract java.lang.Integer`	`getAcquirerTransactionType()` Acquirer transaction type.
`abstract java.math.BigDecimal`	`getAmount()` Amount is the requested 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.lang.String`	`getCardholderName()` Card Holder Name.
`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.String`	`getCashierId()` Clerk/Cashier identifier.
`abstract java.lang.Long`	`getCurrency()` Currency Code (Iso4217).
`abstract java.math.BigDecimal`	`getDonationAmount()` Donation Amount.
`abstract java.lang.String`	`getInvoiceId()` Sale reference 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`	`getPaymentApplication()` Payment application id to be used for explicit selection.
`abstract java.util.List<java.lang.Integer>`	`getPaymentMeans()` Technologies to be used for the payment.
`abstract java.lang.String`	`getProductCodeId()`
`abstract java.lang.String`	`getRetrievalReferenceNumber()` Original authorization request message identifier to be refunded RRN (retrieval reference number) ISO field 37.
`abstract java.lang.String`	`getStan()` STAN related to the previous transaction if available.
`abstract java.math.BigDecimal`	`getSurchargeAmount()` Surcharge amount added to the payment amount and defined according to the used card brand.
`abstract java.math.BigDecimal`	`getTipAmount()` Tip Amount.
`abstract java.lang.String`	`getTransactionId()` Transaction Identifier.
`abstract java.lang.Integer`	`getTransactionType()` Field specifying the transaction type (sale, refund, void...).
`java.lang.Boolean`	`isForceAutho()` Require an acquirer authorization if true.

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<TransactionInputData> CREATOR
```
- Constructor Detail
  - TransactionInputData
```
public TransactionInputData()
```
- Method Detail
  - getTransactionType
```
public abstract java.lang.Integer getTransactionType()
```
    Field specifying the transaction type (sale, refund, void...).
    
    See Also:
    
    TransactionTypes for predefined values
  - getAmount
```
@Nullable
public abstract java.math.BigDecimal getAmount()
```
    Amount is the requested amount for goods and services without additional fees (does not include cash back amount or other fees, such as tips, donation, ...). If not provided, the terminal has to request the amount.
  - getCurrency
```
@Nullable
public abstract java.lang.Long getCurrency()
```
    Currency Code (Iso4217).
  - getPaymentMeans
```
public abstract java.util.List<java.lang.Integer> getPaymentMeans()
```
    Technologies to be used for the payment. One or several value can be passed.
    
    See Also:
    
    PaymentMeans for predefined values
  - getPaymentApplication
```
@Nullable
public abstract java.lang.String getPaymentApplication()
```
    Payment application id to be used for explicit selection.
  - getInvoiceId
```
@Nullable
public abstract java.lang.String getInvoiceId()
```
    Sale reference identifier. Basket identifier or sale receipt number.
  - getStan
```
@Nullable
public abstract java.lang.String getStan()
```
    STAN related to the previous transaction if available. ISO field 11.
  - getTransactionId
```
@Nullable
public abstract java.lang.String getTransactionId()
```
    Transaction Identifier.
  - getProductCodeId
```
@Nullable
public abstract java.lang.String getProductCodeId()
```
  - getCardType
```
@Nullable
public abstract java.lang.Integer getCardType()
```
    Debit / credit / EBT / Loyalty...
    
    See Also:
    
    CardTypes for predefined values
  - isForceAutho
```
public java.lang.Boolean isForceAutho()
```
    Require an acquirer authorization if true.
  - getCashierId
```
@Nullable
public abstract java.lang.String getCashierId()
```
    Clerk/Cashier identifier.
  - 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.
  - getRetrievalReferenceNumber
```
@Nullable
public abstract java.lang.String getRetrievalReferenceNumber()
```
    Original authorization request message identifier to be refunded RRN (retrieval reference number) ISO field 37.
  - getAcquirerTransactionType
```
@Nullable
public abstract java.lang.Integer getAcquirerTransactionType()
```
    Acquirer transaction type.
    
    Returns:
  - getCardholderName
```
@Nullable
public abstract java.lang.String getCardholderName()
```
    Card Holder Name.
  - getTipAmount
```
@Nullable
public abstract java.math.BigDecimal getTipAmount()
```
    Tip Amount. Tip amount is added to the requested amount to compute the authorized amount.
  - 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.
  - getDonationAmount
```
@Nullable
public abstract java.math.BigDecimal getDonationAmount()
```
    Donation Amount. Donation amount is added to the requested amount to compute the authorized amount.
  - getOtherFeesAmount
```
@Nullable
public abstract java.math.BigDecimal getOtherFeesAmount()
```
    Other Fees Amount. Other fees mmount is added to the requested amount to compute the authorized amount.
  - getNgoId
```
@Nullable
public abstract java.lang.String getNgoId()
```
    NGO (Non-Governmental Organization) identifier.
  - 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
  - getCashAmount
```
@Nullable
public abstract java.math.BigDecimal getCashAmount()
```
    Cash Tendered Amount.
    
    Since:
    
    2.8.0
  - getMotoType
```
@Nullable
public abstract java.lang.Integer getMotoType()
```
    MOTO type for manual input.
    
    Since:
    
    2.11.0
    
    See Also:
    
    MotoType, PaymentMeans.MANUAL_ENTRY
  - builder
```
public static TransactionInputData.Builder builder()
```

Class TransactionInputData

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

TransactionInputData

Method Detail

getTransactionType

getAmount

getCurrency

getPaymentMeans

getPaymentApplication

getInvoiceId

getStan

getTransactionId

getProductCodeId

getCardType

isForceAutho

getCashierId

getApprovalCode

getRetrievalReferenceNumber

getAcquirerTransactionType

getCardholderName

getTipAmount

getCashbackAmount

getDonationAmount

getOtherFeesAmount

getNgoId

getSurchargeAmount

getCashAmount

getMotoType

builder