Onboarding Application UML
Added On: 05/16/16
Module: UniCharge
Type: Entity
Status: Active
Java Class: OnboardingApplication
Entity that represents main information about onboarding application.
Added On: 12/21/21
SQL Column: ACCOUNT_PROCESSING_POLICY
Java Field: accountProcessingPolicy
Status: Active
SQL Type: varchar(14)
Java Type: String
Added On: 10/16/18
SQL Column: ACTION_CL
Java Field: actionCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 05/28/19
SQL Column: ANNUAL_FEE_POLICY
Java Field: annualFeePolicy
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 05/16/16
SQL Column: APPLICATION_CODE
Java Field: applicationCode
Status: Active
SQL Type: varchar(25)
Java Type: String
Secondary identifier which can be used to cross-reference records between TidyPay and integrated systems.
Added On: 10/31/16
SQL Column: BILLING_CONFIGURATION_DATE
Java Field: billingConfigurationDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when billing configuration is done.
Added On: 10/21/16
SQL Column: BILLING_CONFIGURATION_SCRIPT
Java Field: billingConfigurationScript
Status: Active
SQL Type: varchar(63)
Java Type: String
Code of the billing configuration assigned to the merchant.
Added On: 10/31/16
SQL Column: BILLING_CONFIGURATION_STATUS_CL
Java Field: billingConfigurationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of possible billing configuration statuses.
Added On: 05/16/16
SQL Column: BIRTH_DATE
Java Field: birthDate
Status: Active
SQL Type: datetime
Java Type: Date
Date of birth of the merchant.
Added On: 10/21/16
SQL Column: CANCEL_URL
Java Field: cancelUrl
Status: Active
SQL Type: varchar(255)
Java Type: String
URL used for cancellation.
Added On: 09/18/23
SQL Column: CARD_FEE_DESCRIPTOR
Java Field: cardFeeDescriptor
Status: Active
SQL Type: varchar(25)
Java Type: String
Descriptor assigned to Convenience Fee payment card transactions associated with the merchant. Shows up on cardholder statements.
Added On: 10/21/16
SQL Column: CHANNEL_CODE
Java Field: channelCode
Status: Active
SQL Type: bigint(20)
Java Type: Long
Code of the assigned channel.
Added On: 05/16/16
SQL Column: CITY
Java Field: city
Status: Active
SQL Type: varchar(50)
Java Type: String
City of the mailing address.
Added On: 05/31/17
SQL Column: CLIENT_HOST
Java Field: clientHost
Status: Active
SQL Type: varchar(63)
Java Type: String
IP address associated with API call sent by the merchant.
Added On: 05/16/16
SQL Column: COUNTRY_CODE
Java Field: countryCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Country code of the mailing address.
Added On: 05/16/16
SQL Column: CREATE_DATE
Java Field: createDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when the record was created
Added On: 04/12/22
SQL Column: DATA_FORMAT
Java Field: dataFormat
Status: Active
SQL Type: varchar(13)
Java Type: String
Added On: 09/18/23
SQL Column: DIRECT_DEBIT_FEE_DESCRIPTOR
Java Field: directDebitFeeDescriptor
Status: Active
SQL Type: varchar(27)
Java Type: String
Descriptor assigned to Convenience Fee direct debit transactions associated with the merchant. Shows up on account holder statements.
Added On: 02/03/17
SQL Column: DISTRIBUTION_SCHEMA_CODE
Java Field: distributionSchemaCode
Status: Active
SQL Type: varchar(20)
Java Type: String
Code of the distribution schema associated with the merchant.
Added On: 05/16/16
SQL Column: EMAIL
Java Field: email
Status: Active
SQL Type: varchar(100)
Java Type: String
Email address used to send any notifications or discuss any processing issues.
Added On: 09/18/23
SQL Column: EXTRA_FEATURES_POLICY
Java Field: extraFeaturesPolicy
Status: Active
SQL Type: varchar(1)
Java Type: String
Parameter that defines which Extra Features were requested to be configured
Added On: 09/18/23
SQL Column: FEE_PROCESSOR_APPLICATION_ID
Java Field: feeProcessorApplicationId
Status: Active
SQL Type: bigint(20)
Java Type: Long
ID of the Onboarding Application which was created for the Fee Processor.
Added On: 09/18/23
SQL Column: FEE_PROCESSOR_CONFIGURATION_DATE
Java Field: feeProcessorConfigurationDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when Fee Processor for this merchant was configured.
Added On: 09/18/23
SQL Column: FEE_PROCESSOR_CONFIGURATION_STATUS_CL
Java Field: feeProcessorConfigurationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Current status of the Fee Processor configuration process.
Added On: 09/18/23
SQL Column: FEE_PROCESSOR_TEMPLATE_ID
Java Field: feeProcessorTemplateId
Status: Active
SQL Type: bigint(20)
Java Type: Long
ID of the Onboarding Application used as a template for Fee Processor Onboarding Application.
Added On: 01/30/18
SQL Column: FIELD_LIST_HIDDEN
Java Field: fieldListHidden
Status: Active
SQL Type: varchar(1500)
Java Type: String
Added On: 01/30/18
SQL Column: FIELD_LIST_READONLY
Java Field: fieldListReadonly
Status: Active
SQL Type: varchar(1500)
Java Type: String
Added On: 05/16/16
SQL Column: FIRST_NAME
Java Field: firstName
Status: Active
SQL Type: varchar(50)
Java Type: String
First name of the merchant.
Added On: 09/18/23
SQL Column: FRANCHISE_FEE_PAYMENT_RATE
Java Field: franchiseFeePaymentRate
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 09/18/23
SQL Column: FRANCHISE_FEE_SUBSCRIPTION_RATE
Java Field: franchiseFeeSubscriptionRate
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 04/11/24
SQL Column: FRANCHISE_FEE_TAX_RATE
Java Field: franchiseFeeTaxRate
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 10/05/17
SQL Column: FTP_ACCESS_CREATION_DATE
Java Field: ftpAccessCreationDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when the folder for onboarding had been set up.
Added On: 10/05/17
SQL Column: FTP_ACCESS_CREATION_STATUS_CL
Java Field: ftpAccessCreationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: Object
Reference to the entity that represents possible creation statuses of the onboarding application.
Added On: 05/16/16
SQL Column: ID
Java Field: id
Status: Active
SQL Type: bigint(20)
Java Type: Long
Attributes:
Unique, Required, CreateOnly, ReadOnly
Identifier of the object used for references; auto-incremented integer value.
Added On: 01/30/18
SQL Column: IS_EMBEDDED
Java Field: isEmbedded
Status: Active
SQL Type: tinyint(1)
Java Type: Boolean
Attributes:
Default:false
Added On: 11/28/18
SQL Column: IS_FIELD_UPDATED
Java Field: isFieldUpdated
Status: Active
SQL Type: tinyint(1)
Java Type: Boolean
Added On: 07/10/19
SQL Column: IS_LEGACY_APPLICATION
Java Field: isLegacyApplication
Status: Active
SQL Type: tinyint(1)
Java Type: Boolean
Attributes:
Default:false
Added On: 05/16/16
SQL Column: LAST_NAME
Java Field: lastName
Status: Active
SQL Type: varchar(50)
Java Type: String
Last name of the merchant.
Added On: 08/21/17
SQL Column: LAST_STATUS_UPDATE_DATE
Java Field: lastStatusUpdateDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when the onboarding application status was updated the last time.
Added On: 01/30/18
SQL Column: MERCHANT_FK
Java Field: merchant
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 05/16/16
SQL Column: MERCHANT_ACCOUNT_CODE
Java Field: merchantAccountCode
Status: Active
SQL Type: int(11)
Java Type: Integer
Code of
Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
Added On: 11/01/16
SQL Column: MERCHANT_CODE
Java Field: merchantCode
Status: Active
SQL Type: varchar(61)
Java Type: String
Code of the associated merchant.
Added On: 10/31/16
SQL Column: MERCHANT_CREATION_DATE
Java Field: merchantCreationDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when the merchant was created.
Added On: 10/21/16
SQL Column: MERCHANT_CREATION_POLICY_CL
Java Field: merchantCreationPolicyCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of merchant creation policy values.
Added On: 10/31/16
SQL Column: MERCHANT_CREATION_STATUS_CL
Java Field: merchantCreationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of statuses assigned to the merchant creation.
Added On: 10/31/16
SQL Column: MERCHANT_FEE_CONFIGURATION_DATE
Java Field: merchantFeeConfigurationDate
Status: Active
SQL Type: datetime
Java Type: Date
Date when merchant fee profile was configured.
Added On: 10/31/16
SQL Column: MERCHANT_FEE_CONFIGURATION_STATUS_CL
Java Field: merchantFeeConfigurationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of possible statuses of the merchant fee configuration.
Added On: 03/11/17
SQL Column: MERCHANT_ID
Java Field: merchantId
Status: Active
SQL Type: varchar(100)
Java Type: String
Identifier of the merchant within the gateway.
Added On: 10/27/16
SQL Column: MERCHANT_NAME
Java Field: merchantName
Status: Active
SQL Type: varchar(100)
Java Type: String
Name of the associated merchant.
Added On: 10/21/16
SQL Column: MERCHANT_PROFILE
Java Field: merchantProfile
Status: Active
SQL Type: varchar(5)
Java Type: String
Profile of the merchant that an application is assigned to.
Added On: 11/01/16
SQL Column: MERCHANT_REF_CODE
Java Field: merchantRefCode
Status: Active
SQL Type: varchar(60)
Java Type: String
Secondary identifier of the merchant/merchant account which can be used for cross-referencing records between the gateway and integrated systems.
Added On: 07/17/17
SQL Column: MERCHANT_TYPE
Java Field: merchantType
Status: Active
SQL Type: varchar(1)
Java Type: String
Type of the merchant (Affiliate, Merchant, etc.).
Added On: 10/31/16
SQL Column: MID_REQUEST_DATE
Java Field: midRequestDate
Status: Active
SQL Type: datetime
Java Type: Date
Request date assigned to the merchant identifier.
Added On: 10/31/16
SQL Column: MID_REQUEST_STATUS_CL
Java Field: midRequestStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of possible statuses of the request assigned to the merchant identifier.
Added On: 10/31/16
SQL Column: MID_RESPONSE_DATE
Java Field: midResponseDate
Status: Active
SQL Type: datetime
Java Type: Date
Response date assigned to the merchant identifier.
Added On: 10/31/16
SQL Column: MID_RESPONSE_STATUS_CL
Java Field: midResponseStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of possible statuses of the response assigned to the merchant's identifier.
Added On: 10/16/18
SQL Column: NEXT_ONBOARDING_APPLICATION_FK
Java Field: nextOnboardingApplication
Status: Active
SQL Type: bigint(20)
Java Type: Long
Added On: 02/07/17
SQL Column: NOTIFICATION_POLICY
Java Field: notificationPolicy
Status: Active
SQL Type: varchar(1)
Java Type: String
Policy of how notifications about onboarding process results are delivered to the merchant.
Added On: 10/21/16
SQL Column: NOTIFY_URL
Java Field: notifyUrl
Status: Active
SQL Type: varchar(255)
Java Type: String
URL used for notifications.
Added On: 10/16/18
SQL Column: OFFICER_CODE
Java Field: officerCode
Status: Active
SQL Type: varchar(25)
Java Type: String
Added On: 05/16/16
SQL Column: ONBOARDING_AGREEMENT_FK
Java Field: onboardingAgreement
Status: Active
SQL Type: bigint(20)
Java Type: Long
Reference to the entity that represents onboard agreement document.
Added On: 05/16/16
SQL Column: ONBOARDING_BUSINESS_INFO_FK
Java Field: onboardingBusinessInfo
Status: Active
SQL Type: bigint(20)
Java Type: Long
Reference to the entity that represents information about business.
Added On: 04/21/17
SQL Column: ONBOARDING_PROFILE_CODE
Java Field: onboardingProfileCode
Status: Active
SQL Type: bigint(20)
Java Type: Long
Identifier of the processor used for onboarding of the merchants associated with a particular reseller. Assigned to the reseller.
Added On: 01/30/18
SQL Column: OPERATION_CL
Java Field: operationCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 10/16/18
SQL Column: OWNER_ID
Java Field: ownerId
Status: Active
SQL Type: bigint(20)
Java Type: Long
Added On: 01/30/18
SQL Column: PAGE_FORMAT
Java Field: pageFormat
Status: Active
SQL Type: varchar(5)
Java Type: String
Added On: 05/16/16
SQL Column: PHONE
Java Field: phone
Status: Active
SQL Type: varchar(15)
Java Type: String
Phone number used to discuss any occured processing issues.
Added On: 01/30/18
SQL Column: PORTFOLIO_FK
Java Field: portfolio
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 05/16/16
SQL Column: PORTFOLIO_CODE
Java Field: portfolioCode
Status: Active
SQL Type: int(11)
Java Type: Integer
Code of the portfolio that this record belongs to.
Added On: 10/16/18
SQL Column: PREV_ONBOARDING_APPLICATION_FK
Java Field: prevOnboardingApplication
Status: Active
SQL Type: bigint(20)
Java Type: Long
Added On: 10/21/16
SQL Column: PROCESSING_CONFIGURATION_SCRIPT
Java Field: processingConfigurationScript
Status: Active
SQL Type: varchar(63)
Java Type: String
Code of the processing application configuration.
Added On: 01/30/18
SQL Column: PROCESSING_PROFILE_FK
Java Field: processingProfile
Status: Active
SQL Type: bigint(20)
Java Type: Long
Added On: 04/21/17
SQL Column: PROFILE_ID
Java Field: profileId
Status: Active
SQL Type: varchar(15)
Java Type: String
Code of the onboarding profile assigned within the system.
Added On: 10/27/16
SQL Column: PROFILE_TYPE
Java Field: profileType
Status: Active
SQL Type: varchar(60)
Java Type: String
Type of the associated merchant's profile.
Added On: 10/16/18
SQL Column: PROVIDER_OPERATION_CL
Java Field: providerOperationCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 10/31/16
SQL Column: PROVIDER_PROFILE_CONFIGURATION_DATE
Java Field: providerProfileConfigurationDate
Status: Active
SQL Type: datetime
Java Type: Date
Date of the provider's profile configuration.
Added On: 10/31/16
SQL Column: PROVIDER_PROFILE_CONFIGURATION_STATUS_CL
Java Field: providerProfileConfigurationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Reference to the entity that represents enumeration of statuses that provider profile configuration can obtain.
Added On: 10/24/18
SQL Column: PROVIDER_REFERENCE_NUMBER
Java Field: providerReferenceNumber
Status: Active
SQL Type: varchar(30)
Java Type: String
Added On: 10/24/18
SQL Column: PROVIDER_RESPONSE_CODE
Java Field: providerResponseCode
Status: Active
SQL Type: varchar(5)
Java Type: String
Added On: 10/24/18
SQL Column: PROVIDER_RESPONSE_MESSAGE
Java Field: providerResponseMessage
Status: Active
SQL Type: varchar(1024)
Java Type: String
Added On: 10/26/23
SQL Column: RECURRING_FEES_BEGIN_DATE
Java Field: recurringFeesBeginDate
Status: Active
SQL Type: datetime
Java Type: Date
Added On: 10/26/23
SQL Column: REMITTANCE_START_DATE
Java Field: remittanceStartDate
Status: Active
SQL Type: datetime
Java Type: Date
Added On: 01/30/18
SQL Column: REQUEST_HOST
Java Field: requestHost
Status: Active
SQL Type: varchar(60)
Java Type: String
Added On: 10/16/18
SQL Column: REQUEST_TYPE
Java Field: requestType
Status: Active
SQL Type: varchar(20)
Java Type: String
Added On: 01/30/18
SQL Column: RESELLER_FK
Java Field: reseller
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 06/02/16
SQL Column: RESELLER_CODE
Java Field: resellerCode
Status: Active
SQL Type: int(11)
Java Type: Integer
Code of the reseller that is referred to the selected account.
Added On: 10/23/18
SQL Column: RESPONSE_CODE
Java Field: responseCode
Status: Active
SQL Type: varchar(5)
Java Type: String
Added On: 10/23/18
SQL Column: RESPONSE_MESSAGE
Java Field: responseMessage
Status: Active
SQL Type: varchar(421)
Java Type: String
Added On: 10/21/16
SQL Column: RETURN_URL
Java Field: returnUrl
Status: Active
SQL Type: varchar(255)
Java Type: String
Added On: 01/30/18
SQL Column: RETURN_URL_POLICY
Java Field: returnUrlPolicy
Status: Active
SQL Type: varchar(10)
Java Type: String
Added On: 05/16/16
SQL Column: SOCIAL_SECURITY
Java Field: socialSecurity
Status: Active
SQL Type: varchar(7)
Java Type: String
Social security number of the merchant.
Added On: 05/10/18
SQL Column: STAKE_PERCENTAGE
Java Field: stakePercentage
Status: Active
SQL Type: int(11)
Java Type: Integer
Added On: 05/16/16
SQL Column: STATE
Java Field: state
Status: Active
SQL Type: varchar(3)
Java Type: String
State code of the mailing address.
Added On: 05/16/16
SQL Column: STATUS_CL
Java Field: statusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Represents current status of the application.
Added On: 05/16/16
SQL Column: STREET1
Java Field: street1
Status: Active
SQL Type: varchar(128)
Java Type: String
Street (line 1) of the mailing address.
Added On: 05/16/16
SQL Column: STREET2
Java Field: street2
Status: Active
SQL Type: varchar(128)
Java Type: String
Street (line 2) of the mailing address.
Added On: 10/25/23
SQL Column: TAG_LIST
Java Field: tagList
Status: Active
SQL Type: varchar(50)
Java Type: String
Attributes:
Max Length:50
Pattern:
List of tags, used to control merchant settings during onboarding process.
Added On: 11/28/18
SQL Column: TERMINAL_CONFIGURATION_DATE
Java Field: terminalConfigurationDate
Status: Active
SQL Type: datetime
Java Type: Date
Added On: 11/28/18
SQL Column: TERMINAL_CONFIGURATION_STATUS_CL
Java Field: terminalConfigurationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 03/12/19
SQL Column: TERMINAL_ID
Java Field: terminalId
Status: Active
SQL Type: varchar(61)
Java Type: String
Added On: 11/22/17
SQL Column: TERMINAL_SETUP
Java Field: terminalSetup
Status: Active
SQL Type: varchar(63)
Java Type: String
Added On: 11/22/17
SQL Column: TERMINALS
Java Field: terminals
Status: Active
SQL Type: varchar(255)
Java Type: String
Added On: 10/21/16
SQL Column: TIME_ZONE
Java Field: timeZone
Status: Active
SQL Type: varchar(33)
Java Type: String
Time zone set for application.
Added On: 12/13/18
SQL Column: TITLE
Java Field: title
Status: Active
SQL Type: varchar(60)
Java Type: String
Added On: 08/09/17
SQL Column: USER_NAME
Java Field: userName
Status: Active
SQL Type: varchar(150)
Java Type: String
Name of the user that had submitted the onboarding application.
Added On: 03/28/18
SQL Column: VERIFICATION_PROFILE_FK
Java Field: verificationProfile
Status: Active
SQL Type: bigint(20)
Java Type: Long
Added On: 01/10/19
SQL Column: VERIFICATION_REQUEST_STATUS_CL
Java Field: verificationRequestStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 01/10/19
SQL Column: VERIFICATION_REQUEST_DATE
Java Field: verificationRequestStatusDate
Status: Active
SQL Type: datetime
Java Type: Date
Added On: 10/23/18
SQL Column: VERIFICATION_RESPONSE_STATUS_CL
Java Field: verificationResponseStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: Object
Added On: 10/23/18
SQL Column: VERIFICATION_RESPONSE_STATUS_DATE
Java Field: verificationResponseStatusDate
Status: Active
SQL Type: datetime
Java Type: Date
Added On: 02/21/19
SQL Column: VERIFICATION_STATUS_CL
Java Field: verificationStatusCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 05/16/16
SQL Column: ZIP_CODE
Java Field: zipCode
Status: Active
SQL Type: varchar(15)
Java Type: String
ZIP (or postal code) of the mailing address.