Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

Serialized Form

Package ibilling.client

Class ibilling.client.AccountActivity extends ClientObject implements Serializable

serialVersionUID: -3302645720062437670L

Serialized Fields

accountActivityType

java.lang.String accountActivityType

Type of activity, e.g. invoice, payment

customerAccount

CustomerAccount customerAccount

Reference to the CustomerAccount affected by this activity.

Class ibilling.client.AccountTransaction extends AccountActivity implements Serializable

serialVersionUID: -4395766924205273958L

Serialized Fields

amount

java.lang.Integer amount

Initial (fixed) amount of the transaction.

balance

java.lang.Integer balance

Current balance of the transaction.

note

java.lang.String note

Optional text note (description).

creatorCode

java.lang.String creatorCode

Optional free-hand code, can be used to identify creator of the transaction (usually in external client system).

sellerCode

java.lang.String sellerCode

Optional free-hand code, can be used to identify seller associated with the transaction (usually in external client system).

shiftCode

java.lang.String shiftCode

Optional free-hand code, can be used to identify POS shift that generated this transaction (usually in external client system).

terminalCode

java.lang.String terminalCode

Optional free-hand code, can be used to identify POS terminal that generated this transaction (usually in external client system).

taxAmount

java.lang.Integer taxAmount

Amount of the tax (part of amount).

dueDate

java.util.Date dueDate

Date when the transaction becomes effective (applied to CustomerAccount). Before the due date, iBilling's balancing process will not apply any balance on the transaction

adjustmentTransaction

AccountTransaction adjustmentTransaction

Reference to a transaction that reversed this transaction. Normally, Invoice or Fee can be reversed with Reversal, Payment or Claim with Void or Decline

Class ibilling.client.Adjustment extends ClientObject implements Serializable

serialVersionUID: -6583392741177189125L

Serialized Fields

notes

java.lang.String notes

Textual description of the adjustment reasons.

adjustmentReasonCode

java.lang.String adjustmentReasonCode

Predefined code explaining the reason for the changes.

customerAccount

CustomerAccount customerAccount

Reference to CustomerAccount that owns the plans affected by the change.

Class ibilling.client.AssetTransaction extends AccountTransaction implements Serializable

serialVersionUID: -8744789535540570615L

Serialized Fields

transactionType

java.lang.String transactionType

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

isPrepayment

java.lang.Boolean isPrepayment

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

accountNumber

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

java.lang.String accessory

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

maskedAccountNumber

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

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

CaptureInfo captureInfo

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

Class ibilling.client.CaptureInfo extends ClientObject implements Serializable

serialVersionUID: 2261945114816642178L

Serialized Fields

requestDate

java.util.Date requestDate

Date when the request was sent to processor.

responseDate

java.util.Date responseDate

Date when the response from the processor was received.

holderName

java.lang.String holderName

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

taxAmount

java.lang.Integer taxAmount

Tax amount if available (part of total amount).

street

java.lang.String street

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

city

java.lang.String city

City of the billing address.

state

java.lang.String state

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

phone

java.lang.String phone

Phone of the billing address.

zipCode

java.lang.String zipCode

ZipCode of the billing address.

email

java.lang.String email

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

returnType

java.lang.String returnType

Code defining response type generated by the processor.

issuerBankName

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

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

java.lang.String approvalCode

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

referenceNumber

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

java.lang.String accountNumber

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

accessory

java.lang.String accessory

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

transactionType

java.lang.String transactionType

Type of the transaction.

cvv2

java.lang.String cvv2

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

trackData

java.lang.String trackData

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

riskScore

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

java.lang.String riskExplanation

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

Class ibilling.client.Charge extends ClientObject implements Serializable

serialVersionUID: 7087153549490237756L

Serialized Fields

processedDate

java.util.Date processedDate

Date when the charge was processed by the invoicing process.

isPrepaid

java.lang.Boolean isPrepaid

If true, payment was taken against this charge. This doesn't guarantee that the invoice created from this charge will be automatically paid

type

java.lang.String type

TYpe of charge.

index

java.lang.Integer index

Sequential number of the charge within PaymentPlan. 0 indicates that the charge will be processed in the next billing process, 1 - the one after the next and so on

paymentPlan

PaymentPlan paymentPlan

Reference to the PaymentPlan holding the charges.

Class ibilling.client.ClientException extends ibilling.services.iBillingException implements Serializable

serialVersionUID: -4526627275705402675L

Class ibilling.client.ClientObject extends java.lang.Object implements Serializable

Serialized Fields

id

java.lang.Long id

System generated identifier.

createDate

java.util.Date createDate

Date the transaction was created.

code

java.lang.String code

User assigned identifier. (if not specified, id is used)

merchantAccountCode

java.lang.Integer merchantAccountCode

Merchant account code.

refId

java.lang.Integer refId

Class ibilling.client.CustomerAccount extends ClientObject implements Serializable

serialVersionUID: -4339921470390878685L

Serialized Fields

firstName

java.lang.String firstName

If person - first name, not used otherwise.

lastName

java.lang.String lastName

If person - last name, if organization - organization's name.

middleName

java.lang.String middleName

If person - middle name, not used otherwise.

title

java.lang.String title

If person - title, not used otherwise.

suffix

java.lang.String suffix

If person - suffix, not used otherwise.

type

java.lang.String type

Type of the account.

isActive

java.lang.Boolean isActive

If false, account has no active payment option or payment plans.

homePhone

java.lang.String homePhone

Home phone number.

workPhone

java.lang.String workPhone

Work phone number/contact number if organization.

cellPhone

java.lang.String cellPhone

Cell phone number.

email

java.lang.String email

Contact e-mail.

street1

java.lang.String street1

Street1 of the address.

street2

java.lang.String street2

Street2 of the address.

city

java.lang.String city

City of the address.

state

java.lang.String state

State of the address.

zipCode

java.lang.String zipCode

Zip code of the address.

countryType

java.lang.String countryType

Billing country

balance

java.lang.Integer balance

Current balance on the account.

beneficiaryInfo

java.lang.String beneficiaryInfo

Buyer's information (if somebody else is responsible for payments). Contains full name and contact info

customerAccountGroupCode

java.lang.String customerAccountGroupCode

Predefined classification code for this account (to simplify searching/reporting).

isVerified

java.lang.Boolean isVerified

Not Used. Reserved for future use.

notes

java.lang.String notes

Any notes associated with the account.

lastUpdateDate

java.util.Date lastUpdateDate

Last time the account was updated.

birthDate

java.util.Date birthDate

If person - date of birth, not used otherwise.

paymentOptions

java.util.List<E> paymentOptions

List of payment options associated with this CustomerAccount.

revenueTransactions

java.util.List<E> revenueTransactions

List of RevenueTransactions associated with this CustomerAccount.

assetTransactions

java.util.List<E> assetTransactions

List of AssetTransctions associated with this CustomerAccount.

paymentPlans

java.util.List<E> paymentPlans

List of PaymentPlans associated with this CustomerAccount.

Class ibilling.client.PaymentOption extends ClientObject implements Serializable

serialVersionUID: 5627714218319491069L

Serialized Fields

isActive

java.lang.Boolean isActive

indicates if the payment option is active for billing

holderName

java.lang.String holderName

Name of the card or bank account

number

java.lang.String number

Credit Card's/Bank Account's number

accessory

java.lang.String accessory

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

street1

java.lang.String street1

street1 of billing address

street2

java.lang.String street2

street2 of billing address

city

java.lang.String city

city of billing address

state

java.lang.String state

state of billing address

zipCode

java.lang.String zipCode

zip code of billing address

type

java.lang.String type

type of payment option see PaymentOptionType

lastUpdateDate

java.util.Date lastUpdateDate

date when the payment option was last updated

issue

java.lang.String issue

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

cvv2

java.lang.String cvv2

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

maskedNumber

java.lang.String maskedNumber

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

maskedAccessory

java.lang.String maskedAccessory

Masked version of accessory

issuerBankName

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

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

java.lang.String countryType

Billing country

customerAccount

CustomerAccount customerAccount

Reference to the CustomerAccount - owner of the card

Class ibilling.client.PaymentPlan extends ClientObject implements Serializable

serialVersionUID: -4127776002809639034L

Serialized Fields

lastInvoicingDate

java.util.Date lastInvoicingDate

the date when the invoice for this plan was last created

lastProcessingDate

java.util.Date lastProcessingDate

the date when this plan was processed by Invoicing Service for the last time. The invoice may or may not have been created on the day (not created in case of deferment or freeze)

sellerCode

java.lang.String sellerCode

optional code identifying the plan's seller in the external system

length

java.lang.Integer length

current length of the payment plan (for perpetual and complimentary plans, the length will be derived from the forecasting period (see FAQ)

value

java.lang.Integer value

length multiplied by amount

deferredLength

java.lang.Integer deferredLength

current total length of deferred charges or freezes included in the plan

deferredValue

java.lang.Integer deferredValue

deferredLength multiplied by amount

amount

java.lang.Integer amount

Amount of a single payment represented by the plan