Documentation
for developers and administrators
Home
APIs
Processing
Billing
Management
Webhooks
Manuals
Terminology
User Guides
User Interface Reference
How-To Tutorials
Lessons
Data Dictionaries
UniCore
UniCharge
UniBill
Build
Properties Definition
Resources (Directory Structure)
Zip and Country Codes
Development
Log Files
Permissions
JNDI Names
Job Queues
Reference Materials
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
Entire website
This section only
Console
Home
Home
Customers
Customers
New Customer
Customer Auditing
Setup
Billing Cycles
Items
Taxes
Billing Profiles
Adjustment Reasons
Account Groups
Actions
Letters
Emails
Notes
Documents
Billings
Transactions
New Sale (Card)
New Sale (Direct Debit)
New Refund (Card)
New Refund (Direct Debit)
Tokens
Transactions
Subscriptions
Chargebacks
Chargebacks
Remittance
Merchant Statement List
Balances
Charges
Modify Charge
New Charge
Reports
Reports
Submissions
Batch List
Files
Equipment
Terminals
Terminal Order List
Management
Merchant Perspective
New
New Merchant
New Merchant (Extended)
New Account (Extended)
New Merchant (Provisioning)
Provisioning New Merchant
Provisioning New Account
Onboarding Application Wizard (Merchant)
Onboarding Application Wizard (Account)
Onboarding Application Wizard (Affiliate)
Manage Selection
Select Merchants (Modify Selection)
Select Single Merchant
Details
General
Settings (Remittance)
Deposit
Settings (Processing)
Business
Owners
References
Limits
Profiles
Rules
Letters
Emails
Convenience Fees
Customer Fees
Settings (Billing)
Branding Profile (Merchant)
Accounts
Accounts
Terminals
Terminals
Processing
Transactions
View Transaction
Chargebacks
Tokens
View Transaction (Split-In/Pull-In)
View Transaction (Split-Out/Pull-Out)
Processor Transactions
View Provider Transaction
Transaction
Subscriptions
View Subscription Transaction
Remittance
Adjustments List
Commissions
Fees
Merchant Statement List
Distributions
Split Schema
Balances
Charges
Modify Charge
New Charge
Submissions
Batch List
Files
View Batch
Resources
Merchant Labels
Pages
Equipment
Terminal Order List
Reports
Reports
Security
Users List
Access Policy Roles
Reseller Perspective
New
New Reseller
Details
Reseller Details
Custom Fields
Branding Profile (Reseller)
Defaults
Settings Defaults
Merchants
Merchants List
Onboarding
Onboarding Applications
Agreements
Remittance
Reseller Statements Breakdown
Reseller Statement Breakdown Modify
Reseller Statement Detail Modify
Commissions
Reseller Statement
Security
Users List
Access Policy Roles
Equipment
Configurations
Terminals
Terminal Order List
Reports
Reports
Reports
Portfolio Perspective
New
New Portfolio
Details
Portfolio Details
Branding Profile (Portfolio)
Defaults
Settings Defaults
Entities
Merchants
Resellers
Channels
Equipment
Terminal Update Profile List
Update Search
Repository
Fulfillment Center
Terminals
Parameters
Terminal Messages
Onboarding
Applications
Agreements
Configurations
Configurations
Billing Configurations
Profiles
Distributions
Distributions
Remittance
Pricing Template List
Taxes
Modify Tax
Announcements
Announcements
Agreements
Merchant Agreements
Security
Users List
Access Policy Roles
Profiles
Provisioning Settings
Facilitator Profile List
Onboarding *
Processing
User Perspective
New
Human User
Service User
Details
Human User Details
Service User Details
Merchants
Merchants List
Resellers
Resellers List
Portfolios
Portfolios List
Security
Security
Terminal Perspective
Details
Terminal Details
Parameters
Terminal Parameters
Updates
Terminal Updates
Logs
Logs
Terminal Migration Log
Distributions Perspective
New
New Vendor
New Holding Account
Details
Distributions Details
Statements
Statements
Fulfillment Perspective
New
New Fulfillment Center
Details
Fulfillment Details
Users
Users
Shipping
Shipping
Orders
Terminal Order List
Configurations
Configurations
Keys
Keys
Models
Models
Administration
Setup Perspective
Error Codes
Error Codes
Email Templates
Email Templates
Response Codes
Response Codes
Holidays
Holidays
Note Templates
Note Templates
Security
Access Policy Roles
Blacklist
Blacklist
System Perspective
Statistics
Merchant Financial Statistics
IQ
Database Querying Module
Log Querying Module
Vel Tracking
Velocity Tracking
Branding
Branding
Branding Profile (System)
Keys
Decryption Keys
Agreements
User Agreements
Jobs
Send Message
Manual Remittance Post Statements
CLI Command
Job Object
Job Messages
Processing Lock
Logs
Browse Logs
Analyze Logs
Transaction Logs
Server Log
Files
FTP Gates
File Store
Sanitization
Sanitization Profile
Reporting
Reporting
Modify Report
Providers
Provider
Codes
Import Format
Resource Code
Currency Sign
System
Settings
Diagnostic
System
Audit Perspective
Changes
Merchants
Resellers
Users
Terminals
Portfolios
Portfolios
Users
Users List
Analysis
Analysis
Errors
Errors
Transactions
Transactions Audit
Monitoring Perspective
Manage Selection
Select Merchants (Modify Selection)
FTP Gates
FTP Gates
Transactions
Transactions
Sub Batch
Sub Batch
Statements
Merchant Statement List
Statement Reconciliation
File Store
File Store
Account Profile
Merchant Account Profile
Billing History
Billing History
Providers
Provider Profile
Provider Account
Jobs
Send Message
Manual Remittance Post Statements
Job Object
Job Messages
Processing Lock
Camel Routes
Reporting
Processing
Processor Reconciliation
Processing Reconciliation
Transaction Summary
Transaction Detail
Remittance
Reconciliation
Queue
Reports Queue
Reports
Reports
Console perspective (new)
Items
Human User Details
Type:
Form
Description:
Provides access to detailed information about the selected human user.
Items:
Human User Details
Includes information about the selected human user.
¦_
Actions
Allows to apply actions to the selected human user.
¦_
Reset Password
Allows to reset password for the selected human user.
Opens Form:
Reset Password
Save
Saves all changes on the form.
Close
Closes the form without saving any changes.
Detail
Includes additional information related to the user within the system.
¦_
ID
Identifier of the object used for references; auto-incremented integer value.
References:
User Role.
Id
¦_
Create Date
Date when the User was created.
References:
User.
createDate
¦_
Status
Status of the user within the gateway.
¦_
Active
Indicates that the user is active.
¦_
Inactive
Indicates that the user is inactive.
¦_
Pending Approval
Indicates that the user is waiting for review. In this status, the user is inactive yet within the gateway.
¦_
Unapproved
Indicates that the user was not approved during the review.
Full Name
First name and last name of the user.
User Name
Note:
This field is used to create both Service and Human Users.
Username associated with this user account.
References:
User.
userName
Owner
Reference to the entity that represents possible types of the owner.
Values can be the following:
S
- System
P
- Portfolio
R
- Reseller
M
- Merchant
C
- Customer
U
- User
F
- Fulfillment Center
References:
User.
Owner Cl
¦_
Owner Code
Internal code of the user.
References:
User.
Owner Code
Security Level
Indicates security level for this user.
References:
User.
Security Level
Password
Note:
The passwords are stored as SHA1 hash. This field is used to create both Service and Human Users.
Password associated with this user account.
'Note: 'The passwords are stored as SHA1 hash.''
References:
User.
password
¦_
Password
Allows to enter manually or generate automatically a new password.
¦_
Enter
Allows to enter a new password manually.
¦_
Generate
Allows to generate a new password automatically.
Password Expiration Date
Date after which the current password is no longer valid and must be changed. The field is used to enforce strong password policy that requires regular password reset.
Expiration period is controlled by a system property (unipay.system.user-password-expiration-period) and is equal to 90 days by default.
References:
User.
Password Expiration Date
¦_
Must change password at next logo...
Indicates whether the password must be changed at next logon.
Failed Login Count
Number of failed login attempts.
References:
User.
Failed Login Count
¦_
Reset
Allows to reset failed login count field.
Raw Account Data Mode
Controls how a user can handle raw card data within the gateway.
¦_
UI usage: allowed
Indicates that the user is allowed to enter raw account data.
¦_
UI usage: disallowed
Indicates that the user is not allowed to enter raw account data.
Time Zone
Represents the time zone associated with this user.
References:
User.
timeZone
¦_
Time Zone (Country)
Allows to choose an appropriate country from the list.
¦_
Time Zone (Code)
Allows to choose an appropriate time zone code for a new user.
Default Merchant Account
Note:
This field is used to create both Service and Human Users.
Code of the merchant account, which used as a default value when merchant account selection for this user is required.
The value is often used on UI to initialize some of the forms with default merchant account selection. The merchant account must belong to the default merchant associated with this user.
References:
User.
defaultMerchantAccountCode
General
Includes general information related to the user within the system.
¦_
Function Policy
Allows to select a function associated with this user account.
Regulates function abilities of the user within the system.
References:
User.
Function Policy
¦_
A - Collections Agent
Indicates whether collections agent function policy is selected for this user.
¦_
M - Chargebacks Manager
Indicates whether chargebacks manager function policy is selected for this user.
¦_
S - Sales Person
Indicates whether sales person function policy is selected for this user.
¦_
Security Question
Security question selected by this user for the case when the password is lost.
References:
User.
Security Question
¦_
Security Answer
Security answer to the security question, selected by this user.
References:
User.
Security Answer
¦_
Agreement Acceptance Day
Date when user accepted the licence agreement.
References:
User.
licenseAgreementAcceptanceDate
¦_
Reset
Allows to reset the agreement acceptance day field.
Contact Information
Includes contact information related to the user within the system.
¦_
Street
Street name of the user's mailing address.
¦_
Street (line 2)
Street name of the user's mailing address.
¦_
City
City name of the user's mailing address.
References:
UserContactInfo.
city
¦_
Country
Allows to select country associated with user's mailing address.
¦_
State
Allows to select state associated with user's mailing address.
¦_
Zip Code
ZIP code of the user's mailing address.
References:
UserContactInfo.
zipCode
¦_
Primary Phone
Phone number associated with this user account.
References:
UserContactInfo.
primaryPhone
¦_
Cell Phone
Cell phone number associated with this user.
References:
UserContactInfo.
cellPhone
¦_
Evening Phone
Evening phone number associated with this user.
¦_
Fax
Fax number associated with this user.
References:
UserContactInfo.
fax
¦_
Email
Email associated with this user account.
References:
UserContactInfo.
email
Notes
Includes any additional notes related to the user within the system.
Security Image
Includes security image options of the user.
¦_
Change
Allows to change security image of the user.
The button opens the appropriate popup.
Select Category
Includes list of categories of the security images.
¦_
Close
Closes the form without saving any changes.
¦_
Animals
Allows to open the animal category list of security images.
¦_
Characters
Allows to open the characters category list of security images.
¦_
Faces
Allows to open the faces category list of security images.
¦_
Back
Returns to the selection of the category.
¦_
Close
Closes the form without saving any changes.