Merchant UML


Added On:  03/16/12 
SQL Table:  IAPP_MERCHANT 
Module:  UniCore 
Type:  Entity  Status:  Active 
Java Class:  Merchant 
Represents a Merchant that processes transactions through the system.
Available Fields:
Added On:  03/16/12
SQL Column:  CODE
Java Field:  code
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Identifier / Primary Key
Attributes: Unique, Required
Unique identifier of the merchant generated by the gateway.
Added On:  03/16/12
SQL Column:  REF_CODE
Java Field:  refCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Optional identifier of the Merchant that can be used to cross-reference the Merchant record between multiple systems.

See Reference Code definition for additional information.
Added On:  03/16/12
SQL Column:  NAME
Java Field:  name
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
The DBA name of the merchant.
Added On:  03/16/12
SQL Column:  CREATE_DATE
Java Field:  createDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the record was created.
Added On:  03/16/12
SQL Column:  IS_ACTIVE
Java Field:  isActive
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether the record is active and can process through the system.
Added On:  03/16/12
SQL Column:  NOTES
Java Field:  notes
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Provides a place to store short generic notes about the merchant.
Added On:  03/16/12
SQL Column:  PROCESSING_SERVER
Java Field:  processingServer
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Transaction processing server.
Added On:  03/16/12
SQL Column:  PROCESSING_PASSWORD
Java Field:  processingPassword
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes: Required
Merchant's password for transaction processing API. This value in combination with Merchant Code serves as a set of credentials to authenticate the submitter of a transaction.
Added On:  03/16/12
SQL Column:  IBILLING_FORECASTING_PERIOD
Java Field:  ibillingForecastingPeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Period in months for which forecasting data needs to be available within the system.

Forecasting data shows expected recurring billing revenue projected in time in the future. A value of 12 in this field indicates that the system will provide projections for up to 12 months.
Added On:  03/16/12
SQL Column:  CONTACT_NAME
Java Field:  contactName
Status:  Active
SQL Type:  varchar(80)
Java Type:  String
Attributes:
Name of the primary business contact for the merchant.
Added On:  03/16/12
SQL Column:  STREET1
Java Field:  street1
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Street address (line 1) of the Merchant's postal address.
Added On:  03/16/12
SQL Column:  STREET2
Java Field:  street2
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Street address (line 2) of the Merchant's postal address.
Added On:  03/16/12
SQL Column:  CITY
Java Field:  city
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
City of the Merchant's postal address.
Added On:  03/16/12
SQL Column:  STATE
Java Field:  state
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
State of the Merchant's postal address.
Added On:  03/16/12
SQL Column:  ZIP_CODE
Java Field:  zipCode
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
ZIP code of Merchant's postal address.
Added On:  03/16/12
SQL Column:  PHONE
Java Field:  phone
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Merchant's contact phone.
Added On:  03/16/12
SQL Column:  FAX
Java Field:  fax
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Merchant's fax number.
Added On:  03/16/12
SQL Column:  EMAIL
Java Field:  email
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Merchant's contact email.

This value is used to send remittance statements.
Added On:  03/16/12
SQL Column:  MERCHANT_CL
Java Field:  merchantCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
References Merchant Classifier
Attributes:
Represents the type of merchant from the standpoint of the number of merchant accounts that it uses.
Added On:  03/16/12
SQL Column:  MERCHANT_NATURE_CL
Java Field:  merchantNatureCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the type of this merchant record.
Added On:  03/16/12
SQL Column:  CONFIRM_EMAILS
Java Field:  confirmEmails
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes:
Flag controlling whether or a customer's confirmation is required on an email address to consider it valid.

When set to true, any email submitted into the system for a given customer will be disabled by default and will receive a message with a verification link. Once a customer clicks on the link, the email address gets validated and can be used for processing.

The feature is useful for cases when it is absolutely necessary to ensure that the email on customer's record is valid.

UniBill only.
Added On:  03/16/12
SQL Column:  IS_UPDATE_ROUTING_NUMBERS
Java Field:  isUpdateRoutingNumbers
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes:
Controls whether or not routing number updates received from the Federal Reserve System are passed back to the merchant.
Added On:  03/16/12
SQL Column:  STATEMENT_STREET1
Java Field:  statementStreet1
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Street address (line 1) of merchant's postal address that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_STREET2
Java Field:  statementStreet2
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Street address (line 2) of merchant's postal address that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_CITY
Java Field:  statementCity
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
City of merchant's postal address that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_STATE
Java Field:  statementState
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
State of merchant's postal address that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_ZIP_CODE
Java Field:  statementZipCode
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Zip code of merchant's postal address that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_PHONE
Java Field:  statementPhone
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Merchant's phone that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_EMAIL
Java Field:  statementEmail
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Merchant's email that should be used on a printed statement.
Added On:  03/16/12
SQL Column:  STATEMENT_MAIL_NAME
Java Field:  statementMailName
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Merchant's mail name that should be used on a printed statement
Added On:  03/16/12
SQL Column:  STATEMENT_HEADER_MESSAGE
Java Field:  statementHeaderMessage
Status:  Active
SQL Type:  varchar(2048)
Java Type:  String
Attributes:
Header message of the merchant statement.
Added On:  03/16/12
SQL Column:  STATEMENT_FOOTER_MESSAGE
Java Field:  statementFooterMessage
Status:  Active
SQL Type:  varchar(2048)
Java Type:  String
Attributes:
Footer message of the merchant statement.
Added On:  03/16/12
SQL Column:  CC_CHARGE_FEE
Java Field:  ccChargeFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Credit card charge fee amount.
Added On:  03/16/12
SQL Column:  CC_CHARGE_SHARE
Java Field:  ccChargeShare
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Credit card charge fee amount.
Added On:  03/16/12
SQL Column:  CC_RETURN_FEE
Java Field:  ccReturnFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to returns associated with merchant's credit card.
Added On:  03/16/12
SQL Column:  CC_CREDIT_FEE
Java Field:  ccCreditFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to credit transactions associated with merchant's credit card.
Added On:  03/16/12
SQL Column:  CC_CHARGEBACK_FEE
Java Field:  ccChargebackFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to chargebacks associated with merchant's credit card.
Added On:  03/16/12
SQL Column:  EFT_CHARGE_FEE
Java Field:  eftChargeFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee associated with merchant's credit card.
Added On:  03/16/12
SQL Column:  EFT_CHARGE_SHARE
Java Field:  eftChargeShare
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Processor's fee share associated with merchant's credit card.
Added On:  03/16/12
SQL Column:  EFT_RETURN_FEE
Java Field:  eftReturnFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to returns associated with merchant's EFT card.
Added On:  03/16/12
SQL Column:  EFT_CREDIT_FEE
Java Field:  eftCreditFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to credit transactions associated with merchant's EFT card.
Added On:  03/16/12
SQL Column:  LETTER_FEE
Java Field:  letterFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to letters.
Added On:  03/16/12
SQL Column:  EMAIL_FEE
Java Field:  emailFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to emails.
Added On:  03/16/12
SQL Column:  CALL_FEE
Java Field:  callFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee applied to phone calls.
Added On:  03/16/12
SQL Column:  COLLECTIONS1ST_FEE
Java Field:  collections1stFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fixed amount (per item) commission paid to an agent who managed to collect a debt on a customer account in 1st party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS1ST_SHARE
Java Field:  collections1stShare
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Percentage of a payment collected, paid as a commission to an agent who managed to collect balance on an account in the 1st party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS3RD_FEE
Java Field:  collections3rdFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fixed amount (per item) commission paid to an agent who managed to collect a debt on a customer account in 3st party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS3RD_SHARE
Java Field:  collections3rdShare
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Percentage of a payment collected, paid as a commission to an agent who managed to collect balance on an account in the 1st party collections.
Added On:  03/16/12
SQL Column:  DECLINE_LIMIT
Java Field:  declineLimit
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
UniBill only.
The number of soft declines allowed before the payment option is deactivated.
Added On:  03/16/12
SQL Column:  DOCUMENT_ACCESS_FEE
Java Field:  documentAccessFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, which is charged for accessing documents within a membership portal (for example, electronic libraries documents).
Added On:  03/16/12
SQL Column:  DOCUMENT_ACCESS_INTERVAL
Java Field:  documentAccessInterval
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Time period for which access to a document will be allowed.
Added On:  03/16/12
SQL Column:  CUSTOMER_SOFT_DECLINE_FEE
Java Field:  customerSoftDeclineFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, applied to the customer's account when a soft decline occurs.
Added On:  03/16/12
SQL Column:  CUSTOMER_HARD_DECLINE_FEE
Java Field:  customerHardDeclineFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, applied to the customer's account when a hard decline occurs.
Added On:  03/16/12
SQL Column:  CUSTOMER_CHARGEBACK_FEE
Java Field:  customerChargebackFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, applied to the customer's account when a chargeback occurs.
Added On:  03/16/12
SQL Column:  CUSTOMER_FREEZE_FEE
Java Field:  customerFreezeFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, applied to the customer account when the payment plan is put on freeze.
Added On:  03/16/12
SQL Column:  CUSTOMER_LATE_FEE
Java Field:  customerLateFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, applied to the customer's account if a payment was not collected on time.
Added On:  03/16/12
SQL Column:  CUSTOMER_LATE_PERIOD
Java Field:  customerLatePeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Time period after which Late fee is applied to the customer's account (in case when the payment was not collected on time).
Added On:  03/16/12
SQL Column:  LETTER_CODE_WELCOME
Java Field:  letterCodeWelcome
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse that is sent when a new account is created.
Added On:  03/16/12
SQL Column:  LETTER_CODE_SOFT_DECLINE
Java Field:  letterCodeSoftDecline
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse when a soft decline occurs.
Added On:  03/16/12
SQL Column:  LETTER_CODE_HARD_DECLINE
Java Field:  letterCodeHardDecline
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse when a hard decline occurs.
Added On:  03/16/12
SQL Column:  LETTER_CODE_CHARGEBACK
Java Field:  letterCodeChargeback
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse when a chargeback occurs.
Added On:  03/16/12
SQL Column:  LETTER_CODE_STATEMENT
Java Field:  letterCodeStatement
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for a statement of the account.
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_CODE1
Java Field:  collectionsLetterCode1
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the first letter sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_CODE2
Java Field:  collectionsLetterCode2
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the second letter sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_CODE3
Java Field:  collectionsLetterCode3
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the third letter sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_CODE4
Java Field:  collectionsLetterCode4
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the fourth letter sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_CODE5
Java Field:  collectionsLetterCode5
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the fifth letter sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_AGE1
Java Field:  collectionsLetterAge1
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age1 is linked to Collections letter code1).
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_AGE2
Java Field:  collectionsLetterAge2
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age2 is linked to Collections letter code2).
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_AGE3
Java Field:  collectionsLetterAge3
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age3 is linked to Collections letter code3).
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_AGE4
Java Field:  collectionsLetterAge4
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age4 is linked to Collections letter code4).
Added On:  03/16/12
SQL Column:  COLLECTIONS_LETTER_AGE5
Java Field:  collectionsLetterAge5
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age5 is linked to Collections letter code5).
Added On:  03/16/12
SQL Column:  COLLECTIONS_PERIOD
Java Field:  collectionsPeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Period in days after which collections fees are applied.
Added On:  03/16/12
SQL Column:  COLLECTIONS_FEE
Java Field:  collectionsFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fixed fee amount, which is applied to the customer's account when it is sent to 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_SHARE
Java Field:  collectionsShare
Status:  Active
SQL Type:  float
Java Type:  Float
Attributes:
Percentage of the customer's account ballance, which is applied as a fee when the account is sent to 3rd party collections.
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_CODE
Java Field:  notificationLetterCode
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Notification Letter Code (Invoice)
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_PERIOD
Java Field:  notificationLetterPeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Period in days after which a notification letter is sent.
Added On:  03/16/12
SQL Column:  IS_DISALLOW_MULTIPLE_PAYMENT_PLANS
Java Field:  isDisallowMultiplePaymentPlans
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
UniBill only.
Indicates whether multiple payment plans are allowed on a single customer account.
Added On:  03/16/12
SQL Column:  RESOURCE_BUNDLE
Java Field:  resourceBundle
Status:  Active
SQL Type:  varchar(1024)
Java Type:  String
Attributes:
Stores values of the lables on the user interface that were renamed to accomodate merchant's specific business terminology. The values are stored using Properties format.
Added On:  03/16/12
SQL Column:  SKIP_TRACE_PERIOD
Java Field:  skipTracePeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Period in days during which two subsequent skiptraces will not be allowed. For example, if skip trace period is 60 days and the skiptrace is done on January 1st, another skiptrace on this account will not be allowed until March 1st.
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_CODE1
Java Field:  notificationLetterCode1
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the first notification letter sent to the customer in case the customer's account became delinquent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_CODE2
Java Field:  notificationLetterCode2
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the second notification letter sent to the customer in case the customer's account became delinquent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_CODE3
Java Field:  notificationLetterCode3
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a printhouse for the third notification letter sent to the customer in case the customer's account became delinquent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_AGE1
Java Field:  notificationLetterAge1
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age1 is linked to notification letter code1).
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_AGE2
Java Field:  notificationLetterAge2
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age2 is linked to notification letter code2).
Added On:  03/16/12
SQL Column:  NOTIFICATION_LETTER_AGE3
Java Field:  notificationLetterAge3
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age3 is linked to notification letter code3).
Added On:  03/16/12
SQL Column:  IS_LETTER_CODE_SOFT_DECLINE_STATEMENT
Java Field:  isLetterCodeSoftDeclineStatement
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether soft decline letter is a statement or not (statements contain data tables).
Added On:  03/16/12
SQL Column:  IS_LETTER_CODE_HARD_DECLINE_STATEMENT
Java Field:  isLetterCodeHardDeclineStatement
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether hard decline letter is a statement or not (statements contain data tables).
Added On:  03/16/12
SQL Column:  IS_LETTER_CODE_CHARGEBACK_STATEMENT
Java Field:  isLetterCodeChargebackStatement
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether chargeback letter is a statement or not (statements contain data tables).
Added On:  03/16/12
SQL Column:  PHASE2_AGE
Java Field:  phase2Age
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
The age of the debt in days at which customer account moves from the first collections phase into the second collections phase.

See Collections Phases for additional information.
Added On:  03/16/12
SQL Column:  PHASE3_AGE
Java Field:  phase3Age
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
The age of the debt in days at which customer account moves from the second collections phase into the third collections phase.

See Collections Phases for additional information.
Added On:  03/16/12
SQL Column:  PHASE4_AGE
Java Field:  phase4Age
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
The age of the debt in days at which customer account moves from the third collections phase into the fourth collections phase.

See Collections Phases for additional information.
Added On:  03/16/12
SQL Column:  PORTAL_DOCUMENT_UPLOAD_LIMIT
Java Field:  portalDocumentUploadLimit
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
UniBill only. The number of documents that a customer can upload through a self-service portal.
Added On:  03/16/12
SQL Column:  PORTAL_DOCUMENT_MAX_FILE_SIZE
Java Field:  portalDocumentMaxFileSize
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
UniBill only. The maximum size of a document that a customer can upload through a self-service portal.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_NUMBER
Java Field:  customerServiceNumber
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Phone number of the customer's service address.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_FAX
Java Field:  customerServiceFax
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Fax number of the customer's service address.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_STREET
Java Field:  customerServiceStreet
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Street of the customer's service address.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_CITY
Java Field:  customerServiceCity
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
City of the customer's service address.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_STATE
Java Field:  customerServiceState
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
State of the customer's service address.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_ZIP_CODE
Java Field:  customerServiceZipCode
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
ZIP/postal code of the customer's service address.
Added On:  03/16/12
SQL Column:  CUSTOMER_SERVICE_WORKING_HOURS
Java Field:  customerServiceWorkingHours
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Working hours of the customer's service.
Added On:  03/16/12
SQL Column:  IS_LATE_FEE_APPLIED_IN_COLLECTIONS
Java Field:  isLateFeeAppliedInCollections
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
UniBill only.
Indicates whether late fees are applied on accounts in 3rd party collections.
Added On:  03/16/12
SQL Column:  PRINCIPAL_AGENT_COMMISSION_SHARE
Java Field:  principalAgentCommissionShare
Status:  Active
SQL Type:  float
Java Type:  Float
Attributes:
Percentage of a payment collected against the invoice that is paid as a commission to an agent who managed to collect the payment.
Added On:  03/16/12
SQL Column:  LATE_FEE_AGENT_COMMISSION_SHARE
Java Field:  lateFeeAgentCommissionShare
Status:  Active
SQL Type:  float
Java Type:  Float
Attributes:
Percentage of a payment collected against late fee that is paid as a commission to an agent who managed to collect the payment.
Added On:  03/16/12
SQL Column:  RETURN_FEE_AGENT_COMMISSION_SHARE
Java Field:  returnFeeAgentCommissionShare
Status:  Active
SQL Type:  float
Java Type:  Float
Attributes:
Percentage of a payment collected against return fee that is paid as a commission to an agent who managed to collect the payment.
Added On:  03/16/12
SQL Column:  CREDIT_CARD_AGENT_COMMISSION_FEE
Java Field:  creditCardAgentCommissionFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fixed commission, paid to an agent who restored customer's account back to electronic draft using credit card.
Added On:  03/16/12
SQL Column:  BANK_ACCOUNT_AGENT_COMMISSION_FEE
Java Field:  bankAccountAgentCommissionFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fixed commission, paid to an agent who restored customer's account back to electronic draft using bank account.
Added On:  03/16/12
SQL Column:  AGENT_COMMISSION_AGE
Java Field:  agentCommissionAge
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Time period that fixed commission paid to an agent is relevant.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_WELCOME
Java Field:  emailCodeWelcome
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service that is sent when a new account is created.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_SOFT_DECLINE
Java Field:  emailCodeSoftDecline
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service that is sent when a soft decline occurs.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_HARD_DECLINE
Java Field:  emailCodeHardDecline
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service that is sent when a hard decline occurs.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_CHARGEBACK
Java Field:  emailCodeChargeback
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service that is sent when a chargeback occurs.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_STATEMENT
Java Field:  emailCodeStatement
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of a letter template set up with a mailing service for a statement of the account.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_INVOICE_NOTIFICATION
Java Field:  emailCodeInvoiceNotification
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, set up with a mailing service for invoice notification email.
Added On:  03/16/12
SQL Column:  EMAIL_INVOICE_NOTIFICATION_PERIOD
Java Field:  emailInvoiceNotificationPeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days after which invoice is created and notification email is sent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_EMAIL_CODE1
Java Field:  notificationEmailCode1
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the first notification email sent to the customer in case the customer's account became delinquent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_EMAIL_CODE2
Java Field:  notificationEmailCode2
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the second notification email sent to the customer in case the customer's account became delinquent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_EMAIL_CODE3
Java Field:  notificationEmailCode3
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the third notification email sent to the customer in case the customer's account became delinquent.
Added On:  03/16/12
SQL Column:  NOTIFICATION_EMAIL_AGE1
Java Field:  notificationEmailAge1
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age1 is linked to notification email code1).
Added On:  03/16/12
SQL Column:  NOTIFICATION_EMAIL_AGE2
Java Field:  notificationEmailAge2
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age2 is linked to notification email code2).
Added On:  03/16/12
SQL Column:  NOTIFICATION_EMAIL_AGE3
Java Field:  notificationEmailAge3
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age3 is linked to notification email code3).
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_CODE1
Java Field:  collectionsEmailCode1
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the first email sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_CODE2
Java Field:  collectionsEmailCode2
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the second email sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_CODE3
Java Field:  collectionsEmailCode3
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the third email sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_CODE4
Java Field:  collectionsEmailCode4
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the fourth email sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_CODE5
Java Field:  collectionsEmailCode5
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template set up with a mailing service for the fifth email sent to the customer from 3rd party collections.
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_AGE1
Java Field:  collectionsEmailAge1
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age1 is linked to Collections email code1).
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_AGE2
Java Field:  collectionsEmailAge2
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age2 is linked to Collections email code2).
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_AGE3
Java Field:  collectionsEmailAge3
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age3 is linked to Collections email code3).
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_AGE4
Java Field:  collectionsEmailAge4
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age4 is linked to Collections email code4).
Added On:  03/16/12
SQL Column:  COLLECTIONS_EMAIL_AGE5
Java Field:  collectionsEmailAge5
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age5 is linked to Collections email code5).
Added On:  03/16/12
SQL Column:  EMAIL_CODE_AGENT_PAYMENT
Java Field:  emailCodeAgentPayment
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when a payment is made through an agent portal.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_PORTAL_PAYMENT
Java Field:  emailCodePortalPayment
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when a payment is made through a self-service portal.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_DRAFT_PAYMENT
Java Field:  emailCodeDraftPayment
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when a payment is collected by an agent through self-service portal as part of electronic draft.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_INVOICE
Java Field:  emailCodeInvoice
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of email template, sent out when an invoice is created.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_CREDIT
Java Field:  emailCodeCredit
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when a credit is issued.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_CANCEL_CREDIT
Java Field:  emailCodeCancelCredit
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when a previously issued credit is reversed.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_LATE_FEE
Java Field:  emailCodeLateFee
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when late fee gets applied.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_REFUND
Java Field:  emailCodeRefund
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when refund occurs.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_CANCEL_REFUND
Java Field:  emailCodeCancelRefund
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when refund has been cancelled.
Added On:  03/16/12
SQL Column:  EMAIL_CODE_VOID
Java Field:  emailCodeVoid
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Code of an email template, sent out when void is done.
Added On:  03/16/12
SQL Column:  SOFT_DECLINE_WAIT_PERIOD_LETTER
Java Field:  softDeclineWaitPeriodLetter
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Wait period (in days) before soft decline letter is sent out.
Added On:  03/16/12
SQL Column:  SOFT_DECLINE_WAIT_PERIOD_EMAIL
Java Field:  softDeclineWaitPeriodEmail
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Wait period (in days) before soft decline email is sent out.
Added On:  03/16/12
SQL Column:  IS_REQUIRED_BALANCE_SOFT_DECLINE_LETTER
Java Field:  isRequiredBalanceSoftDeclineLetter
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether an account has to have outstanding balance for soft decline letter to come out.
Added On:  03/16/12
SQL Column:  IS_REQUIRED_BALANCE_SOFT_DECLINE_EMAIL
Java Field:  isRequiredBalanceSoftDeclineEmail
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether an account has to have outstanding balance for soft decline email to come out.
Added On:  03/16/12
SQL Column:  IS_KEEP_BAD_PHONES
Java Field:  isKeepBadPhones
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether bad phone numbers are kept on the account after skiptracing process completes.
Added On:  03/16/12
SQL Column:  TERMINAL_CUSTOMER_ACCOUNT_AGE
Java Field:  terminalCustomerAccountAge
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Age at which all of the payment plans of a customer get terminated.
Added On:  03/16/12
SQL Column:  TERMINAL_INVOICE_AGE
Java Field:  terminalInvoiceAge
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Age of a non-committed debt which cannot be reported to credit bureau, at which the outstanding debt is written off.
Added On:  03/16/12
SQL Column:  CREDIT_AGENCY_STATUS_CL
Java Field:  creditAgencyStatusCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the type of reporting status of the merchant within the credit bureau.
Added On:  03/16/12
SQL Column:  MIN_CREDIT_REPORTING_BALANCE
Java Field:  minCreditReportingBalance
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Minimum amount of debt that gets reported to a credit bureau.
Added On:  03/16/12
SQL Column:  NON_CREDIT_REPORTING_STATE_LIST
Java Field:  nonCreditReportingStateList
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
List of states for which credit reporting is not done.
Added On:  03/16/12
SQL Column:  CUSTOMER_LEVEL_CL
Java Field:  customerLevelCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the type of customer's level based on the application usage.
Added On:  03/16/12
SQL Column:  IS_PROCESS_SCHEDULED_PAYMENT_DECLINE
Java Field:  isProcessScheduledPaymentDecline
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether decline fees are assessed for declines coming from scheduled payments.
Added On:  03/16/12
SQL Column:  IS_REVERSE_CHARGEBACK_FEE
Java Field:  isReverseChargebackFee
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether chargeback fees are reversed when chargebacks are reversed.
Added On:  03/16/12
SQL Column:  IS_BATCH_REVIEW_REQUIRED
Java Field:  isBatchReviewRequired
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether the explicit approval of a user is required to process a batch, submitted into UniCharge.
Added On:  03/16/12
SQL Column:  RETURNS_CALLBACK_URL
Java Field:  returnsCallbackUrl
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
URL of a page, where returns and chargebacks are delivered as they are loaded into the system.
Added On:  03/16/12
SQL Column:  SUBMISSIONS_CALLBACK_URL
Java Field:  submissionsCallbackUrl
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
URL of a page, where status of a submission (batch) is delivered.
Added On:  03/16/12
SQL Column:  ACCOUNT_UPDATER_PERIOD
Java Field:  accountUpdaterPeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of days from the last account update that have to pass before the next account update is done.
Added On:  03/16/12
SQL Column:  IS_MERCHANT_STATEMENT_REVIEW_REQUIRED
Java Field:  isMerchantStatementReviewRequired
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether an explicit approval is required before merchant statement is processed.
Added On:  03/16/12
SQL Column:  IS_RESELLER_STATEMENT_REVIEW_REQUIRED
Java Field:  isResellerStatementReviewRequired
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether an explicit approval is required before reseller statement is processed.
Added On:  03/16/12
SQL Column:  MERCHANT_CONFIGURATOR
Java Field:  merchantConfigurator
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Identifier of the associated configuration that is used for creation of profiles list.
Added On:  03/16/12
SQL Column:  PROCESSING_CUTOFF
Java Field:  processingCutoff
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: Default:24
Shows the time of the day that marks the end of the business day.
This time is set according to the server time zone but should be adjusted for merchant/merchant account individually, if needed. For example, if server time zone is set as EST but a particular merchant/merchant account operates according to PST, the cutoff time setting should be set as 3 AM, in case if cutoff processing time should occur at midnight.
Any transactions processed before this time are dated as the date-processed, while any transactions processed after this time are dated as being processed the next day.
Added On:  03/16/12
SQL Column:  IS_ACCUMULATE_RETURNS
Java Field:  isAccumulateReturns
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether returns should be delivered on daily basis or accumulated and delivered as part of the response file when next request file is sent.
Added On:  03/16/12
SQL Column:  PARENT_MERCHANT_CODE
Java Field:  parentMerchantCode
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Merchant code of the parent object.
Added On:  03/16/12
SQL Column:  ACCOUNT_BALANCE_ALGORITHM_CL
Java Field:  accountBalanceAlgorithmCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
For UniBill only.
Represents the type of balancing algorithm that is used to balance payments on customer account.
Added On:  03/16/12
SQL Column:  TAX_ID_CODE
Java Field:  taxIdCode
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Use "Federal Tax Id" in "Business Info" object instead of this field.
Added On:  03/16/12
SQL Column:  TIME_ZONE_CODE
Java Field:  timeZoneCode
Status:  Active
SQL Type:  varchar(33)
Java Type:  String
Attributes:
Time zone of a merchant.
Added On:  03/16/12
SQL Column:  IS_PAYMENT_OPTION_DISABLED_ON_DECLINE
Java Field:  isPaymentOptionDisabledOnDecline
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether payment option is disabled when defined number of declines is received for this payment option.
Added On:  03/16/12
SQL Column:  REMITTANCE_MODE_CL
Java Field:  remittanceModeCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes: Min Length:2
Represents the type of transaction for which remittance process is going to be applied.

See Remittance for additional information.
Added On:  03/16/12
SQL Column:  PORTAL_WELCOME_PAGE_FK
Java Field:  portalWelcomePage
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Page Store
Attributes:
Reference to the entity that represents welcoming page.
Added On:  03/16/12
SQL Column:  COLLECTOR_FK
Java Field:  collector
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Merchant
Attributes:
Reference to the entity that represents information about the collector.
Added On:  03/16/12
SQL Column:  REMITTER_FK
Java Field:  remitter
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Merchant
Attributes:
Reference to a merchant that contains settings necessary to execute remittance operations.
Added On:  03/16/12
SQL Column:  MERCHANT_ACCOUNT_GROUP_FK
Java Field:  merchantAccountGroup
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to deposit and fee information for the merchant.
Added On:  03/16/12
SQL Column:  MERCHANT_ACTIVITY_FK
Java Field:  merchantActivity
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Merchant Activity
Attributes:
Reference to the Merchant activity object that contains statistical information about merchant's processing.
Added On:  04/02/12
SQL Column:  REMITTANCE_BASIS_CL
Java Field:  remittanceBasisCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the type of remittance basis that is used for this merchant. Works in conjunction with ACH remittance period, CC remittance period and AmEx remittance period.
Added On:  06/11/12
SQL Column:  MAIL_MODE_CL
Java Field:  mailModeCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the type of selected mailing mode that is used for this merchant.
Added On:  06/11/12
SQL Column:  IS_SKIP_TRACE_ENABLED
Java Field:  isSkipTraceEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
For UniBill only.
Indicates whether skiptracing process is enabled on a customer account.
Added On:  06/21/12
SQL Column:  IS_EXPIRATION_DATE_VALIDATION_ENABLED
Java Field:  isExpirationDateValidationEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether expiration date validation is enabled or not.
Added On:  06/21/12
SQL Column:  IS_ROUTING_NUMBER_VALIDATION_ENABLED
Java Field:  isRoutingNumberValidationEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether routing number validation is enabled or not.
Added On:  06/21/12
SQL Column:  BATCH_VALIDATION_THRESHOLD_COUNT
Java Field:  batchValidationThresholdCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Minimum number of transactions that must be present in a batch in order for this batch to get validated for potential duplicates or inconsistencies. If a batch is lower than indicated number of transactions, it will not be verified for duplicates.
Added On:  06/21/12
SQL Column:  BATCH_VALIDATION_THRESHOLD_AMOUNT
Java Field:  batchValidationThresholdAmount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Total amount of a file, necessary for duplicate validation mechanism to get activated.
Added On:  09/05/12
SQL Column:  CODE_UNIQUENESS_SCOPE_CL
Java Field:  codeUniquenessScopeCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
For UniBill only.
Represents the type of scope, within which customer account's ID is unique.
Added On:  09/26/12
SQL Column:  BUSINESS_INFO_FK
Java Field:  businessInfo
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Business Info
Attributes:
Reference to the entity that represents legal information of the merchant.
Added On:  09/26/12
SQL Column:  DEFAULT_USER_FK
Java Field:  defaultUser
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References User
Attributes:
Reference to the entity that represents default user defined for this merchant.
Added On:  09/27/12
SQL Column:  COUNTRY_CODE
Java Field:  countryCode
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes: Default:US
Country code of the merchant.
Added On:  10/02/12
SQL Column:  AVS_RESPONSE_MASK
Java Field:  avsResponseMask
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Filter that defines for which AVS response codes settlement is allowed.
Added On:  10/02/12
SQL Column:  CSC_RESPONSE_MASK
Java Field:  cscResponseMask
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Filter that defines for which CSC response codes settlement is allowed.
Added On:  10/09/12
SQL Column:  CUSTOMER_STATEMENT_FEE
Java Field:  customerStatementFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Fee, applied to the customer's account for a paper statement of the account.
Added On:  10/10/12
SQL Column:  RETURNS_DELIVERY_MODE_CL
Java Field:  returnsDeliveryModeCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the type of delivery option for ACH returns and chargebacks for this merchant.
Added On:  10/17/12
SQL Column:  NON_COLLECTIONS_FEE_STATE_LIST
Java Field:  nonCollectionsFeeStateList
Status:  Active
SQL Type:  varchar(150)
Java Type:  String
Attributes:
For UniBill only. List of states, for which collection fee is not applied.
Added On:  10/20/12
SQL Column:  RESELLER_FK
Java Field:  reseller
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Reseller
Attributes:
Reference to the entity that represents the reseller associated with the merchant.
Added On:  12/06/12
SQL Column:  IS_BATCH_CUSTOM_FIELD_ENABLED
Java Field:  isBatchCustomFieldEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
For internal use only.

Indicates whether the certain information should be added to the returns file.
Added On:  02/05/13
SQL Column:  RETRY_FEE
Java Field:  retryFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Retry fee of the customer.
Added On:  02/11/13
SQL Column:  CUSTOMER_RETURN_FEE
Java Field:  customerReturnFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Return fee of the customer.
Added On:  02/11/13
SQL Column:  CUSTOMER_AGENT_PAYMENT_CONVENIENCE_FEE
Java Field:  customerAgentPaymentConvenienceFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Convenience fee of the customer indicated by the agent.
Added On:  02/11/13
SQL Column:  CUSTOMER_PORTAL_PAYMENT_CONVENIENCE_FEE
Java Field:  customerPortalPaymentConvenienceFee
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Convenience fee of the customer indicated on payment portal.
Added On:  02/11/13
SQL Column:  CLIENT_FEE_FK
Java Field:  clientFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Client Fee
Attributes:
Reference to the entity that represents client's fee information.
Added On:  04/02/13
SQL Column:  IDENTITIES
Java Field:  identities
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Provisioning information associated with a merchant.
Added On:  07/26/13
SQL Column:  MERCHANT_PROFILE
Java Field:  merchantProfile
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
A set of parameters that are used to govern the setup of the merchant with the respect to its merchant accounts, merchant IDs, descriptors, deposit accounts and fees. It comprises 5 parameters, defining of which will make it possible to determine how the merchant / merchant account should be configured.

The field can take values consisting of 5 symbols (for example, SSSSM or MMMMA).
1st position (Accounts) - S for single, M for multiple.
2nd position (Tax IDs) - S for single, M for multiple.
3rd position (Descriptors) - S for single, M for multiple.
4th position (Deposit accounts) - S for single, M for multiple.
5th position (Fees) - M (merchant) or A (account).

Multiple accounts indicates whether merchant is gonna be using multiple accounts or only single one. For more information see For more information see Merchant Configuration Guide

Multiple tax IDs assumes multiple accounts to be true and indicates whether or not each of the accounts is gonna belong to separate organizations with their own tax IDs. For more information see Merchant Configuration Guide

Multiple descriptors assumes multiple accounts to be true and indicates whether or not each of the locations will be using its own separate card descriptor or the same descriptors of use across all of them. For more information see Merchant Configuration Guide

Multiple deposit accounts assumes multiple accounts to be true and, when remittance mechanism is used, indicates whether each of the accounts is going to have its own deposit accounts or whether single deposit accounts will be used for everyone. For more information see Merchant Configuration Guide

Multiple recurring fees assumes multiple accounts to be true and indicates whether recurring fees will be applied to the merchant or to each individual account. For more information see Merchant Configuration Guide
Added On:  08/16/13
SQL Column:  PORTFOLIO_FK
Java Field:  portfolio
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Portfolio
Attributes:
Reference to the entity that represents the portfolio attached to the merchant.
Added On:  08/23/13
SQL Column:  IS_TRANSACTION_PROCESSING_OPTIMIZATION_ENABLED
Java Field:  isTransactionProcessingOptimizationEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether the transaction processing optimization is enabled in the system.
Added On:  11/14/13
SQL Column:  IS_ACCOUNT_AGGREGATION_ACH_ENABLED
Java Field:  isAccountAggregationAchEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether account aggregation ACH mechanism is used for this merchant or not.
Added On:  11/14/13
SQL Column:  IS_ACCOUNT_AGGREGATION_CARDS_ENABLED
Java Field:  isAccountAggregationCardsEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether account aggregation cards mechanism is used for this merchant or not.
Added On:  12/16/13
SQL Column:  IS_LETTER_INVOICE_NOTIFICATION_INVOICE_ONLY
Java Field:  isLetterInvoiceNotificationInvoiceOnly
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether the invoice notification includes invoice only.
Added On:  12/16/13
SQL Column:  IS_EMAIL_INVOICE_NOTIFICATION_INVOICE_ONLY
Java Field:  isEmailInvoiceNotificationInvoiceOnly
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether the email invoice notification includes invoice notification only.
Added On:  12/25/13
SQL Column:  LATE_CUSTOMER_FEE_FK
Java Field:  lateCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the enitity that represents information about fee, which is charged if there is an outstanding balance by a period indicated as late period.
Added On:  12/25/13
SQL Column:  SOFT_DECLINE_CUSTOMER_FEE_FK
Java Field:  softDeclineCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged on soft declines (transactions that were declined with the reason that suggests that further reattempt might be successful).
Added On:  12/25/13
SQL Column:  HARD_DECLINE_CUSTOMER_FEE_FK
Java Field:  hardDeclineCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged on hard declines (transactions that were declined with the reason that suggests that further reattempts are futile).
Added On:  12/25/13
SQL Column:  CHARGEBACK_CUSTOMER_FEE_FK
Java Field:  chargebackCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged when a chargeback is received.
Added On:  12/25/13
SQL Column:  RETURN_CUSTOMER_FEE_FK
Java Field:  returnCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged when a return on direct debit payment is received.
Added On:  12/25/13
SQL Column:  FREEZE_RECURRING_CUSTOMER_FEE_FK
Java Field:  freezeRecurringCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged when a payment plan is set on freeze (the fee is charged on recurring basis, replacing the regular payment plan amount).
Added On:  12/25/13
SQL Column:  FREEZE_FLAT_CUSTOMER_FEE_FK
Java Field:  freezeFlatCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged when a payment plan is set on freeze (the fee is charged one-time only).
Added On:  12/25/13
SQL Column:  RETRY_CUSTOMER_FEE_FK
Java Field:  retryCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged when previously declined transaction gets approved as a part of automated retry process.
Added On:  01/09/14
SQL Column:  DEACTIVATE_DATE
Java Field:  deactivateDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the record was deactivated.
Added On:  01/09/14
SQL Column:  IS_IMPORT_LOG_REVIEW_REQUIRED
Java Field:  isImportLogReviewRequired
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:true
Indicates whether the review of import log is required.
Added On:  02/28/14
SQL Column:  MINIMUM_PERPETUAL_BILLING_COUNT
Java Field:  minimumPerpetualBillingCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Minimum perpetual billing count.
Added On:  03/16/14
SQL Column:  ENROLLMENT_FEE_FK
Java Field:  enrollmentFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged when a customer record is created (the fee is charged one-time only).
Added On:  08/19/14
SQL Column:  TIME_ZONE_SYSTEM_CODE
Java Field:  timeZoneSystemCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
System code indicating the time zone.
Added On:  09/09/14
SQL Column:  IS_REALTIME_REVIEW_REQUIRED
Java Field:  isRealtimeReviewRequired
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether realtime review is required or not.
Added On:  09/09/14
SQL Column:  RESELLER_ENTITY_CODE
Java Field:  resellerEntityCode
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Code of the entity where information about the reseller is stored.
Added On:  09/24/14
SQL Column:  IS_FILE_HASH_VALIDATION_ENABLED
Java Field:  isFileHashValidationEnabled
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates whether duplicate file validation based on file's content (in addition to the existing file name duplicate validation) is active or not.
Added On:  10/28/14
SQL Column:  BLACKLIST_POLICY_CL
Java Field:  blacklistPolicyCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Enumeration of possible blacklist policy types available in the system.
Added On:  11/11/14
SQL Column:  RETURNS_GENERATION_TIME
Java Field:  returnsGenerationTime
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Time of the returns payment transaction generation.
Added On:  12/03/14
SQL Column:  TOKENIZATION_FORMAT_CL
Java Field:  tokenizationFormatCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Enumeration of possible tokenization policy formats available for the merchant in the system.
Added On:  01/15/15
SQL Column:  STATEMENT_CUSTOMER_FEE_FK
Java Field:  statementCustomerFee
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Customer Fee
Attributes:
Reference to the entity that represents information about fee, which is charged for cases when a payment plan is paid by a customer who comes to facility and makes a payment in person.
Added On:  02/05/15
SQL Column:  DATA_EXPORT_POLICY
Java Field:  dataExportPolicy
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes: Default:----------
Regulates whether a merchant uses Data Export mechanism for reports. Two reports are available for data export: Transaction Export Summary and Deposit Export. Default value is "----------".
There are three available values:
1. E - export;
2. N - export and notify;
3. "-" - do not export.
For example, field format "-E----------" indicated that only Deposit Export report is exported.
Added On:  03/22/15
SQL Column:  CHANNEL_FK
Java Field:  channel
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Channel
Attributes:
Reference to the entity that represents the channel.
Added On:  04/17/15
SQL Column:  BATCH_PROCESSING_POLICY_CL
Java Field:  batchProcessingPolicyCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Represents the selected (or current) type of batch processing policy.
Allows to select policy for batch processing if a validation file was generated by the system.
  • All Or Fail - if there is at least one invalid transaction in the request file, validation error file is generated and the request file is not processed at all.
  • Any Valid - all valid transactions included in a request file are processed by a processor. Invalid transactions are placed into the validation error file and should be re-processed as a separate file after correcting all of the issues.
Added On:  04/17/15
SQL Column:  BATCH_ACCOUNT_UPDATE_POLICY_CL
Java Field:  batchAccountUpdatePolicyCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Represents the selected (or current) type of batch account update policy.
Allows to select Account Update policy for batch files. Account Update can be done either before billing or after the first billing.
Added On:  06/20/15
SQL Column:  DEPOSIT_GROUPING_CL
Java Field:  depositGroupingCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Enumeration of possible days for deposit groupings.
Added On:  07/15/15
SQL Column:  OFFLINE_CALL_BACK_URL
Java Field:  offlineCallBackUrl
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
The URL address for offline callbacks.
Added On:  07/31/15
SQL Column:  ADDITIONAL_PASSWORD
Java Field:  additionalPassword
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Additional password for the account.
Added On:  08/07/15
SQL Column:  EMAIL_CODE_ACCOUNT_EXPIRATION
Java Field:  emailCodeAccountExpiration
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Expiration date of email code account.
Added On:  08/07/15
SQL Column:  EMAIL_CODE_ACCOUNT_EXPIRATION_PERIOD
Java Field:  emailCodeAccountExpirationPeriod
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Expiration period of the email account code.
Added On:  08/17/15
SQL Column:  FEE_PROCESSOR_FK
Java Field:  feeProcessor
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Merchant Account
Attributes:
Reference to the entity that reresents processor's fee.
Added On:  08/31/15
SQL Column:  TOKENIZATION_UPDATE_POLICY_CL
Java Field:  tokenizationUpdatePolicyCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Enumeration of possible tokenization updated policy formats available for the merchant in the system.
Added On:  12/01/15
SQL Column:  FILE_ENCRYPTION_PUBLIC_KEY_FILE_NAME
Java Field:  fileEncryptionPublicKeyFileName
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Name of the public PGP key.
Added On:  09/02/16
SQL Column:  MERCHANT_ACCOUNT_FK
Java Field:  merchantAccounts
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Merchant Account
Attributes:
Reference to the entity that represents the information of the merchant account.
Added On:  09/19/16
SQL Column:  TOKENIZATION_REMOVAL_CL
Java Field:  tokenizationRemovalCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Reference to the entity that represents modes that are used to remove tokenization.
Added On:  02/21/17
SQL Column:  DIRECTORY_CODE
Java Field:  directoryCode
Status:  Active
SQL Type:  varchar(36)
Java Type:  String
Attributes:
Specific identifier assigned for a merchant.
Added On:  07/27/17
SQL Column:  IS_MULTIPLE_RETURNS_FILE_SUPPORTED
Java Field:  isMultipleReturnsFileSupported
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default:false
Indicates that the return files will be generated several times a day
Added On:  03/11/18
SQL Column:  SCRIPT_REGISTRY_CODE
Java Field:  scriptRegistryCode
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Added On:  10/23/17
SQL Column:  AGGREGATION_LEVEL_CL
Java Field:  aggregationLevelCl
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Added On:  07/25/17
SQL Column:  TAG_LIST
Java Field:  tagList
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Added On:  03/16/12
SQL Column:  COLLECTIONS_SHARE
Java Field:  collectionsShare
Status:  Active
SQL Type:  decimal(10,2)
Java Type:  Double
Attributes:
Percentage of the customer's account ballance, which is applied as a fee when the account is sent to 3rd party collections.
Added On:  03/16/12
SQL Column:  PRINCIPAL_AGENT_COMMISSION_SHARE
Java Field:  principalAgentCommissionShare
Status:  Active
SQL Type:  decimal(10,2)
Java Type:  Double
Attributes:
Percentage of a payment collected against the invoice that is paid as a commission to an agent who managed to collect the payment.
Added On:  03/16/12
SQL Column:  LATE_FEE_AGENT_COMMISSION_SHARE
Java Field:  lateFeeAgentCommissionShare
Status:  Active
SQL Type:  decimal(10,2)
Java Type:  Double
Attributes:
Percentage of a payment collected against late fee that is paid as a commission to an agent who managed to collect the payment.
Added On:  03/16/12
SQL Column:  RETURN_FEE_AGENT_COMMISSION_SHARE
Java Field:  returnFeeAgentCommissionShare
Status:  Active
SQL Type:  decimal(10,2)
Java Type:  Double
Attributes:
Percentage of a payment collected against return fee that is paid as a commission to an agent who managed to collect the payment.
Added On:  03/26/18
SQL Column:  NEXT_ACCOUNT_ID
Java Field:  nextAccountId
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: Default:1
Added On:  10/01/18
SQL Column:  IS_MULTIPLE_REMITTANCE
Java Field:  isMultipleRemittance
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Calculated