Docs For Class AssetTransaction

Class AssetTransaction

Description

Located in /AssetTransaction.php (line 10)

ClientObject
   |
   --AccountActivity
      |
      --AccountTransaction
         |
         --AssetTransaction

Variable Summary

String $accessory

String $accountNumber

CaptureInfo $captureInfo

bool $isPrepayment

String $maskedAccessory

String $maskedAccountNumber

String $transactionType

Method Summary

AssetTransaction __construct ([DateTime $createDate = null], [String $transactionType = null], [bool $isPrepayment = null], [String $accountNumber = null], [String $accessory = null], [String $maskedAccountNumber = null], [String $maskedAccessory = null], [int $taxAmount = null])

CaptureInfo createCaptureInfo ()

CaptureInfo createCaptureInfoExtended (String $holderName, String $street, String $city, String $state, String $phone, String $zipCode, String $email, String $cvv2, String $trackData)

String getAccessory ()

String getAccountNumber ()

CaptureInfo getCaptureInfo ()

bool getIsPrepayment ()

String getMaskedAccessory ()

String getMaskedAccountNumber ()

String getTransactionType ()

void setAccessory (String $accessory)

void setAccountNumber (String $accountNumber)

void setCaptureInfo (CaptureInfo $captureInfo)

void setIsPrepayment (bool $isPrepayment)

void setMaskedAccessory (String $maskedAccessory)

void setMaskedAccountNumber (String $maskedAccountNumber)

void setTaxAmount ( $taxAmount)

void setTransactionType (String $transactionType)

void type ()

Variables

String $accessory (line 31)

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

String $accountNumber (line 25)

var: 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.
access: private

CaptureInfo $captureInfo (line 49)

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

bool $isPrepayment (line 19)

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

String $maskedAccessory (line 44)

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

String $maskedAccountNumber (line 38)

var: 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.
access: private

String $transactionType (line 14)

var: Type of AssetTransaction, e.g. Cash, Visa, Checking
access: private

Inherited Variables

Inherited from AccountTransaction

AccountTransaction::$adjustmentTransaction
AccountTransaction::$amount
AccountTransaction::$balance
AccountTransaction::$creatorCode
AccountTransaction::$dueDate
AccountTransaction::$note
AccountTransaction::$sellerCode
AccountTransaction::$shiftCode
AccountTransaction::$taxAmount
AccountTransaction::$terminalCode

Inherited from AccountActivity

AccountActivity::$accountActivityType
AccountActivity::$customerAccount

Inherited from ClientObject

ClientObject::$code
ClientObject::$createDate
ClientObject::$id
ClientObject::$merchantAccountCode
ClientObject::$_hashCode

Methods

Constructor __construct (line 62)

Instantiates a new asset transaction.

DateTime $createDate: createDate the create date
String $transactionType: transactionType the transaction type
bool $isPrepayment: isPrepayment the is prepayment
String $accountNumber: accountNumber the account number
String $accessory: accessory the accessory
String $maskedAccountNumber: maskedAccountNumber the masked account number
String $maskedAccessory: maskedAccessory the masked accessory
int $taxAmount: taxAmount the tax amount

Redefinition of:

AccountTransaction::__construct(): Instantiates a new account transaction.

createCaptureInfo (line 271)

Creates CaptureInfo object and associates it with this AssetTransaction.

return: the capture info
access: public

CaptureInfo createCaptureInfo ()

createCaptureInfoExtended (line 202)

Creates CaptureInfo object and associates it with this AssetTransaction.

return: the capture info
access: public

CaptureInfo createCaptureInfoExtended (String $holderName, String $street, String $city, String $state, String $phone, String $zipCode, String $email, String $cvv2, String $trackData)

String $holderName: holderName the holder name
String $street: street the street
String $city: city the city
String $state: state the state
String $phone: phone the phone
String $zipCode: zipCode the zip code
String $email: email the email
String $cvv2: cvv2 the cvv2
String $trackData: trackData the track data

getAccessory (line 142)

Gets the accessory.

return: Returns the accessory
access: public

String getAccessory ()

getAccountNumber (line 121)

Gets the account number.

return: Returns the accountNumber
access: public

String getAccountNumber ()

getCaptureInfo (line 163)

Gets the capture info.

return: the capture info
access: public

CaptureInfo getCaptureInfo ()

getIsPrepayment (line 103)

Gets the is prepayment.

return: Returns the isPrepayment
access: public

bool getIsPrepayment ()

getMaskedAccessory (line 253)

Gets the masked accessory.

return: the masked accessory
access: public

String getMaskedAccessory ()

getMaskedAccountNumber (line 235)

Gets the masked account number.

return: the masked account number
access: public

String getMaskedAccountNumber ()

getTransactionType (line 78)

Gets the transaction type.

return: Returns the transactionType
access: public

String getTransactionType ()

setAccessory (line 151)

Set a value to accessory.

access: public

void setAccessory (String $accessory)

String $accessory: accessory the accessory

setAccountNumber (line 130)

Set a value to accountNumber.

access: public

void setAccountNumber (String $accountNumber)

String $accountNumber: accountNumber the account number

setCaptureInfo (line 172)

Sets the capture info.

access: public

void setCaptureInfo (CaptureInfo $captureInfo)

CaptureInfo $captureInfo: captureInfo the new capture info

setIsPrepayment (line 112)

Set a value to isPrepayment.

access: public

void setIsPrepayment (bool $isPrepayment)

bool $isPrepayment: isPrepayment the is prepayment

setMaskedAccessory (line 262)

Sets the masked accessory.

void setMaskedAccessory (String $maskedAccessory)

String $maskedAccessory: maskedAccessory the new masked accessory

setMaskedAccountNumber (line 244)

Sets the masked account number.

void setMaskedAccountNumber (String $maskedAccountNumber)

String $maskedAccountNumber: maskedAccountNumber the new masked account number

setTaxAmount (line 180)

access: public

void setTaxAmount ( $taxAmount)

$taxAmount

Redefinition of:

AccountTransaction::setTaxAmount(): Sets the tax amount.

setTransactionType (line 88)

Set a value to transactionType.

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

access: public

void setTransactionType (String $transactionType)

String $transactionType: transactionType the transaction type

type (line 216)

access: public

void type ()

Redefinition of:

AccountActivity::type()

Inherited Methods

Inherited From AccountTransaction

AccountTransaction::__construct()
AccountTransaction::getAdjustmentTransaction()
AccountTransaction::getAmount()
AccountTransaction::getBalance()
AccountTransaction::getCreatorCode()
AccountTransaction::getDueDate()
AccountTransaction::getNote()
AccountTransaction::getSellerCode()
AccountTransaction::getShiftCode()
AccountTransaction::getTaxAmount()
AccountTransaction::getTerminalCode()
AccountTransaction::setAdjustmentTransaction()
AccountTransaction::setAmount()
AccountTransaction::setBalance()
AccountTransaction::setCreatorCode()
AccountTransaction::setDueDate()
AccountTransaction::setNote()
AccountTransaction::setSellerCode()
AccountTransaction::setShiftCode()
AccountTransaction::setTaxAmount()
AccountTransaction::setTerminalCode()

Inherited From AccountActivity

AccountActivity::__construct()
AccountActivity::getAccountActivityType()
AccountActivity::getCustomerAccount()
AccountActivity::setAccountActivityType()
AccountActivity::setCustomerAccount()
AccountActivity::type()

Inherited From ClientObject

ClientObject::getCode()
ClientObject::getCreateDate()
ClientObject::getId()
ClientObject::getMerchantAccountCode()
ClientObject::hashCode()
ClientObject::setCode()
ClientObject::setId()
ClientObject::setMerchantAccountCode()
ClientObject::type()

Documentation generated on Thu, 20 Mar 2008 16:22:09 -0400 by phpDocumentor 1.4.0