com.ingenico.sdk.transaction.data

Class TransactionResult.Builder

java.lang.Object

com.ingenico.sdk.transaction.data.TransactionResult.Builder

Enclosing class:

TransactionResult

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

Builder (internal usage).

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract TransactionResult	build() Build instance.
abstract TransactionResult.Builder	setAccountId(java.lang.String value) Account ID.
abstract TransactionResult.Builder	setAcquirerCode(java.lang.String value) (not yet implemented) This identifier is defined at national level to recognize the acquirer of the transaction (see AIIC , bit 32 of ISO8583).
abstract TransactionResult.Builder	setAcquirerToken(byte[] value) Acquirer token.
abstract TransactionResult.Builder	setActionCode(java.lang.String value) 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 TransactionResult.Builder	setAdditionalInformation(java.lang.String value) (not yet implemented) Additional information.
abstract TransactionResult.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 TransactionResult.Builder	setApprovalCode(java.lang.String value) Approval code as defined in bit 38 ISO8583.
abstract TransactionResult.Builder	setAuthorizedAmount(java.math.BigDecimal value) Authorized amount (can be different from the requested amount and includes other fees such as tip, donation...).
abstract TransactionResult.Builder	setCardBrand(java.lang.Integer value) (not yet implemented) AMEX/VISA/MasterCard...
abstract TransactionResult.Builder	setCardType(java.lang.Integer value) Debit / credit / EBT / Loyalty...
abstract TransactionResult.Builder	setCashAmount(java.math.BigDecimal value) Cash Tendered Amount.
abstract TransactionResult.Builder	setCashbackAmount(java.math.BigDecimal value) Cash back Amount.
abstract TransactionResult.Builder	setCurrency(java.lang.Long value) Currency Code (Iso4217).
abstract TransactionResult.Builder	setCustomerId(java.lang.String value) Customer ID.
abstract TransactionResult.Builder	setCustomerStatus(java.lang.Integer value) Customer Status.
abstract TransactionResult.Builder	setDonationAmount(java.math.BigDecimal value) Donation Amount.
abstract TransactionResult.Builder	setEffectivePaymentMean(java.lang.Integer value) Card technology used : Contactless Swipe Smart Card QR Code Custom Technologies ...
abstract TransactionResult.Builder	setEmvAtc(java.lang.Integer value) EMV ATC.
abstract TransactionResult.Builder	setEmvCvmResults(byte[] value) EMV CVM Results.
abstract TransactionResult.Builder	setEmvPanSequenceNumber(java.lang.Integer value) EMV PAN Sequence number.
abstract TransactionResult.Builder	setEmvTsi(byte[] value) EMV TSI.
abstract TransactionResult.Builder	setEmvTvr(byte[] value) EMV TVR.
abstract TransactionResult.Builder	setExpirationDate(java.lang.String value) ASCII.
abstract TransactionResult.Builder	setInvoiceId(java.lang.String value) Sale reference identifier.
abstract TransactionResult.Builder	setIssuerIdentificationNumber(java.lang.String value) Issuer Identification Number.
abstract TransactionResult.Builder	setMaskedPan(java.lang.String value) PAN truncated with last 4 digits in clear (eg.
abstract TransactionResult.Builder	setMerchantId(java.lang.String value) (not yet implemented) Merchant Identifier.
abstract TransactionResult.Builder	setMotoType(java.lang.Integer value) MOTO type for manual input.
abstract TransactionResult.Builder	setNgoId(java.lang.String value) NGO (Non-Governmental Organization) identifier.
TransactionResult.Builder	setOnlineTransaction(java.lang.Boolean value) (not yet implemented) Authorization Type: Online / Offline.
abstract TransactionResult.Builder	setOtherFeesAmount(java.math.BigDecimal value) Other Fees Amount.
abstract TransactionResult.Builder	setProductCodeId(java.lang.String value)
abstract TransactionResult.Builder	setRawEmvCardAid(byte[] value) EMV Card Application Identifier.
abstract TransactionResult.Builder	setRetrievalReferenceNumber(java.lang.String value) Optional, original authorization request message identifier.
abstract TransactionResult.Builder	setStan(java.lang.String value) System Trace Audit Number assigned to the transaction (see bit 11 ISO8583).
abstract TransactionResult.Builder	setStatus(TransactionStatus status) Transaction request Status.
abstract TransactionResult.Builder	setSurchargeAmount(java.math.BigDecimal value) Surcharge amount added to the payment amount and defined according to the used card brand.
abstract TransactionResult.Builder	setTerminalId(java.lang.String value) (not yet implemented) Terminal Identification.
abstract TransactionResult.Builder	setTimeStamp(java.lang.String value) (not yet implemented) Date/time.
abstract TransactionResult.Builder	setTipAmount(java.math.BigDecimal value) Tip Amount.
abstract TransactionResult.Builder	setTransactionId(java.lang.String value) Transaction Identifier.
abstract TransactionResult.Builder	setUsedApplication(UsedApplication value) Informations about the payment application used for transaction.

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

setStatus

public abstract TransactionResult.Builder setStatus(TransactionStatus status)

Transaction request Status.

setCurrency

public abstract TransactionResult.Builder setCurrency(java.lang.Long value)

Currency Code (Iso4217).

setAuthorizedAmount

public abstract TransactionResult.Builder setAuthorizedAmount(java.math.BigDecimal value)

Authorized amount (can be different from the requested amount and includes other fees such as tip, donation...).

setAmount

public abstract TransactionResult.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, ...).

setEffectivePaymentMean

public abstract TransactionResult.Builder setEffectivePaymentMean(java.lang.Integer value)

Card technology used :
Contactless
Swipe
Smart Card
QR Code
Custom Technologies
...

This field has a value only for approved transaction, null otherwise.

setTransactionId

public abstract TransactionResult.Builder setTransactionId(java.lang.String value)

Transaction Identifier.

setInvoiceId

public abstract TransactionResult.Builder setInvoiceId(java.lang.String value)

Sale reference identifier. Basket identifier or sale receipt number.

setActionCode

public abstract TransactionResult.Builder setActionCode(java.lang.String value)

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.

setCardType

public abstract TransactionResult.Builder setCardType(java.lang.Integer value)

Debit / credit / EBT / Loyalty...

See Also:

CardTypes for predefined values

setProductCodeId

public abstract TransactionResult.Builder setProductCodeId(java.lang.String value)

setOnlineTransaction

public TransactionResult.Builder setOnlineTransaction(java.lang.Boolean value)

(not yet implemented) Authorization Type: Online / Offline.

setCardBrand

public abstract TransactionResult.Builder setCardBrand(java.lang.Integer value)

(not yet implemented) AMEX/VISA/MasterCard...

See Also:

CardBrands for predefined values

setAcquirerCode

public abstract TransactionResult.Builder setAcquirerCode(java.lang.String value)

(not yet implemented) This identifier is defined at national level to recognize the acquirer of the transaction (see AIIC , bit 32 of ISO8583).

setTimeStamp

public abstract TransactionResult.Builder setTimeStamp(java.lang.String value)

(not yet implemented) Date/time.

Parameters:

value -

Returns:

setAdditionalInformation

public abstract TransactionResult.Builder setAdditionalInformation(java.lang.String value)

(not yet implemented) Additional information.

setStan

public abstract TransactionResult.Builder setStan(java.lang.String value)

System Trace Audit Number assigned to the transaction (see bit 11 ISO8583).

setMaskedPan

public abstract TransactionResult.Builder setMaskedPan(java.lang.String value)

PAN truncated with last 4 digits in clear (eg. ************0034 ). This field has a value only for approved transaction, null otherwise.

setRetrievalReferenceNumber

public abstract TransactionResult.Builder setRetrievalReferenceNumber(java.lang.String value)

Optional, original authorization request message identifier. Can be used in case of refund or cancellation. RRN (retrieval reference number) ISO field 37.

setExpirationDate

public abstract TransactionResult.Builder setExpirationDate(java.lang.String value)

ASCII.

4 bytes : YYMM for Swipe and Manual Entry.

6 bytes : YYMMDD for Contact and ContactLess.

Parameters:

value -

Returns:

setAcquirerToken

public abstract TransactionResult.Builder setAcquirerToken(byte[] value)

Acquirer token.

Parameters:

value -

Returns:

setTerminalId

public abstract TransactionResult.Builder setTerminalId(java.lang.String value)

(not yet implemented) Terminal Identification.

setMerchantId

public abstract TransactionResult.Builder setMerchantId(java.lang.String value)

(not yet implemented) Merchant Identifier.

setTipAmount

public abstract TransactionResult.Builder setTipAmount(java.math.BigDecimal value)

Tip Amount. Tip^amount is added to the requested amount to compute the authorized amount.

setCashbackAmount

public abstract TransactionResult.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 TransactionResult.Builder setDonationAmount(java.math.BigDecimal value)

Donation Amount. Donation amount is added to the requested amount to compute the authorized amount.

setOtherFeesAmount

public abstract TransactionResult.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 TransactionResult.Builder setNgoId(java.lang.String value)

NGO (Non-Governmental Organization) identifier.

setIssuerIdentificationNumber

public abstract TransactionResult.Builder setIssuerIdentificationNumber(java.lang.String value)

Issuer Identification Number.

setApprovalCode

public abstract TransactionResult.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.

setSurchargeAmount

public abstract TransactionResult.Builder setSurchargeAmount(java.math.BigDecimal value)

Surcharge amount added to the payment amount and defined according to the used card brand.

Since:

2.7.0

setUsedApplication

public abstract TransactionResult.Builder setUsedApplication(UsedApplication value)

Informations about the payment application used for transaction.

Since:

2.7.0

setCashAmount

public abstract TransactionResult.Builder setCashAmount(java.math.BigDecimal value)

Cash Tendered Amount.

Since:

2.8.0

setRawEmvCardAid

public abstract TransactionResult.Builder setRawEmvCardAid(byte[] value)

EMV Card Application Identifier.

Since:

2.9.1

setEmvPanSequenceNumber

public abstract TransactionResult.Builder setEmvPanSequenceNumber(java.lang.Integer value)

EMV PAN Sequence number.

Since:

2.10.0

setEmvAtc

public abstract TransactionResult.Builder setEmvAtc(java.lang.Integer value)

EMV ATC.

Since:

2.10.0

setEmvTvr

public abstract TransactionResult.Builder setEmvTvr(byte[] value)

EMV TVR.

Since:

2.10.0

setEmvTsi

public abstract TransactionResult.Builder setEmvTsi(byte[] value)

EMV TSI.

Since:

2.10.0

setEmvCvmResults

public abstract TransactionResult.Builder setEmvCvmResults(byte[] value)

EMV CVM Results.

Since:

2.10.0

setMotoType

public abstract TransactionResult.Builder setMotoType(java.lang.Integer value)

MOTO type for manual input.

Since:

2.11.0

See Also:

MotoType, PaymentMeans.MANUAL_ENTRY

setCustomerId

public abstract TransactionResult.Builder setCustomerId(java.lang.String value)

Customer ID.

Since:

2.11.0

setAccountId

public abstract TransactionResult.Builder setAccountId(java.lang.String value)

Account ID.

Since:

2.11.0

setCustomerStatus

public abstract TransactionResult.Builder setCustomerStatus(java.lang.Integer value)

Customer Status.

Since:

2.14.0

build

public abstract TransactionResult build()

Build instance.