TransactionInputData.Builder (ingenico-api API)

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

Enclosing class:: TransactionInputData

public abstract static class TransactionInputData.Builder
extends java.lang.Object

Builder.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TransactionInputData.Builder`	`addPaymentMean(java.lang.Integer value)` Add a payment mean.
`TransactionInputData`	`build()` Build a TransactionInputData object.
`abstract TransactionInputData.Builder`	`setAcquirerTransactionType(java.lang.Integer value)` Acquirer transaction type.
`abstract TransactionInputData.Builder`	`setAmount(java.math.BigDecimal value)` 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 TransactionInputData.Builder`	`setApprovalCode(java.lang.String value)` Approval code as defined in bit 38 ISO8583.
`abstract TransactionInputData.Builder`	`setCardholderName(java.lang.String value)` Card Holder Name.
`abstract TransactionInputData.Builder`	`setCardType(java.lang.Integer value)` Debit / credit / EBT / Loyalty...
`abstract TransactionInputData.Builder`	`setCashAmount(java.math.BigDecimal value)` Cash Tendered Amount.
`abstract TransactionInputData.Builder`	`setCashbackAmount(java.math.BigDecimal value)` Cash back Amount.
`abstract TransactionInputData.Builder`	`setCashierId(java.lang.String value)` (not yet implemented) Clerk/Cashier identifier.
`abstract TransactionInputData.Builder`	`setCurrency(java.lang.Long value)` Currency Code (Iso4217).
`abstract TransactionInputData.Builder`	`setDonationAmount(java.math.BigDecimal value)` Donation Amount.
`abstract TransactionInputData.Builder`	`setForceAutho(java.lang.Boolean value)` Require an acquirer authorization if true.
`abstract TransactionInputData.Builder`	`setInvoiceId(java.lang.String value)` Sale reference identifier.
`abstract TransactionInputData.Builder`	`setMotoType(java.lang.Integer value)` MOTO type for manual input.
`abstract TransactionInputData.Builder`	`setNgoId(java.lang.String value)` NGO (Non-Governmental Organization) identifier.
`abstract TransactionInputData.Builder`	`setOtherFeesAmount(java.math.BigDecimal value)` Other Fees Amount.
`abstract TransactionInputData.Builder`	`setPaymentApplication(java.lang.String value)` Payment application id to be used for explicit selection.
`abstract TransactionInputData.Builder`	`setPaymentMeans(java.util.List<java.lang.Integer> value)` Technologies to be used for the payment.
`abstract TransactionInputData.Builder`	`setProductCodeId(java.lang.String value)`
`abstract TransactionInputData.Builder`	`setRetrievalReferenceNumber(java.lang.String value)` Original authorization request message identifier to be refunded RRN (retrieval reference number) ISO field 37.
`abstract TransactionInputData.Builder`	`setStan(java.lang.String value)` STAN related to the previous transaction if available.
`abstract TransactionInputData.Builder`	`setSurchargeAmount(java.math.BigDecimal value)` Surcharge amount added to the payment amount and defined according to the used card brand.
`abstract TransactionInputData.Builder`	`setTipAmount(java.math.BigDecimal value)` Tip Amount.
`abstract TransactionInputData.Builder`	`setTransactionId(java.lang.String value)` Transaction Identifier.
`abstract TransactionInputData.Builder`	`setTransactionType(java.lang.Integer value)` Field specifying the transaction type (sale, refund, void...).

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public TransactionInputData build()
```
    Build a TransactionInputData object.
  - setTransactionType
```
public abstract TransactionInputData.Builder setTransactionType(java.lang.Integer value)
```
    Field specifying the transaction type (sale, refund, void...).
    
    See Also:
    
    TransactionTypes for predefined values
  - setAmount
```
public abstract TransactionInputData.Builder setAmount(java.math.BigDecimal value)
```
    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.
  - setCurrency
```
public abstract TransactionInputData.Builder setCurrency(java.lang.Long value)
```
    Currency Code (Iso4217).
  - setPaymentMeans
```
public abstract TransactionInputData.Builder setPaymentMeans(java.util.List<java.lang.Integer> value)
```
    Technologies to be used for the payment. One or several value can be passed.
    
    See Also:
    
    PaymentMeans for predefined values
  - addPaymentMean
```
public TransactionInputData.Builder addPaymentMean(java.lang.Integer value)
```
    Add a payment mean.
    
    See Also:
    
    PaymentMeans for predefined values
  - setPaymentApplication
```
public abstract TransactionInputData.Builder setPaymentApplication(java.lang.String value)
```
    Payment application id to be used for explicit selection.
  - setInvoiceId
```
public abstract TransactionInputData.Builder setInvoiceId(java.lang.String value)
```
    Sale reference identifier. Basket identifier or sale receipt number.
  - setStan
```
public abstract TransactionInputData.Builder setStan(java.lang.String value)
```
    STAN related to the previous transaction if available. ISO field 11.
  - setTransactionId
```
public abstract TransactionInputData.Builder setTransactionId(java.lang.String value)
```
    Transaction Identifier.
  - setProductCodeId
```
public abstract TransactionInputData.Builder setProductCodeId(java.lang.String value)
```
  - setCardType
```
public abstract TransactionInputData.Builder setCardType(java.lang.Integer value)
```
    Debit / credit / EBT / Loyalty...
    
    See Also:
    
    CardTypes for predefined values
  - setForceAutho
```
public abstract TransactionInputData.Builder setForceAutho(java.lang.Boolean value)
```
    Require an acquirer authorization if true.
  - setCashierId
```
public abstract TransactionInputData.Builder setCashierId(java.lang.String value)
```
    (not yet implemented) Clerk/Cashier identifier.
  - setApprovalCode
```
public abstract TransactionInputData.Builder setApprovalCode(java.lang.String value)
```
    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.
  - setRetrievalReferenceNumber
```
public abstract TransactionInputData.Builder setRetrievalReferenceNumber(java.lang.String value)
```
    Original authorization request message identifier to be refunded RRN (retrieval reference number) ISO field 37.
  - setCardholderName
```
public abstract TransactionInputData.Builder setCardholderName(java.lang.String value)
```
    Card Holder Name.
  - setTipAmount
```
public abstract TransactionInputData.Builder setTipAmount(java.math.BigDecimal value)
```
    Tip Amount. Tip amount is added to the requested amount to compute the authorized amount.
  - setCashbackAmount
```
public abstract TransactionInputData.Builder setCashbackAmount(java.math.BigDecimal value)
```
    Cash back Amount. Cash back amount is added to the requested amount to compute the authorized amount.
  - setDonationAmount
```
public abstract TransactionInputData.Builder setDonationAmount(java.math.BigDecimal value)
```
    Donation Amount. Donation amount is added to the requested amount to compute the authorized amount.
  - setOtherFeesAmount
```
public abstract TransactionInputData.Builder setOtherFeesAmount(java.math.BigDecimal value)
```
    Other Fees Amount. Other fees amount is added to the requested amount to compute the authorized amount.
  - setNgoId
```
public abstract TransactionInputData.Builder setNgoId(java.lang.String value)
```
    NGO (Non-Governmental Organization) identifier.
  - setAcquirerTransactionType
```
public abstract TransactionInputData.Builder setAcquirerTransactionType(java.lang.Integer value)
```
    Acquirer transaction type.
    
    Parameters:
    
    value -
    
    Returns:
  - setSurchargeAmount
```
public abstract TransactionInputData.Builder setSurchargeAmount(java.math.BigDecimal value)
```
    Surcharge amount added to the payment amount and defined according to the used card brand.
  - setCashAmount
```
public abstract TransactionInputData.Builder setCashAmount(java.math.BigDecimal value)
```
    Cash Tendered Amount.
    
    Since:
    
    2.8.0
  - setMotoType
```
public abstract TransactionInputData.Builder setMotoType(java.lang.Integer value)
```
    MOTO type for manual input.
    
    Since:
    
    2.11.0
    
    See Also:
    
    MotoType, PaymentMeans.MANUAL_ENTRY

Class TransactionInputData.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

setTransactionType

setAmount

setCurrency

setPaymentMeans

addPaymentMean

setPaymentApplication

setInvoiceId

setStan

setTransactionId

setProductCodeId

setCardType

setForceAutho

setCashierId

setApprovalCode

setRetrievalReferenceNumber

setCardholderName

setTipAmount

setCashbackAmount

setDonationAmount

setOtherFeesAmount

setNgoId

setAcquirerTransactionType

setSurchargeAmount

setCashAmount

setMotoType