Merchant Account UML

Added On:  03/16/12 

SQL Table:  IAPP_MERCHANT_ACCOUNT 

Module:  UniCore 

Type:  Entity  Status:  Active 

Java Class:  MerchantAccount 

Represents the information of the merchant account. Can represent location, store, club or department. Used to subdivide data (on reports) and override global processing settings defined on Merchant level.

Available Fields:

• Age Limit
• AVS Response Mask
• Business Info FK
• City
• Client Fee FK
• Code
• Contact Name
• Country Code
• Create Date
• Credit Agency Status CL
• Csc Response Mask
• Deactivate Date
• Default User FK
• Directory Code

• Email
• Enrollment Fee FK
• External Code
• Fax
• Identities
• Is Active
• Is Batch Review Required
• Merchant Account Activity FK
• Merchant Account Group FK
• Merchant FK
• Merchant Profile
• Name
• Notes
• Phone

• Portfolio FK
• Reference Code
• State
• Street1
• Street2
• Tag List
• Tax ID Code
• Tax Rate 1
• Tax Rate 2
• Tax Rate 3
• Tax Rate 4
• Tax Rate 5
• Time Zone Code
• Time Zone System Code

• ZIP Code

Age Limit

Added On:  03/16/12

SQL Column:  AGE_LIMIT

Java Field:  ageLimit

Status:  Active

SQL Type:  int(11)

Java Type:  Integer

Attributes: Default:18

Legal age limit necessary for a person to sign official documents. If a person is below this age, a signature of parent or guardian is also required.

AVS Response Mask

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.

Business Info FK

Added On:  09/26/12

SQL Column:  BUSINESS_INFO_FK

Java Field:  businessInfo

Status:  Active

SQL Type:  bigint(20)

Java Type:  

References Business Info

Attributes:

Reference to the entity that represents legal information of the merchant account.

City

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 mailing address

Client Fee FK

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.

Code

Added On:  03/16/12

SQL Column:  CODE

Java Field:  code

Status:  Active

SQL Type:  int(11)

Java Type:  Integer

Identifier / Primary Key

Attributes: Required

Unique identifier of the merchant account generated by the system, divisible by 1000.

Contact Name

Added On:  03/16/12

SQL Column:  CONTACT_NAME

Java Field:  contactName

Status:  Active

SQL Type:  varchar(100)

Java Type:  String

Attributes:

Name of the contact person for this merchant account.

Country Code

Added On:  09/26/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's mailing address

Create Date

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

Credit Agency Status CL

Added On:  09/19/12

SQL Column:  CREDIT_AGENCY_STATUS_CL

Java Field:  creditAgencyStatusCl

Status:  Active

SQL Type:  varchar(1)

Java Type:  String

References Credit Agency Status Classifier

Attributes:

Represents the status of the credit bureau reporting.

Csc Response Mask

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.

Deactivate Date

Added On:  12/11/13

SQL Column:  DEACTIVATE_DATE

Java Field:  deactivateDate

Status:  Active

SQL Type:  datetime

Java Type:  Date

Attributes:

Date when the merchant account was deactivated.

Default User FK

Added On:  09/26/12

SQL Column:  DEFAULT_USER_FK

Java Field:  defaultUser

Status:  Active

SQL Type:  int(11)

Java Type:  

References User

Attributes:

Reference to the entity that represents default user defined for this merchant account.

Directory Code

Added On:  02/28/17

SQL Column:  DIRECTORY_CODE

Java Field:  directoryCode

Status:  Active

SQL Type:  varchar(36)

Java Type:  String

Attributes:

Email

Added On:  03/16/12

SQL Column:  EMAIL

Java Field:  email

Status:  Active

SQL Type:  varchar(100)

Java Type:  String

Attributes:

Email associated with this merchant account

Enrollment Fee FK

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 various customer's fee information.

External Code

Added On:  03/16/12

SQL Column:  EXTERNAL_CODE

Java Field:  externalCode

Status:  Active

SQL Type:  varchar(60)

Java Type:  String

Attributes:

Unique identifier of the merchant account in the external system that UniPay is integrated with. The value is used to cross reference merchant account records in the external system.

Fax

Added On:  03/16/12

SQL Column:  FAX

Java Field:  fax

Status:  Active

SQL Type:  varchar(20)

Java Type:  String

Attributes:

Fax number associated with this merchant account

Identities

Added On:  04/02/13

SQL Column:  IDENTITIES

Java Field:  identities

Status:  Active

SQL Type:  varchar(255)

Java Type:  String

Attributes:

Is Active

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 in the system.

Is Batch Review Required

Added On:  09/23/13

SQL Column:  IS_BATCH_REVIEW_REQUIRED

Java Field:  isBatchReviewRequired

Status:  Active

SQL Type:  tinyint(1)

Java Type:  Boolean

Attributes: Default:false

Indicates whether batch review is required.

Merchant Account Activity FK

Added On:  02/11/13

SQL Column:  MERCHANT_ACCOUNT_ACTIVITY_FK

Java Field:  merchantAccountActivity

Status:  Active

SQL Type:  bigint(20)

Java Type:  Long

References Merchant Account Activity

Attributes:

Reference to the entity that represents merchant account activity.

Merchant Account Group FK

Added On:  03/16/12

SQL Column:  MERCHANT_ACCOUNT_GROUP_FK

Java Field:  merchantAccountGroup

Status:  Active

SQL Type:  bigint(20)

Java Type:  Long

References Merchant Account Group

Attributes:

Reference to the entity that represents merchant account group that belongs to the merchant account.

Merchant FK

Added On:  03/16/12

SQL Column:  MERCHANT_FK

Java Field:  merchant

Status:  Active

SQL Type:  int(11)

Java Type:  Integer

References Merchant

Attributes:

Reference to athe entity that represents merchant that this account belongs to.

Merchant Profile

Added On:  07/29/13

SQL Column:  MERCHANT_PROFILE

Java Field:  merchantProfile

Status:  Active

SQL Type:  varchar(5)

Java Type:  String

Attributes:

Profile that belongs to the specfied merchant.

Name

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

Notes

Added On:  03/16/12

SQL Column:  NOTES

Java Field:  notes

Status:  Active

SQL Type:  varchar(2000)

Java Type:  String

Attributes:

Possible notes concerning this merchant account

Phone

Added On:  03/16/12

SQL Column:  PHONE

Java Field:  phone

Status:  Active

SQL Type:  varchar(20)

Java Type:  String

Attributes:

Phone number associated with this merchant account

Portfolio FK

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 of the user defined for this reseller.

Reference Code

Added On:  03/16/12

SQL Column:  REF_CODE

Java Field:  refCode

Status:  Active

SQL Type:  varchar(60)

Java Type:  String

Attributes:

See Reference Code definition for additional information.

State

Added On:  03/16/12

SQL Column:  STATE

Java Field:  state

Status:  Active

SQL Type:  varchar(3)

Java Type:  String

Attributes:

State code of the merchant's mailing address

Street1

Added On:  03/16/12

SQL Column:  STREET1

Java Field:  street1

Status:  Active

SQL Type:  varchar(128)

Java Type:  String

Attributes:

Street1 of the merchant's mailing address

Street2

Added On:  03/16/12

SQL Column:  STREET2

Java Field:  street2

Status:  Active

SQL Type:  varchar(128)

Java Type:  String

Attributes:

Street2 of the merchant's mailing address

Tag List

Added On:  07/25/17

SQL Column:  TAG_LIST

Java Field:  tagList

Status:  Active

SQL Type:  varchar(50)

Java Type:  String

Attributes:

tag list for options

Tax ID Code

Added On:  03/16/12

SQL Column:  TAX_ID_CODE

Java Field:  taxIdCode

Status:  Active

SQL Type:  varchar(20)

Java Type:  String

Attributes:

Merchant's federal tax ID.

Tax Rate 1

Added On:  03/16/12

SQL Column:  TAX_RATE1

Java Field:  taxRate1

Status:  Active

SQL Type:  decimal(10,2)

Java Type:  Double

Attributes:

Tax Rate1 of the merchant account.

Tax Rate 2

Added On:  03/16/12

SQL Column:  TAX_RATE2

Java Field:  taxRate2

Status:  Active

SQL Type:  decimal(10,2)

Java Type:  Double

Attributes:

Tax Rate2 of the merchant account.

Tax Rate 3

Added On:  03/16/12

SQL Column:  TAX_RATE3

Java Field:  taxRate3

Status:  Active

SQL Type:  decimal(10,2)

Java Type:  Double

Attributes:

Tax Rate3 of the merchant account.

Tax Rate 4

Added On:  03/16/12

SQL Column:  TAX_RATE4

Java Field:  taxRate4

Status:  Active

SQL Type:  decimal(10,2)

Java Type:  Double

Attributes:

Tax Rate4 of the merchant account.

Tax Rate 5

Added On:  03/16/12

SQL Column:  TAX_RATE5

Java Field:  taxRate5

Status:  Active

SQL Type:  decimal(10,2)

Java Type:  Double

Attributes:

Tax Rate5 of the merchant account.

Time Zone Code

Added On:  03/16/12

SQL Column:  TIME_ZONE_CODE

Java Field:  timeZoneCode

Status:  Active

SQL Type:  varchar(33)

Java Type:  String

Attributes:

Represents the time zone associated with this merchant account.

Time Zone System Code

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 of the merchant's time zone.

ZIP Code

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 the merchant's mailing address.