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
Service User
Type:
Form
Description:
Allows to add a new service user to the system.
Items:
Service User Details
Includes information required for the creation of a new service user within the system.
¦_
Actions
Allows selection of an action that will be applied to the selected service user.
¦_
Reset Password
Resets password for the selected user.
¦_
Generate SDK Key
Generates a key for mobile SDK for the selected user.
Opens Form:
Generate SDK Key
Save
Saves all changes on the form.
Close
Closes the form without saving any changes.
Detail
Includes additional information related to the new user within the system.
¦_
ID
Identifier of a user that is used for references.
¦_
Create Date
Date when the User was created.
References:
User.
Create Date
¦_
Active
Indicates whether the user account is active within the system.
The value is based on the userStatusCl field value.
References:
User.
Is Active
¦_
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
Full Name
Full name of the user represented by this user account.
References:
User.
Name
User Name
Username associated with this user account.
References:
User.
User Name
¦_
api-
Mandatory prefix automatically added to all service users' usernames.
Send password by email
Indicates whether the password would be send to the user or to the creator.
¦_
To User
The password from the accound would be sent to the user directly.
¦_
To Creator
The password from the accound would be sent to the creator and then to the user.
¦_
Include SDK Key
Indicates whether a key for mobile SDK is included in email with service user's password.
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
Failed Login Count
Number of failed login attempts that are allowed before a user gets blocked.
¦_
Reset
Resets the count of invalid login attempts for this user.
Raw Account Data Mode
Indicates how the raw account data is handled by the user.
References:
User.
Raw Account Data Mode Classifier
¦_
HPP usage: disallowed; API usage:...
Indicates that the user is not allowed to enter raw account data via both API and hosted payment page.
¦_
HPP usage: allowed; API usage: di...
Indicates that the user is allowed to enter raw account data via hosted payment page and not allowed to enter raw account data via API.
¦_
HPP usage: allowed; API usage: al...
Indicates that the user is allowed to enter raw account data via both API and hosted payment page.
¦_
Response Msg Display Policy
Defines how error messages are displayed during the API processing.
References:
User.
Response Message Display Policy
¦_
User Message
Indicates that an error message received via API includes a user message.
¦_
Developer Message
Indicates that an error message received via API includes a developer message.
¦_
Hint
Indicates that an error message received via API includes a hint.
Time Zone
Allows to select an appropriate time zone for a new user.
¦_
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
Allows to select the default merchant account from the list of available accounts.
Opens Form:
Search Form
Privileges
Includes the list of resources that will be available for the user.
¦_
Processing API
Indicates whether processing API is available for the user.
¦_
Management API
Indicates whether management API is available for the user.
¦_
Billing API
Indicates whether billing API is available for the user.
¦_
Onboarding API
Indicates whether onboarding API is available for the user.
¦_
TMS API
Indicates whether TMS (terminal management system) API is available for the user.
¦_
Reporting API
Indicates that the service user has access to the reporting API.
¦_
Detokenization
Indicates whether detokenization API operation is available for the user.
Contact Information
Includes contact information of a new user.
¦_
Street
Street line 1 of the user's mailing address.
References:
User.
Street1
¦_
Street
Street line 2 of the user's mailing address.
References:
User.
Street2
¦_
City
City name of the user's mailing address.
References:
User.
City
¦_
Country
Allows to select a country of a user's mailing address.
¦_
State
Allows to select a state of a user's mailing address.
State of the user's mailing address.
References:
User.
State
¦_
ZIP Code
ZIP code of the user's mailing address.
References:
User.
ZIP Code
¦_
Primary Phone
Phone number associated with this user account.
References:
User.
Phone
¦_
Cell Phone
Cell phone number associated with this user.
References:
User.
Cell Phone
¦_
Evening Phone
Evening phone number associated with this user account.
References:
User.
Evening Phone
¦_
Fax
Fax number associated with this user.
References:
User.
Fax
¦_
Email
Email associated with this user account.
References:
User.
Email
Notes
Any additional notes related to new user within the system.
Generate SDK Key
Includes options that allows generation of a new SDK key.
¦_
Send
Sends the generated password to the selected email address(es).
¦_
Close
Closes the form without saving any changes.
¦_
Send SDK Key to Selected User
Email address of the selected user.
¦_
Select
Indicates whether a new SDK key will be sent to the specified address.
Send SDK Key to Current User
Email address of the current user.
¦_
Select
Indicates whether a new SDK key will be sent to the specified address.
¦_
Enter Current Service User Passwo...
Current password of the selected service user, which is required to be entered for generation of a new SDK key.