ibilling.client
Class PaymentOption

java.lang.Object
  ibilling.client.ClientObject
      ibilling.client.PaymentOption

All Implemented Interfaces:

java.io.Serializable

public class PaymentOption
extends ClientObject

Represents a form of payment that can be used in recurring billing process. Two forms of payments are available - Credit Card (CC) and Bank Account (EFT/ACH)

Since:

1.0

See Also:

Serialized Form

Field Summary

private java.lang.String	accessory Expiration Date (MMYY) for Credit Card; Routing number for Bank Account
private java.lang.String	city city of billing address
private java.lang.String	countryType Billing country
private CustomerAccount	customerAccount Reference to the CustomerAccount - owner of the card
private java.lang.String	cvv2 Value of cvv2 code, used only for processing and is not saved
private java.lang.String	holderName Name of the card or bank account
private java.lang.Boolean	isActive indicates if the payment option is active for billing
private java.lang.String	issue Any billing related issue that the payment option may have due to decline
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.util.Date	lastUpdateDate date when the payment option was last updated
private java.lang.String	maskedAccessory Masked version of accessory
private java.lang.String	maskedNumber Masked version of number e.g.
private java.lang.String	number Credit Card's/Bank Account's number
private static long	serialVersionUID The Constant serialVersionUID.
private java.lang.String	state state of billing address
private java.lang.String	street1 street1 of billing address
private java.lang.String	street2 street2 of billing address
private java.lang.String	type type of payment option see PaymentOptionType
private java.lang.String	zipCode zip code of billing address

Constructor Summary

PaymentOption()
Instantiates a new payment option.

PaymentOption(java.lang.String code, java.util.Date createDate, java.lang.Boolean isActive, java.lang.String holderName, java.lang.String number, java.lang.String accessory, java.lang.String street1, java.lang.String street2, java.lang.String city, java.lang.String state, java.lang.String zipCode, java.lang.String type, java.lang.Integer merchantAccountCode, java.util.Date lastUpdateDate, CustomerAccount customerAccount, java.lang.String issue, java.lang.Long id, java.lang.String maskedNumber, java.lang.String maskedAccessory)
Instantiates a new payment option.

Method Summary

void	clearIssue() Clears the value of the issue field.
java.lang.String	getAccessory() Gets the accessory.
java.lang.String	getCity() Gets the city.
java.lang.String	getCountryType() Gets the country type.
CustomerAccount	getCustomerAccount() Gets the customer account.
java.lang.String	getCvv2() Gets the cvv2 - will return null on any object returned from server
java.lang.String	getHolderName() Gets the holder name.
java.lang.Boolean	getIsActive() Gets the is active.
java.lang.String	getIssue() Gets the issue.
java.lang.String	getIssuerBankName() Gets the issuer bank name.
java.lang.String	getIssuerBankPhone() Gets the issuer bank phone.
java.util.Date	getLastUpdateDate() Gets the last update date.
java.lang.String	getMaskedAccessory() Gets the masked accessory.
java.lang.String	getMaskedNumber() Gets the masked number.
java.lang.String	getNumber() Gets the number.
java.lang.String	getState() Gets the state.
java.lang.String	getStreet1() Gets the street.
java.lang.String	getStreet2() Gets the street2.
java.lang.String	getType() Gets the type.
java.lang.String	getZipCode() Gets the zip code.
void	setAccessory(java.lang.String accessory) Set a value to accessory.
void	setCity(java.lang.String city) Set a value to city.
void	setCountryType(java.lang.String countryType) Sets the country type.
(package private) void	setCustomerAccount(CustomerAccount customerAccount) Sets the customer account.
void	setCvv2(java.lang.String cvv2) Sets the cvv2.
void	setHolderName(java.lang.String holderName) Set a value to holderName.
void	setIsActive(java.lang.Boolean isActive) Set a value to isActive.
void	setIssue(java.lang.String issue) Sets the issue.
void	setIssuerBankName(java.lang.String issuerBankName) Sets the issuer bank name.
void	setIssuerBankPhone(java.lang.String issuerBankPhone) Sets the issuer bank phone.
(package private) void	setLastUpdateDate(java.util.Date lastUpdateDate) Sets the last update date.
(package private) void	setMaskedAccessory(java.lang.String maskedAccessory) Sets the masked accessory.
(package private) void	setMaskedNumber(java.lang.String maskedNumber) Sets the masked number.
void	setNumber(java.lang.String number) Set a value to number.
void	setState(java.lang.String state) Set a value to state.
void	setStreet1(java.lang.String street1) Set a value to street.
void	setStreet2(java.lang.String street2) Set a value to street2.
void	setType(java.lang.String type) Set a value to 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

isActive

private java.lang.Boolean isActive

indicates if the payment option is active for billing

holderName

private java.lang.String holderName

Name of the card or bank account

number

private java.lang.String number

Credit Card's/Bank Account's number

accessory

private java.lang.String accessory

Expiration Date (MMYY) for Credit Card; Routing number for Bank Account

street1

private java.lang.String street1

street1 of billing address

street2

private java.lang.String street2

street2 of billing address

city

private java.lang.String city

city of billing address

state

private java.lang.String state

state of billing address

zipCode

private java.lang.String zipCode

zip code of billing address

type

private java.lang.String type

type of payment option see PaymentOptionType

lastUpdateDate

private java.util.Date lastUpdateDate

date when the payment option was last updated

issue

private java.lang.String issue

Any billing related issue that the payment option may have due to decline

cvv2

private java.lang.String cvv2

Value of cvv2 code, used only for processing and is not saved

maskedNumber

private java.lang.String maskedNumber

Masked version of number e.g. xxxx1234; shows last 4 digits

maskedAccessory

private java.lang.String maskedAccessory

Masked version of accessory

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.

countryType

private java.lang.String countryType

Billing country

customerAccount

private CustomerAccount customerAccount

Reference to the CustomerAccount - owner of the card

Constructor Detail

PaymentOption

PaymentOption()

Instantiates a new payment option.

PaymentOption

PaymentOption(java.lang.String code,
              java.util.Date createDate,
              java.lang.Boolean isActive,
              java.lang.String holderName,
              java.lang.String number,
              java.lang.String accessory,
              java.lang.String street1,
              java.lang.String street2,
              java.lang.String city,
              java.lang.String state,
              java.lang.String zipCode,
              java.lang.String type,
              java.lang.Integer merchantAccountCode,
              java.util.Date lastUpdateDate,
              CustomerAccount customerAccount,
              java.lang.String issue,
              java.lang.Long id,
              java.lang.String maskedNumber,
              java.lang.String maskedAccessory)

Instantiates a new payment option.

Parameters:

code - the code

createDate - the create date

isActive - the is active

holderName - the holder name

number - the number

accessory - the accessory

city - the city

state - the state

zipCode - the zip code

type - the type

merchantAccountCode - the merchant account code

lastUpdateDate - the last update date

customerAccount - the customer account

issue - the issue

id - the id

maskedNumber - the masked number

maskedAccessory - the masked accessory

street1 - the street1

street2 - the street2

Method Detail

getIsActive

public java.lang.Boolean getIsActive()

Gets the is active.

Returns:

Returns the isActive

setIsActive

public void setIsActive(java.lang.Boolean isActive)

Set a value to isActive.

Parameters:

isActive - the is active

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

getNumber

public java.lang.String getNumber()

Gets the number.

Returns:

Returns the number

setNumber

public void setNumber(java.lang.String number)

Set a value to number.

Parameters:

number - the 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

getStreet1

public java.lang.String getStreet1()

Gets the street.

Returns:

Returns the street1

setStreet1

public void setStreet1(java.lang.String street1)

Set a value to street.

Parameters:

street1 - the street1

getStreet2

public java.lang.String getStreet2()

Gets the street2.

Returns:

Returns the street2

setStreet2

public void setStreet2(java.lang.String street2)

Set a value to street2.

Parameters:

street2 - the street2

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

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

getType

public java.lang.String getType()

Gets the type.

Returns:

Returns the type

setType

public void setType(java.lang.String type)

Set a value to type.

Parameters:

type - the type

getCustomerAccount

public CustomerAccount getCustomerAccount()

Gets the customer account.

Returns:

the customer account

setCustomerAccount

void setCustomerAccount(CustomerAccount customerAccount)

Sets the customer account.

Parameters:

customerAccount - the new customer account

getLastUpdateDate

public java.util.Date getLastUpdateDate()

Gets the last update date.

Returns:

the last update date

setLastUpdateDate

void setLastUpdateDate(java.util.Date lastUpdateDate)

Sets the last update date.

Parameters:

lastUpdateDate - the new last update date

getIssue

public java.lang.String getIssue()

Gets the issue.

Returns:

the issue

setIssue

public void setIssue(java.lang.String issue)

Sets the issue.

Parameters:

issue - the new issue

clearIssue

public void clearIssue()

Clears the value of the issue field. Use this method rather than setIssue with null/empty value

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

getCvv2

public java.lang.String getCvv2()

Gets the cvv2 - will return null on any object returned from server

Returns:

the cvv2

setCvv2

public void setCvv2(java.lang.String cvv2)

Sets the cvv2.

Parameters:

cvv2 - the new cvv2

getMaskedNumber

public java.lang.String getMaskedNumber()

Gets the masked number.

Returns:

the masked number

setMaskedNumber

void setMaskedNumber(java.lang.String maskedNumber)

Sets the masked number.

Parameters:

maskedNumber - the new masked 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

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

getCountryType

public java.lang.String getCountryType()

Gets the country type.

Returns:

the country type

setCountryType

public void setCountryType(java.lang.String countryType)

Sets the country type.

Parameters:

countryType - the new country type