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
View Payment Plan
Type:
Form
Description:
Allows to view and modify a new payment plan.
Items:
View Payment Plan
Includes options allowing to manage a payment plan.
¦_
Close
Closes the form without saving any changes.
Payment Plan
Includes payment plan general information.
¦_
Payment Plan ID
Identifier of the object used for references; auto-incremented integer value.
References:
Payment Plan.
Id
¦_
Account
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:
Payment Plan.
Merchant Account Code
¦_
Create Date
Date when the record was created.
References:
Payment Plan.
Create Date
¦_
Type
Enumeration of possible types of payment plans.
References:
Payment Plan.
Payment Plan CL
¦_
Status
Represents current (or selected) status of the payment plan.
References:
Payment Plan.
Status CL
¦_
Billing Cycle
Reference to the entity that represents billing cycle associated with the payment plan.
References:
Payment Plan.
Billing Cycle FK
¦_
Renewal Amount
Renewal amount on the payment plan.
References:
Payment Plan.
Renewal Amount
¦_
Renewed Date
Renewed date of the payment plan.
References:
Payment Plan.
Renewed Date
¦_
Item
Reference to the entity that represents payment plan item that is applied as the basis for the billing processing.
References:
Payment Plan.
Item FK
¦_
change item
Allows to select a new item for the payment plan.
¦_
Tax
Tax charged on the payment plan's amount.
References:
Payment Plan.
Tax Amount
¦_
Seller Code
External identifier of the associated seller.
¦_
Parent Plan Code
Reference to the entity that represents code of the parent payment plan.
References:
Payment Plan.
Parent FK
¦_
Item Description
Short description of an item.
References:
Payment Plan.
Item Description
¦_
Change Item Description
Allows to add changes to the description of an associated item.
¦_
First Billing
Date when the first billing occured.
References:
Payment Plan.
First Billing Date
¦_
Next Processing Date
Date of the next payment processing.
¦_
Last Processing
Date when the last billing processing occured.
References:
Payment Plan.
Last Processing Date
¦_
Last Invoicing
Date when the last invoice was created.
References:
Payment Plan.
Last Invoicing Date
¦_
Last Update
Date when the payment plan was updated for the last time.
References:
Payment Plan.
Last Update Date
¦_
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
¦_
Length
Time period when the payment plan is active.
References:
Payment Plan.
Length
¦_
Value
Total value of the payment plan.
References:
Payment Plan.
Value
¦_
Deferred Length
Time period of the billing without invoice creation.
References:
Payment Plan.
Deferred Length
¦_
Deferred Value
Value of the billing without invoice creation.
References:
Payment Plan.
Deferred Value
¦_
Cancelled by
User that canceled the payment plan.
¦_
Cancellation Date
Date when the payment plan was cancelled.
References:
Payment Plan.
Cancellation Date
Payment Option
Includes payment information associated with a payment plan.
¦_
Account Number
Payment card number associated with the customer.
¦_
Name on Account
Name of the customer that the associated account belongs to.
¦_
Exp Date
Date when the card associated with an account will expire.
¦_
Street
Street of the customer's billing address.
¦_
City
City of the customer's billing address.
¦_
State
State of the customer's billing address. Consists of the two fields that allow to select a country and country's state.
¦_
ZIP
ZIP/Postal code of the customer's billing address.
Notes
Includes any additional notes associated with a payment plan.
Additional Info
Includes contract information associated with a payment plan.
¦_
Contract Effective Date
Date when the terms of the contract start.
References:
Contract.
Effective Date
¦_
Contract Expiration Date
Date when the terms of the contract end.
References:
Contract.
Expiration Date
Optional Groups
Includes information about the groups associated with a payment plan.
¦_
Group 1
Code of the optional group that includes any additional information that merchant needs.
References:
Payment Plan.
Ref Group Code1
¦_
Group 2
Code of the optional group that includes any additional information that merchant needs.
References:
Payment Plan.
Ref Group Code2
¦_
Group 3
Code of the optional group that includes any additional information that merchant needs.
References:
Payment Plan.
Ref Group Code3
¦_
Group 4
Code of the optional group that includes any additional information that merchant needs.
References:
Payment Plan.
Ref Group Code4
¦_
Group 5
Code of the optional group that includes any additional information that merchant needs.
References:
Payment Plan.
Ref Group Code5
¦_
Group 6
Code of the optional group that includes any additional information that merchant needs.
References:
Payment Plan.
Ref Group Code6
Charges
Includes information about the charges included in a payment plan.
¦_
Code
Identifier of the charge within an internal system.
References:
Charge.
Id
¦_
Create Date
Date when the record was created
References:
Charge.
Create Date
¦_
Type
References:
Charge.
Charge CL
¦_
Billing Date
Date when the charge is going to be included in the billing.
¦_
Is Prepaid
References:
Charge.
Is Prepaid
¦_
Freeze
Allows to freeze a payment plan.