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
New Payment Plan
Type:
Form
Description:
Allows to create new payment plan.
Modes:
Ignore
Credit Card
Bank Account
Items:
Save
Saves all changes on the form.
Close
Closes the form without saving any changes.
New Payment Plan
Includes payment plan general information.
¦_
Amount
The amount of money charged every time billing occurs for this payment plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.
References:
Payment Plan.
Amount
¦_
Creator
Code of the user that created the payment plan.
¦_
Description
Description of the payment plan.
¦_
Item Description
Short description of an item.
References:
Payment Plan.
Item Description
¦_
Terms
Allows to select the terms applied to the payment.
¦_
Credit Card
Indicates that credit card terms are applied to the payment.
¦_
Bank Account
Indicates that bank account terms are applied to the payment.
¦_
Unlimited
Indicates that no terms are applied to the payment.
¦_
# Payments
Indicates that terms depending on the number of payments are applied to the payment.
Billing
Billing settings associated with the payment plan.
¦_
Cycle Type
Enumeration of possible values for periods of the billing cycle repeating.
References:
Billing Cycle.
Time Cycle CL
¦_
Weekly
Indicates that billing is done on a weekly basis.
¦_
Biweekly
Indicates that billing is done once in two weeks.
¦_
Monthly
Indicates that billing is done on a monthly basis.
¦_
Quarterly
Indicates that billing is done once in three months.
¦_
Semiannually
Indicates that billing is done once in six months.
¦_
Annually
Indicates that billing is done once in a year.
Day
The day of a month when billing occurs.
References:
Billing Cycle.
Day
Next Billing
Date when the next billing will occur.
References:
Billing Cycle.
Next Billing Date
Credit Card
Includes credit card information.
¦_
Cards
Allows to select credit card from the list of available cards.
¦_
Existing
Allows to select existing credit card of the customer or create a new one.
¦_
Name on Account
Name of the bank account or credit card holder.
References:
Payment Option.
Holder Name
¦_
Credit Card #
Number of a payment card or bank account.
References:
Payment Option.
Number
¦_
Exp Date
Expiration date of the credit card.
¦_
CSC
Card security code (also referred as CVV for Visa and CSV for MasterCard) of the credit card selected for the transaction.
¦_
Same As Customer's Home Address
Allows to copy information from the customer's home address.
¦_
Street
Street name of the user's mailing address.
References:
Payment Option.
Street1
¦_
City
City name of the user's mailing address.
References:
Payment Option.
City
¦_
State
Code of the state associated with a user's mailing address.
References:
Payment Option.
State
¦_
ZIP Code
ZIP or postal code associated with a user's mailing address.
References:
Payment Option.
ZIP Code
Bank Account
Includes bank account information.
¦_
Existing
Allows to select existing bank account of the customer or create a new one.
¦_
Name on Account
Name of the bank account or credit card holder.
References:
Payment Option.
Holder Name
¦_
Account #
Number of a payment card or bank account.
References:
Payment Option.
Number
¦_
Routing #
Routing number of the bank account selected for the transaction.
¦_
Savings
Indicates whether the bank account used for transaction is a savings bank account.
¦_
Same As Customer's Home Address
Allows to copy information from the customer's home address.
¦_
Street
Street name of the user's mailing address.
References:
Payment Option.
Street1
¦_
City
City name of the user's mailing address.
References:
Payment Option.
City
¦_
State
Code of the state associated with a user's mailing address.
References:
Payment Option.
State
¦_
ZIP Code
ZIP or postal code associated with a user's mailing address.
References:
Payment Option.
ZIP Code