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
Onboarding Application Wizard (Affiliate)
Type:
Form
Description:
Provides access to onboarding wizard that allows onboarding of an affiliate.
Tabs:
General
view
Business
view
Estimates
view
Settings
view
Process
view
Items:
Onboarding Wizard
Includes settings that allow affiliate creation with the help of onboarding wizard.
¦_
Save
Saves all information on the form.
¦_
Close
Closes the form without saving any changes.
¦_
Previous
Returns to the previous step.
¦_
Next
Proceeds to the next step.
¦_
Skip
Skips the current step.
Select Portfolio
Includes the list of available portfolios and associated onboarding profiles.
Portfolio
Includes the list of available portfolios. After a portfolio is selected, the list of the processors available for this portfolio will be shown.
Onboarding Profile
Includes the list of available onboarding profiles associated with the selected portfolio.
General
Provides access to general affiliate settings.
Detail
Includes general settings that identify the merchant within the system.
¦_
Underwriting
¦_
Verify
Requests verification of the Tax ID specified for the affiliate.
¦_
Portfolio
Code of the portfolio that this record belongs to.
References:
Onboarding Application.
Portfolio Code
¦_
ID
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.
References:
Onboarding Application.
Merchant Account Code
¦_
Active
Indicates whether the record is active and can process through the system.
References:
Merchant.
Is Active
¦_
Code
Secondary identifier of the merchant/merchant account which can be used for cross-referencing records between the gateway and integrated systems.
References:
Onboarding Application.
Merchant Ref Code
¦_
Name
Name of the affiliate.
¦_
Time Zone
This field consists of two parts - a code of the country and a code of the time zone.
Time zone set for application.
References:
Onboarding Application.
Time Zone
Submerchant
Includes information about sub-merchant assigned to the affiliate.
¦_
Name
Name of the sub-merchant.
References:
Onboarding Application.
Submerchant Name
¦_
Code
Secondary identifier of the sub-merchant which can be used to cross-reference records between UniPay and integrated systems.
References:
Onboarding Application.
Submerchant Ref Code
Business
Provides access to various business information about the affiliate.
Business Information
Includes business information about the affiliate.
Business Name
¦_
Legal
Legal name of the business company.
References:
Onboarding Business Info.
Legal Name
¦_
Ownership Type
Represents the type of ownership structure.
References:
Onboarding Business Info.
Onboarding Ownership Structure
¦_
Tax ID
Identifier of the assigned federal tax.
References:
Onboarding Business Info.
Tax ID
Legal Address
Includes information about business legal address of the affiliate.
¦_
Copy Data From
Allows to copy information from the selected source.
¦_
Owner Address
Allows to copy information from the primary owner address.
Street
Street (line 1) of the business company mailing address.
References:
Onboarding Business Info.
Street 1
City
City of the mailing address.
References:
Onboarding Business Info.
City
State
State code of the business company mailing address.
References:
Onboarding Business Info.
State
Zip Code
ZIP (or postal) code of the business company mailing address.
References:
Onboarding Business Info.
ZIP Code
Primary Owner
Includes address of the primary owner.
¦_
Copy Data From
Allows to copy information from the selected source.
¦_
Legal Address
Allows to copy information from the legal address.
Personal
Includes personal information about the primary owner.
¦_
First Name
First name of the merchant.
References:
Onboarding Application.
First Name
¦_
Last Name
Last name of the merchant.
References:
Onboarding Application.
Last Name
¦_
Email
Email address used to send any notifications or discuss any processing issues.
References:
Onboarding Application.
Email
¦_
Phone
Phone number used to discuss any occured processing issues.
References:
Onboarding Application.
Phone
¦_
Birth Date
Date of birth of the merchant.
References:
Onboarding Application.
Birth Date
¦_
SSN
Social security number of the merchant.
References:
Onboarding Application.
Social Security
Address
Includes address of the primary owner.
¦_
Street (line 1)
Street (line 1) of the mailing address.
References:
Onboarding Application.
Street1
¦_
Street (line 2)
Street (line 2) of the mailing address.
References:
Onboarding Application.
Street2
¦_
City
City of the mailing address.
References:
Onboarding Application.
City
¦_
State
State code of the mailing address.
References:
Onboarding Application.
State
¦_
Zip Code
ZIP (or postal code) of the mailing address.
References:
Onboarding Application.
ZIP Code
Estimates
Provides access to affiliate's estimates.
Estimates (Transaction Amount)
Includes settings related to estimated transactions' count and volume.
¦_
Estimation Period
Enumeration of possible time periods for which transaction volume and average transaction amount are defined.
References:
Business Info.
Estimation Period CL
¦_
Annualy
Indicates that transaction volume and average transaction amount are defined for a year.
¦_
Daily
Indicates that transaction volume and average transaction amount are defined for a day.
¦_
Monthly
Indicates that transaction volume and average transaction amount are defined for a month.
¦_
Weekly
Indicates that transaction volume and average transaction amount are defined for a week.
Total Volume
Estimated number of the payment card transactions within a year.
References:
Onboarding Business Info.
Annual Cards Volume
Avg Ticket
Estimated average amount of the payment card transactions within a year.
References:
Onboarding Business Info.
Avg Cards Transaction Amount
Max Ticket
Maximum allowed amount of transactions.
References:
Onboarding Business Info.
Max Transaction Amount
Card Type Distribution
Includes settings related to money distribution by the card type.
¦_
Type
Type of the payment card.
¦_
Lock
Allows to lock percentage rate for the selected card type.
¦_
%
Percentage of estimated transaction amount for the selected card type.
¦_
Tx Volume
Estimated transaction volume for the selected card type.
¦_
Tx Count
Estimated transaction count for the selected card type.
Entry Mode Distribution
Includes settings related to money distribution by the entry mode.
¦_
Type
Type of the entry mode.
¦_
Lock
Allows to lock percentage rate for the selected entry mode.
¦_
%
Percentage of estimated transaction amount for the selected entry mode.
¦_
Tx Volume
Estimated transaction volume for the selected entry mode.
¦_
Tx Count
Estimated transaction count for the selected entry mode.
Settings
Provides access to additional affiliate settings.
Remittance
Includes remittance settings of the affiliate.
¦_
Remitter
Code of the remitter assigned to the record.
References:
Onboarding Business Info.
Remitter Code
Deposit Information
Includes deposit settings of the affiliate.
¦_
Bank Name
Name of the deposit account assigned by the bank.
References:
Onboarding Business Info.
Deposit Bank Name
¦_
Holder Name
Name of the deposit account holder.
References:
Onboarding Business Info.
Deposit Holder Name
¦_
Account #
Number of the deposit account assigned by the bank.
References:
Onboarding Business Info.
Deposit Account Number
¦_
Routing #
Routing number of the bank deposit account.
References:
Onboarding Business Info.
Deposit Routing Number
Charge Information
Includes charge settings of the affiliate.
¦_
Account Usage
Reference to the entity that represents possible values for account usage.
References:
Onboarding Business Info.
Account Usage CL Charge
¦_
Fee Only
Indicates that only fees are withdrawn from the selected bank account.
¦_
Negative Balance
Indicates that fees, chargebacks, returns and adjustments are withdrawn from the selected bank account.
¦_
Not Used
Default value.
Indicates that no money is withdrawn from the selected bank account.
Bank Name
Name of the charge account assigned by the bank.
References:
Onboarding Business Info.
Charge Bank Name
Holder Name
Name of the holder that a charge account is assigned to.
References:
Onboarding Business Info.
Charge Holder Name
Account #
Number of the charge account.
References:
Onboarding Business Info.
Charge Account Number
Routing #
Routing number of the bank associated with merchant's deposit operations.
References:
Onboarding Business Info.
Charge Routing Number
Process
Provides access to affiliate's verification process.
Process List
Includes detailed information about affiliate's verification process.
¦_
Stage
Stage of the onboarding process.
¦_
Date
Date and time of the stage completion.
¦_
Status
Status of the stage completion.
¦_
Status Update
Updates current status of the onboarding process.