Docs For Class CaptureInfo

Class CaptureInfo

Description

ClientObject
   |
   --CaptureInfo

Variable Summary

String $accessory

String $accountNumber

String $approvalCode

String $city

String $cvv2

String $email

String $holderName

String $phone

String $referenceNumber

DateTime $requestDate

DateTime $responseDate

String $returnType

String $state

String $street

int $taxAmount

String $trackData

String $transactionType

String $zipCode

Method Summary

CaptureInfo __construct ([DateTime $requestDate = null], [DateTime $responseDate = null], [String $holderName = null], [int $taxAmount = null], [String $street = null], [String $city = null], [String $state = null], [String $phone = null], [String $zipCode = null], [String $email = null], [String $returnType = null], [String $approvalCode = null], [String $referenceNumber = null], [int $merchantAccountCode = null], [String $accountNumber = null], [String $accessory = null], [String $code = null], [String $transactionType = null], [int $id = null])

String getAccessory ()

String getAccountNumber ()

String getApprovalCode ()

String getCity ()

String getCvv2 ()

String getEmail ()

String getHolderName ()

String getPhone ()

String getReferenceNumber ()

DateTime getRequestDate ()

DateTime getResponseDate ()

String getReturnType ()

String getState ()

String getStreet ()

int getTaxAmount ()

String getTrackData ()

String getTransactionType ()

String getZipCode ()

void setAccessory (String $accessory)

void setAccountNumber (String $accountNumber)

void setApprovalCode (String $approvalCode)

void setCity (String $city)

void setCvv2 (String $cvv2)

void setEmail (String $email)

void setHolderName (String $holderName)

void setPhone (String $phone)

void setReferenceNumber (String $referenceNumber)

void setRequestDate (DateTime $requestDate)

void setResponseDate (DateTime $responseDate)

void setReturnType (String $type)

void setState (String $state)

void setStreet (String $street)

void setTaxAmount (int $taxAmount)

void setTrackData (String $trackData)

void setTransactionType (String $transactionType)

void setZipCode (String $zipCode)

void type ()

Variables

String $accessory (line 72)

var: Expiration date (MMyy) if credit card; routing number if bank account.
access: private

String $accountNumber (line 68)

var: Credit card number if credit card; bank account number if bank account.
access: private

String $approvalCode (line 59)

var: Approval reference code generated by the processor in case of successful authorization (credit card only).
access: private

String $city (line 34)

var: City of the billing address.
access: private

String $cvv2 (line 80)

var: Security code on the back of a credit card (credit card only).
access: private

String $email (line 50)

var: E-mail associated with holder of the card/bank account.
access: private

String $holderName (line 22)

var: Name on the credit card or bank account's holder's name.
access: private

String $phone (line 42)

var: Phone of the billing address.
access: private

String $referenceNumber (line 64)

var: Reference number of the transaction represented by this CaptureInfo in the processor's system (used to issue same-day voids).
access: private

DateTime $requestDate (line 14)

var: Date when the request was sent to processor.
access: private

DateTime $responseDate (line 18)

var: Date when the response from the processor was received.
access: private

String $returnType (line 54)

var: Code defining response type generated by the processor.
access: private

String $state (line 38)

var: State (two-letter code) of the billing address.
access: private

String $street (line 30)

var: Street of the billing address.
access: private

int $taxAmount (line 26)

var: Tax amount if available (part of total amount).
access: private

String $trackData (line 84)

var: Copy of the data from credit card's magnetic tape (credit card only).
access: private

String $transactionType (line 76)

var: Type of the transaction.
access: private

String $zipCode (line 46)

var: ZipCode of the billing address.
access: private

Inherited Variables

Inherited from ClientObject

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

Methods

Constructor __construct (line 108)

Instantiates a new capture info.

DateTime $requestDate: requestDate the request date
DateTime $responseDate: responseDate the response date
String $holderName: holderName the holder name
int $taxAmount: taxAmount the tax amount
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 $returnType: returnType the return type
String $approvalCode: approvalCode the approval code
String $referenceNumber: referenceNumber the reference number
int $merchantAccountCode: merchantAccountCode the merchant account code
String $accountNumber: accountNumber the account number
String $accessory: accessory the accessory
String $code: code the code
String $transactionType: transactionType the transaction type
int $id: id the id

getAccessory (line 387)

Gets the accessory.

return: Returns the accessory
access: public

String getAccessory ()

getAccountNumber (line 369)

Gets the account number.

return: Returns the accountNumber
access: public

String getAccountNumber ()

getApprovalCode (line 333)

Gets the approval code.

return: Returns the approvalCode
access: public

String getApprovalCode ()

getCity (line 225)

Gets the city.

return: Returns the city
access: public

String getCity ()

getCvv2 (line 405)

Gets the cvv2.

return: the cvv2
access: public

String getCvv2 ()

getEmail (line 297)

Gets the email.

return: Returns the email
access: public

String getEmail ()

getHolderName (line 171)

Gets the holder name.

return: Returns the holderName
access: public

String getHolderName ()

getPhone (line 261)

Gets the phone.

return: Returns the phone
access: public

String getPhone ()

getReferenceNumber (line 351)

Gets the reference number.

return: Returns the referenceNumber
access: public

String getReferenceNumber ()

getRequestDate (line 135)

Gets the request date.

return: Returns the requestDate
access: public

DateTime getRequestDate ()

getResponseDate (line 153)

Gets the response date.

return: Returns the responseDate
access: public

DateTime getResponseDate ()

getReturnType (line 315)

Gets the return type.

return: Returns the type
access: public

String getReturnType ()

getState (line 243)

Gets the state.

return: Returns the state
access: public

String getState ()

getStreet (line 207)

Gets the street.

return: Returns the street
access: public

String getStreet ()

getTaxAmount (line 189)

Gets the tax amount.

return: Returns the taxAmount
access: public

int getTaxAmount ()

getTrackData (line 423)

Gets the track data.

return: the track data
access: public

String getTrackData ()

getTransactionType (line 441)

Gets the transaction type.

return: the transaction type
access: public

String getTransactionType ()

getZipCode (line 279)

Gets the zip code.

return: Returns the zipCode
access: public

String getZipCode ()

setAccessory (line 396)

Set a value to accessory.

void setAccessory (String $accessory)

String $accessory: accessory the accessory

setAccountNumber (line 378)

Set a value to assetNumber.

void setAccountNumber (String $accountNumber)

String $accountNumber: accountNumber the account number

setApprovalCode (line 342)

Set a value to approvalCode.

void setApprovalCode (String $approvalCode)

String $approvalCode: approvalCode the approval code

setCity (line 234)

Set a value to city.

access: public

void setCity (String $city)

String $city: city the city

setCvv2 (line 414)

Sets the cvv2.

access: public

void setCvv2 (String $cvv2)

String $cvv2: cvv2 the new cvv2

setEmail (line 306)

Set a value to email.

access: public

void setEmail (String $email)

String $email: email the email

setHolderName (line 180)

Set a value to holderName.

access: public

void setHolderName (String $holderName)

String $holderName: holderName the holder name

setPhone (line 270)

Set a value to phone.

access: public

void setPhone (String $phone)

String $phone: phone the phone

setReferenceNumber (line 360)

Set a value to referenceNumber.

void setReferenceNumber (String $referenceNumber)

String $referenceNumber: referenceNumber the reference number

setRequestDate (line 144)

Set a value to requestDate.

void setRequestDate (DateTime $requestDate)

DateTime $requestDate: requestDate the request date

setResponseDate (line 162)

Set a value to responseDate.

void setResponseDate (DateTime $responseDate)

DateTime $responseDate: responseDate the response date

setReturnType (line 324)

Set a value to type.

void setReturnType (String $type)

String $type: type the type

setState (line 252)

Set a value to state.

access: public

void setState (String $state)

String $state: state the state

setStreet (line 216)

Set a value to street.

access: public

void setStreet (String $street)

String $street: street the street

setTaxAmount (line 198)

Set a value to taxAmount.

void setTaxAmount (int $taxAmount)

int $taxAmount: taxAmount the tax amount

setTrackData (line 432)

Sets the track data.

access: public

void setTrackData (String $trackData)

String $trackData: trackData the new track data

setTransactionType (line 450)

Sets the transaction type.

void setTransactionType (String $transactionType)

String $transactionType: transactionType the new transaction type

setZipCode (line 288)

Set a value to zipCode.

access: public

void setZipCode (String $zipCode)

String $zipCode: zipCode the zip code

type (line 454)

access: public

void type ()

Redefinition of:

ClientObject::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.

Inherited Methods

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:11 -0400 by phpDocumentor 1.4.0