ibilling.client
Class AssetTransaction

java.lang.Object
  ibilling.client.ClientObject
      ibilling.client.AccountActivity
          ibilling.client.AccountTransaction
              ibilling.client.AssetTransaction

All Implemented Interfaces:

java.io.Serializable

public class AssetTransaction
extends AccountTransaction

A type of AccountTransaction that represents movement of money (assets) on the account. Payment, Void and Refund are main examples of AssetTransaction.

Since:

1.0

See Also:

Serialized Form

Field Summary

private java.lang.String	accessory For credit card related transactions - expiration date - MMyy For bank account related transactions - routing number Not used otherwise.
private java.lang.String	accountNumber For credit card related transactions - number on the card For bank account related transactions - number of the account For check related transactions - check number Not used otherwise.
private CaptureInfo	captureInfo Reference to the object representing processing related info.
private java.lang.Boolean	isPrepayment If true, this transaction was created as a prepayment against charge (future invoice).
private java.lang.String	maskedAccessory For credit card related transactions - expiration date - MMyy For bank account related transactions - masked routing number e.g.
private java.lang.String	maskedAccountNumber For credit card related transactions - masked number on the card e.g.
private static long	serialVersionUID The Constant serialVersionUID.
private java.lang.String	transactionType Type of AssetTransaction, e.g.

Constructor Summary

AssetTransaction()
Instantiates a new asset transaction.

AssetTransaction(java.util.Date createDate, java.lang.String transactionType, java.lang.Boolean isPrepayment, java.lang.String accountNumber, java.lang.String accessory, java.lang.String maskedAccountNumber, java.lang.String maskedAccessory, java.lang.Integer taxAmount)
Instantiates a new asset transaction.

Method Summary

CaptureInfo	createCaptureInfo() Creates CaptureInfo object and associates it with this AssetTransaction.
CaptureInfo	createCaptureInfoExtended(java.lang.String holderName, java.lang.String street, java.lang.String city, java.lang.String state, java.lang.String phone, java.lang.String zipCode, java.lang.String email, java.lang.String cvv2, java.lang.String trackData) Creates CaptureInfo object and associates it with this AssetTransaction.
java.lang.String	getAccessory() Gets the accessory.
java.lang.String	getAccountNumber() Gets the account number.
CaptureInfo	getCaptureInfo() Gets the capture info.
java.lang.Boolean	getIsPrepayment() Gets the is prepayment.
java.lang.String	getMaskedAccessory() Gets the masked accessory.
java.lang.String	getMaskedAccountNumber() Gets the masked account number.
java.lang.String	getTransactionType() Gets the transaction type.
void	setAccessory(java.lang.String accessory) Set a value to accessory.
void	setAccountNumber(java.lang.String accountNumber) Set a value to accountNumber.
void	setCaptureInfo(CaptureInfo captureInfo) Sets the capture info.
void	setIsPrepayment(java.lang.Boolean isPrepayment) Set a value to isPrepayment.
(package private) void	setMaskedAccessory(java.lang.String maskedAccessory) Sets the masked accessory.
(package private) void	setMaskedAccountNumber(java.lang.String maskedAccountNumber) Sets the masked account number.
void	setTaxAmount(java.lang.Integer taxAmount) Sets the tax amount.
void	setTransactionType(java.lang.String transactionType) Set a value to transactionType.
java.lang.String	type() Returns the type of the object instance using library's terminology In most cases it will match ClassName, but when a single class may represent multiple conceptual objects, the value will differ.

Methods inherited from class ibilling.client.AccountTransaction

getAdjustmentTransaction, getAmount, getBalance, getCreatorCode, getDueDate, getNote, getSellerCode, getShiftCode, getTaxAmount, getTerminalCode, setAdjustmentTransaction, setAmount, setBalance, setCreatorCode, setDueDate, setNote, setSellerCode, setShiftCode, setTerminalCode

Methods inherited from class ibilling.client.AccountActivity

getAccountActivityType, getCustomerAccount, setAccountActivityType, setCustomerAccount

Methods inherited from class ibilling.client.ClientObject

getClientProperty, getCode, getCreateDate, getId, getMerchantAccountCode, getRefId, hasClientProperty, setClientProperty, setCode, setCreateDate, setId, setMerchantAccountCode, setRefId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The Constant serialVersionUID.

See Also:

Constant Field Values

transactionType

private java.lang.String transactionType

Type of AssetTransaction, e.g. Cash, Visa, Checking

isPrepayment

private java.lang.Boolean isPrepayment

If true, this transaction was created as a prepayment against charge (future invoice).

accountNumber

private java.lang.String accountNumber

For credit card related transactions - number on the card
For bank account related transactions - number of the account
For check related transactions - check number
Not used otherwise.

accessory

private java.lang.String accessory

For credit card related transactions - expiration date - MMyy
For bank account related transactions - routing number
Not used otherwise.

maskedAccountNumber

private java.lang.String maskedAccountNumber

For credit card related transactions - masked number on the card e.g. 5******3452
For bank account related transactions - masked number of the account e.g. C******4435
For check related transactions - check number
Not used otherwise.

maskedAccessory

private java.lang.String maskedAccessory

For credit card related transactions - expiration date - MMyy
For bank account related transactions - masked routing number e.g. ***6675
Not used otherwise.

captureInfo

private CaptureInfo captureInfo

Reference to the object representing processing related info. Only available when transaction is of electronic type (credit card or ACH)

Constructor Detail

AssetTransaction

AssetTransaction()

Instantiates a new asset transaction.

AssetTransaction

AssetTransaction(java.util.Date createDate,
                 java.lang.String transactionType,
                 java.lang.Boolean isPrepayment,
                 java.lang.String accountNumber,
                 java.lang.String accessory,
                 java.lang.String maskedAccountNumber,
                 java.lang.String maskedAccessory,
                 java.lang.Integer taxAmount)

Instantiates a new asset transaction.

Parameters:

createDate - the create date

transactionType - the transaction type

isPrepayment - the is prepayment

accountNumber - the account number

accessory - the accessory

maskedAccountNumber - the masked account number

maskedAccessory - the masked accessory

taxAmount - the tax amount

Method Detail

getTransactionType

public java.lang.String getTransactionType()

Gets the transaction type.

Returns:

Returns the transactionType

setTransactionType

public void setTransactionType(java.lang.String transactionType)

Set a value to transactionType. Creates/destroys associated CaptureInfo based on the specified type

Parameters:

transactionType - the transaction type

getIsPrepayment

public java.lang.Boolean getIsPrepayment()

Gets the is prepayment.

Returns:

Returns the isPrepayment

setIsPrepayment

public void setIsPrepayment(java.lang.Boolean isPrepayment)

Set a value to isPrepayment.

Parameters:

isPrepayment - the is prepayment

getAccountNumber

public java.lang.String getAccountNumber()

Gets the account number.

Returns:

Returns the accountNumber

setAccountNumber

public void setAccountNumber(java.lang.String accountNumber)

Set a value to accountNumber.

Parameters:

accountNumber - the account number

getAccessory

public java.lang.String getAccessory()

Gets the accessory.

Returns:

Returns the accessory

setAccessory

public void setAccessory(java.lang.String accessory)

Set a value to accessory.

Parameters:

accessory - the accessory

getCaptureInfo

public CaptureInfo getCaptureInfo()

Gets the capture info.

Returns:

the capture info

setCaptureInfo

public void setCaptureInfo(CaptureInfo captureInfo)

Sets the capture info.

Parameters:

captureInfo - the new capture info

setTaxAmount

public void setTaxAmount(java.lang.Integer taxAmount)

Description copied from class: AccountTransaction

Sets the tax amount.

Overrides:

setTaxAmount in class AccountTransaction

Parameters:

taxAmount - the new tax amount

createCaptureInfo

public CaptureInfo createCaptureInfo()

Creates CaptureInfo object and associates it with this AssetTransaction.

Returns:

the capture info

createCaptureInfoExtended

public CaptureInfo createCaptureInfoExtended(java.lang.String holderName,
                                             java.lang.String street,
                                             java.lang.String city,
                                             java.lang.String state,
                                             java.lang.String phone,
                                             java.lang.String zipCode,
                                             java.lang.String email,
                                             java.lang.String cvv2,
                                             java.lang.String trackData)

Creates CaptureInfo object and associates it with this AssetTransaction.

Parameters:

holderName - the holder name

street - the street

city - the city

state - the state

phone - the phone

zipCode - the zip code

email - the email

cvv2 - the cvv2

trackData - the track data

Returns:

the capture info

type

public java.lang.String type()

Description copied from class: ClientObject

Returns the type of the object instance using library's terminology In most cases it will match ClassName, but when a single class may represent multiple conceptual objects, the value will differ.

Overrides:

type in class AccountActivity

Returns:

the type of the client object

getMaskedAccountNumber

public java.lang.String getMaskedAccountNumber()

Gets the masked account number.

Returns:

the masked account number

setMaskedAccountNumber

void setMaskedAccountNumber(java.lang.String maskedAccountNumber)

Sets the masked account number.

Parameters:

maskedAccountNumber - the new masked account number

getMaskedAccessory

public java.lang.String getMaskedAccessory()

Gets the masked accessory.

Returns:

the masked accessory

setMaskedAccessory

void setMaskedAccessory(java.lang.String maskedAccessory)

Sets the masked accessory.

Parameters:

maskedAccessory - the new masked accessory