ibilling.client
Class CaptureInfo

java.lang.Object
  ibilling.client.ClientObject
      ibilling.client.CaptureInfo

All Implemented Interfaces:

java.io.Serializable

public class CaptureInfo
extends ClientObject

Represents electronic processor related info. Used for credit card and ACH processing transactions.

Since:

1.0

See Also:

Serialized Form

Field Summary

private java.lang.String	accessory Expiration date (MMyy) if credit card; routing number if bank account.
private java.lang.String	accountNumber Credit card number if credit card; bank account number if bank account.
private java.lang.String	approvalCode Approval reference code generated by the processor in case of successful authorization (credit card only).
private java.lang.String	city City of the billing address.
private java.lang.String	cvv2 Security code on the back of a credit card (credit card only).
private java.lang.String	email E-mail associated with holder of the card/bank account.
private java.lang.String	holderName Name on the credit card or bank account's holder's name.
private java.lang.String	issuerBankName Name of the bank which issued the credit card based on BIN number.
private java.lang.String	issuerBankPhone Customer service phone number listed on back of credit card.
private java.lang.String	phone Phone of the billing address.
private java.lang.String	referenceNumber Reference number of the transaction represented by this CaptureInfo in the processor's system (used to issue same-day voids).
private java.util.Date	requestDate Date when the request was sent to processor.
private java.util.Date	responseDate Date when the response from the processor was received.
private java.lang.String	returnType Code defining response type generated by the processor.
private java.lang.String	riskExplanation A brief explanation of the score, detailing what factors contributed to it, according to our formula
private java.lang.Integer	riskScore New fraud score representing the estimated probability that the order is fraud, based off of analysis of past minFraud transactions.
private static long	serialVersionUID The Constant serialVersionUID.
private java.lang.String	state State (two-letter code) of the billing address.
private java.lang.String	street Street of the billing address.
private java.lang.Integer	taxAmount Tax amount if available (part of total amount).
private java.lang.String	trackData Copy of the data from credit card's magnetic tape (credit card only).
private java.lang.String	transactionType Type of the transaction.
private java.lang.String	zipCode ZipCode of the billing address.

Constructor Summary

CaptureInfo()
Instantiates a new capture info.

CaptureInfo(java.util.Date requestDate, java.util.Date responseDate, java.lang.String holderName, java.lang.Integer taxAmount, 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 returnType, java.lang.String approvalCode, java.lang.String referenceNumber, java.lang.Integer merchantAccountCode, java.lang.String accountNumber, java.lang.String accessory, java.lang.String code, java.lang.String transactionType, java.lang.Long id)
Instantiates a new capture info.

Method Summary

java.lang.String	getAccessory() Gets the accessory.
java.lang.String	getAccountNumber() Gets the account number.
java.lang.String	getApprovalCode() Gets the approval code.
java.lang.String	getCity() Gets the city.
java.lang.String	getCvv2() Gets the cvv2.
java.lang.String	getEmail() Gets the email.
java.lang.String	getHolderName() Gets the holder name.
java.lang.String	getIssuerBankName() Gets the issuer bank name.
java.lang.String	getIssuerBankPhone() Gets the issuer bank phone.
java.lang.String	getPhone() Gets the phone.
java.lang.String	getReferenceNumber() Gets the reference number.
java.util.Date	getRequestDate() Gets the request date.
java.util.Date	getResponseDate() Gets the response date.
java.lang.String	getReturnType() Gets the return type.
java.lang.String	getRiskExplanation() Gets the risk explanation.
java.lang.Integer	getRiskScore() Gets the risk score.
java.lang.String	getState() Gets the state.
java.lang.String	getStreet() Gets the street.
java.lang.Integer	getTaxAmount() Gets the tax amount.
java.lang.String	getTrackData() Gets the track data.
java.lang.String	getTransactionType() Gets the transaction type.
java.lang.String	getZipCode() Gets the zip code.
(package private) void	setAccessory(java.lang.String accessory) Set a value to accessory.
(package private) void	setAccountNumber(java.lang.String accountNumber) Set a value to assetNumber.
(package private) void	setApprovalCode(java.lang.String approvalCode) Set a value to approvalCode.
void	setCity(java.lang.String city) Set a value to city.
void	setCvv2(java.lang.String cvv2) Sets the cvv2.
void	setEmail(java.lang.String email) Set a value to email.
void	setHolderName(java.lang.String holderName) Set a value to holderName.
void	setIssuerBankName(java.lang.String issuerBankName) Sets the issuer bank name.
void	setIssuerBankPhone(java.lang.String issuerBankPhone) Sets the issuer bank phone.
void	setPhone(java.lang.String phone) Set a value to phone.
(package private) void	setReferenceNumber(java.lang.String referenceNumber) Set a value to referenceNumber.
(package private) void	setRequestDate(java.util.Date requestDate) Set a value to requestDate.
(package private) void	setResponseDate(java.util.Date responseDate) Set a value to responseDate.
(package private) void	setReturnType(java.lang.String returnType) Set a value to type.
void	setRiskExplanation(java.lang.String riskExplanation) Sets the risk explanation.
void	setRiskScore(java.lang.Integer riskScore) Sets the risk score.
void	setState(java.lang.String state) Set a value to state.
void	setStreet(java.lang.String street) Set a value to street.
(package private) void	setTaxAmount(java.lang.Integer taxAmount) Set a value to taxAmount.
void	setTrackData(java.lang.String trackData) Sets the track data.
(package private) void	setTransactionType(java.lang.String transactionType) Sets the transaction type.
void	setZipCode(java.lang.String zipCode) Set a value to zipCode.
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.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

requestDate

private java.util.Date requestDate

Date when the request was sent to processor.

responseDate

private java.util.Date responseDate

Date when the response from the processor was received.

holderName

private java.lang.String holderName

Name on the credit card or bank account's holder's name.

taxAmount

private java.lang.Integer taxAmount

Tax amount if available (part of total amount).

street

private java.lang.String street

Street of the billing address. Use space to combine street1 and street2

city

private java.lang.String city

City of the billing address.

state

private java.lang.String state

State (two-letter code) of the billing address.

phone

private java.lang.String phone

Phone of the billing address.

zipCode

private java.lang.String zipCode

ZipCode of the billing address.

email

private java.lang.String email

E-mail associated with holder of the card/bank account.

returnType

private java.lang.String returnType

Code defining response type generated by the processor.

issuerBankName

private java.lang.String issuerBankName

Name of the bank which issued the credit card based on BIN number. Used to verify that cardholder is in possession of credit card

issuerBankPhone

private java.lang.String issuerBankPhone

Customer service phone number listed on back of credit card. Used to verify that cardholder is in possession of credit card.

approvalCode

private java.lang.String approvalCode

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

referenceNumber

private java.lang.String referenceNumber

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

accountNumber

private java.lang.String accountNumber

Credit card number if credit card; bank account number if bank account.

accessory

private java.lang.String accessory

Expiration date (MMyy) if credit card; routing number if bank account.

transactionType

private java.lang.String transactionType

Type of the transaction.

cvv2

private java.lang.String cvv2

Security code on the back of a credit card (credit card only).

trackData

private java.lang.String trackData

Copy of the data from credit card's magnetic tape (credit card only).

riskScore

private java.lang.Integer riskScore

New fraud score representing the estimated probability that the order is fraud, based off of analysis of past minFraud transactions.

riskExplanation

private java.lang.String riskExplanation

A brief explanation of the score, detailing what factors contributed to it, according to our formula

Constructor Detail

CaptureInfo

CaptureInfo()

Instantiates a new capture info.

CaptureInfo

CaptureInfo(java.util.Date requestDate,
            java.util.Date responseDate,
            java.lang.String holderName,
            java.lang.Integer taxAmount,
            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 returnType,
            java.lang.String approvalCode,
            java.lang.String referenceNumber,
            java.lang.Integer merchantAccountCode,
            java.lang.String accountNumber,
            java.lang.String accessory,
            java.lang.String code,
            java.lang.String transactionType,
            java.lang.Long id)

Instantiates a new capture info.

Parameters:

requestDate - the request date

responseDate - the response date

holderName - the holder name

taxAmount - the tax amount

street - the street

city - the city

state - the state

phone - the phone

zipCode - the zip code

email - the email

returnType - the return type

approvalCode - the approval code

referenceNumber - the reference number

merchantAccountCode - the merchant account code

accountNumber - the account number

accessory - the accessory

code - the code

transactionType - the transaction type

id - the id

Method Detail

getRequestDate

public java.util.Date getRequestDate()

Gets the request date.

Returns:

Returns the requestDate

setRequestDate

void setRequestDate(java.util.Date requestDate)

Set a value to requestDate.

Parameters:

requestDate - the request date

getResponseDate

public java.util.Date getResponseDate()

Gets the response date.

Returns:

Returns the responseDate

setResponseDate

void setResponseDate(java.util.Date responseDate)

Set a value to responseDate.

Parameters:

responseDate - the response date

getHolderName

public java.lang.String getHolderName()

Gets the holder name.

Returns:

Returns the holderName

setHolderName

public void setHolderName(java.lang.String holderName)

Set a value to holderName.

Parameters:

holderName - the holder name

getTaxAmount

public java.lang.Integer getTaxAmount()

Gets the tax amount.

Returns:

Returns the taxAmount

setTaxAmount

void setTaxAmount(java.lang.Integer taxAmount)

Set a value to taxAmount.

Parameters:

taxAmount - the tax amount

getStreet

public java.lang.String getStreet()

Gets the street.

Returns:

Returns the street

setStreet

public void setStreet(java.lang.String street)

Set a value to street.

Parameters:

street - the street

getCity

public java.lang.String getCity()

Gets the city.

Returns:

Returns the city

setCity

public void setCity(java.lang.String city)

Set a value to city.

Parameters:

city - the city

getState

public java.lang.String getState()

Gets the state.

Returns:

Returns the state

setState

public void setState(java.lang.String state)

Set a value to state.

Parameters:

state - the state

getPhone

public java.lang.String getPhone()

Gets the phone.

Returns:

Returns the phone

setPhone

public void setPhone(java.lang.String phone)

Set a value to phone.

Parameters:

phone - the phone

getZipCode

public java.lang.String getZipCode()

Gets the zip code.

Returns:

Returns the zipCode

setZipCode

public void setZipCode(java.lang.String zipCode)

Set a value to zipCode.

Parameters:

zipCode - the zip code

getEmail

public java.lang.String getEmail()

Gets the email.

Returns:

Returns the email

setEmail

public void setEmail(java.lang.String email)

Set a value to email.

Parameters:

email - the email

getReturnType

public java.lang.String getReturnType()

Gets the return type.

Returns:

Returns the type

setReturnType

void setReturnType(java.lang.String returnType)

Set a value to type.

Parameters:

returnType - the type

getApprovalCode

public java.lang.String getApprovalCode()

Gets the approval code.

Returns:

Returns the approvalCode

setApprovalCode

void setApprovalCode(java.lang.String approvalCode)

Set a value to approvalCode.

Parameters:

approvalCode - the approval code

getReferenceNumber

public java.lang.String getReferenceNumber()

Gets the reference number.

Returns:

Returns the referenceNumber

setReferenceNumber

void setReferenceNumber(java.lang.String referenceNumber)

Set a value to referenceNumber.

Parameters:

referenceNumber - the reference number

getAccountNumber

public java.lang.String getAccountNumber()

Gets the account number.

Returns:

Returns the accountNumber

setAccountNumber

void setAccountNumber(java.lang.String accountNumber)

Set a value to assetNumber.

Parameters:

accountNumber - the account number

getAccessory

public java.lang.String getAccessory()

Gets the accessory.

Returns:

Returns the accessory

setAccessory

void setAccessory(java.lang.String accessory)

Set a value to accessory.

Parameters:

accessory - the accessory

getCvv2

public java.lang.String getCvv2()

Gets the cvv2.

Returns:

the cvv2

setCvv2

public void setCvv2(java.lang.String cvv2)

Sets the cvv2.

Parameters:

cvv2 - the new cvv2

getTrackData

public java.lang.String getTrackData()

Gets the track data.

Returns:

the track data

setTrackData

public void setTrackData(java.lang.String trackData)

Sets the track data.

Parameters:

trackData - the new track data

getTransactionType

public java.lang.String getTransactionType()

Gets the transaction type.

Returns:

the transaction type

setTransactionType

void setTransactionType(java.lang.String transactionType)

Sets the transaction type.

Parameters:

transactionType - the new transaction type

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.

Specified by:

type in class ClientObject

Returns:

the type of the client object

getIssuerBankName

public java.lang.String getIssuerBankName()

Gets the issuer bank name.

Returns:

the issuer bank name

setIssuerBankName

public void setIssuerBankName(java.lang.String issuerBankName)

Sets the issuer bank name.

Parameters:

issuerBankName - the new issuer bank name

getIssuerBankPhone

public java.lang.String getIssuerBankPhone()

Gets the issuer bank phone.

Returns:

the issuer bank phone

setIssuerBankPhone

public void setIssuerBankPhone(java.lang.String issuerBankPhone)

Sets the issuer bank phone.

Parameters:

issuerBankPhone - the new issuer bank phone

getRiskScore

public java.lang.Integer getRiskScore()

Gets the risk score.

Returns:

the risk score

setRiskScore

public void setRiskScore(java.lang.Integer riskScore)

Sets the risk score.

Parameters:

riskScore - the new risk score

getRiskExplanation

public java.lang.String getRiskExplanation()

Gets the risk explanation.

Returns:

the risk explanation

setRiskExplanation

public void setRiskExplanation(java.lang.String riskExplanation)

Sets the risk explanation.

Parameters:

riskExplanation - the risk explanation