Data Dictionary


Name Description  
java.io Objects:
File Represents java.io.File class. Only required properties are exposed. For full class definition please see Java Doc. view   xml
Serializable view   xml
iapp.services Objects:
Classifier view   xml
Interceptable view   xml
Referencable view   xml
Server Object view   xml
atlas.services Objects:
Abstract Job Message AbstractJobMessage view   xml
unipay.core Objects:
Realtime Transaction Represents information about realtime transaction. view   xml
Transaction Data view   xml
java.lang Objects:
Cloneable view   xml
api.unibill.innerclasses Objects:
Subscription Pending Adjustment view   xml
UniBill Objects:
Account Activity Entity that represents information about current activity of any specified account. view   xml
Account Activity Classifier Enumerates types of financial transactions that can occur on a customer's account. view   xml
Account Balance view   xml
Account Group Code view   xml
Account Transaction view   xml
Account Updater History view   xml
Account Updater History Detail view   xml
Action view   xml
Action Code view   xml
Activity Cause view   xml
Address view   xml
Address Classifier Enumeration of possible types of addresses available in the system. view   xml
Address Source Classifier Enumeration of possible places or actions to retrieve the address information. view   xml
Adjustment view   xml
Adjustment Classifier Enumeration of possible adjustment types. view   xml
Adjustment Reason Code Enumerates the list of reasons for adjustments of the payment plan. view   xml
Agent Commission view   xml
Asset Transaction view   xml
Asset Transaction Classifier Enumerates types of asset transactions. view   xml
Balancing Summary view   xml
Billing Represents a combination of billing cycle and billing profile used paytment processing. view   xml
Billing Audit Log view   xml
Billing Audit Log Detail view   xml
Billing Credit Agency Transaction view   xml
Billing Cycle Entity that represents settings of the billing cycle. view   xml
Billing Cycle Activity Entity that represents billing cycle activity information and configuration settings. view   xml
Billing Cycle Activity Classifier Enumeration of possible billing cycle activities available in the system. view   xml
Billing Cycle Classifier view   xml
Billing File Store Content view   xml
Billing History Entity that represents information about billing history of the specific account. view   xml
Billing History Classifier Entity that represents billing history records available in the system. view   xml
Billing History Detail view   xml
Billing Profile Represents all necessary information included in billing profile that defines which invoices should be included into the payment while creation. view   xml
Capture Info view   xml
Charge view   xml
Charge Classifier view   xml
Claim Classifier view   xml
Client Transaction view   xml
Commission Classifier Enumeration of possible commission to be charged depending on the type of action. view   xml
Commission Status Classifier Enumeration of possible comission statuses. view   xml
Contract view   xml
Contract Classifier view   xml
Contract Status Classifier Enumeration of possible contract statuses. view   xml
Credit Agency Delete Classifier view   xml
Credit Agency Dispute Classifier view   xml
Credit Agency Status Classifier Enumeration of possible credit agency statuses. view   xml
Credit Agency Transaction Status Classifier Enumeration of possible credit agency transaction statuses. view   xml
Customer Represents information about the customer. view   xml
Customer Account view   xml
Customer Account Status Classifier Represents states/statuses of a customer account. view   xml
Customer Classifier Enumeration of possible customer types available in the system. view   xml
Decline Classifier Enumeration of possible transaction decline types. view   xml
Deferred Revenue Statistics Records consumption of prepaid services (paid-in-full contracts) over time. The statistics is generated on monthly basis and consumption is recorded using day as a basic unit.

The statistics is generated based on information in [o:Contract] and [o:Adjustment] objects taking into account effective and expiration dates of the contract, cancellations and freezes.
view   xml
Document view   xml
Document Code view   xml
Email view   xml
Email Address view   xml
Email Classifier Enumeration of possible customer's (or merchant's) email address types. view   xml
Email Code view   xml
Email Confirmation view   xml
Email Confirmation Classifier Enumeration of possible email confirmation notifications available in the system. view   xml
Email Status Classifier Enumeration of possible email statuses. view   xml
Emailing History view   xml
Invoicing History view   xml
Invoicing History Detail view   xml
Item view   xml
Letter view   xml
Letter Code view   xml
Letter Status Classifier Enumerates possible statuses within letter processing life cycle. view   xml
Note view   xml
Note Code view   xml
Object Classifier Enumeration of possible values of objects, that can be used as the creteria for selection for the velocity rule. view   xml
Object Link view   xml
Payment Option Represents information about payment option associated with the customer. view   xml
Payment Plan view   xml
Payment Plan Classifier Enumeration of possible types of payment plans. view   xml
Payment Plan Statistics view   xml
Payment Plan Status Enumeration of possible statuses of the payment plan. view   xml
Phone view   xml
Phone Classifer view   xml
Plan view   xml
Return Classifier view   xml
Return Fee view   xml
Revenue Transaction view   xml
Review Classifier Enumeration of possible review process stages. view   xml
Scheduled Payment view   xml
Scheduled Payment Status Classifier Enumeration of possible scheduled payment statuses. view   xml
Signature view   xml
Skip Trace Classifier view   xml
Skip Trace Mode Classifier view   xml
Skip Tracing History view   xml
Skip Tracing History Detail view   xml
Subscription Adjustment Classifier view   xml
Subscription Status Classifier view   xml
Suffix Classifier view   xml
Tax view   xml
Time Cycle Classifier Enumeration of possible time cycle types available in the system. view   xml
Title Classifier Enumeration of possible titles used in various notifications to address a client. view   xml
UniCharge Objects:
Notification Event view   xml
Notification Policy view   xml
Notification Transaction Content view   xml
Access Token Updatable view   xml
Account Classifier Enumerates possible account types that can be used for electronic payments. view   xml
Account Level Classifier Enumerates customer's level based on the application usage. view   xml
Account Processing Policy view   xml
Account Profile Status Classifier view   xml
Account Source Classifier Enumerates possible values of account source. view   xml
Account Store view   xml
Account Type Classifier Enumeration of possible account types available in the system. view   xml
Account Update Action Classifier Enumeration of possible account update actions. view   xml
Account Update Subscription Transaction Entity that represents information included in account update subscription. view   xml
Account Update Transaction Entity that represents account update transaction information. view   xml
Account Updater Profile Entity that represents cnfiguration settings for account updater service. view   xml
Account Updater Tsys Profile view   xml
Account Verification Profile view   xml
Aex Verification Profile view   xml
Aex Verification Transaction view   xml
Aggregation Cycle view   xml
Aggregation Frequency Classifier Enumeration of possible aggregation frequency types. view   xml
Aggregation Level Classifier Enumeration of possible levels that aggregation can be done on within the system. view   xml
Algorithm Classifier Enumeration of encryption algorythms for keys registry. view   xml
Anb B2b Processing Cost view   xml
Anb B2b Processing Cost Batch view   xml
Anb B2b Processing Cost Type Classifier view   xml
Anb B2b Profile view   xml
Attachment Content Source Classifier Enumerates possible origins of the attachments. Attachments are usually either generated reports or digital documents and are associated with a specific application (the one that the report belongs to or the one that produced the digital document). view   xml
Au FirstData Profile Classifier Enumerates possible values for FirstData account updater profiles. view   xml
Bancomer Auth Retail Transaction Entity that represents information about Bancomer real-time transaction. view   xml
Bank Card Classifier Enumerates possible types of a credit card. view   xml
Bank Info view   xml
Batch Entity that represents information about collection of transactions that are processed together. Batch processing is used in two situations:
  • Realtime batches - are used for settlements of pre-authorized transactions.
  • File batches - are used to process together card not present transactions (authorization and settlement) of recurring nature such as bill payments, subscription payments, etc.
view   xml
Batch Code Registry view   xml
Batch Emulator Profile Configuration settings for batch emulator processing. view   xml
Batch Status Classifier view   xml
Batch Uni Pay Profile Represents information about UniPay batch processing profile. view   xml
Blacklist Entity that represents blacklist information and settings.

Blacklist is a list of accounts that were previously processed and came back as irrecoverable (hard) ACH returns. Irrecoverable ACH returns include cases when account is closed or invalid.

Blacklists are introduced to prevent problems induced by the fact that ACH transactions do not get approved or declined in real-time like credit card transactions. To eliminate waiting for a certain ACH return, every ACH transaction is checked against a blacklist before it is submitted to the bank for processing.
view   xml
Capture Processing Mode Classifier Reference to the entity that represents enumeration of possible ways to handle capture processing. view   xml
Card Classifier Enumeration of possible states of a credit card.
The values can be the following:
'V' - Indicates that the card is not physically present.
'P' - Indicates that the card is physically present.
view   xml
Card Scheme Classifier Enumeration of possible card schemes available in the system. view   xml
Cards Cost Profile Configuration settings for loading of card costs from a specific processor. view   xml
Case Classifier view   xml
Case Resolution Code view   xml
CC Batch Emulator Batch view   xml
CC Batch Emulator Profile Configuration settings for batch credit card processing through batch emulator. view   xml
CC Profile Entity that represents configuration settings for batch credit card processing through the specific processor. view   xml
Charge Item Reference to the entity that represents information about the item associated with the transaction. view   xml
Charge Transaction Base object for transactions of type Sale. During Sale transaction money is transferred from a customer to a merchant. view   xml
Charge Transaction Addenda Includes additional information about a transaction. view   xml
Charge Transaction Detail Represents detailed information about charge transaction. view   xml
Charge Transaction Distribution view   xml
Charge Transaction Log view   xml
Charge Transaction Split Entity that represents information about split funding associated transaction. view   xml
Charge Transaction Tag Data view   xml
Chargeback Activity Classifier Enumeration of possible chargeback activity types. view   xml
Chargeback Case view   xml
Chargeback Case Activity view   xml
Chargeback Case Document view   xml
Chargeback Case Document Content view   xml
Chargeback Classifier Enumerates types of chargeback transactions. view   xml
Chargeback Cycle Classifier view   xml
Chargeback Profile view   xml
Chargeback Profile Classifier Enumeration of possible chargeback profiles available. view   xml
Chargeback Queue Classifier view   xml
Chargeback Status Classifier Enumeration of possible chargeback statuses. view   xml
Chargeback Transaction Represents CC chargebacks, chargeback reversals and ACH returns. view   xml
Check Image view   xml
Client Abort Action Classifier Enumerations of possible ways to handle void for unprocessed transactions. view   xml
Client Capture Transaction Создание новой таблицы ClientCaptureTransaction для хранения полученной от клиента информации. view   xml
Code Mapping view   xml
Collections Profile Classifier view   xml
Collections Transaction view   xml
Communication Protocol Classifier Enumeration of possible communication protocol types for the terminal. view   xml
Config Data Entity that represents configuration data. view   xml
Confirm Classifier view   xml
Connection Mode Classifier Enumeration of possible connection modes. view   xml
Connection Type Classifier Enumerates possible types of connection. view   xml
Convenience Fee The enumeration of rules according to which convenience fee is charged on merchant’s transactions. view   xml
Convenience Fee Registry view   xml
Convenience Fee Registry Status Classifier Enumeration of possible convenience fee registry statuses, available in the system. view   xml
Cost Matching Status Classifier view   xml
Credit Agency Delete Classifier view   xml
Credit Agency Profile view   xml
Credit Agency Transaction view   xml
Credit Processing Mode Classifier view   xml
CSC Indicator Classifier Enumerates availability options for CVV2/CSC within a transaction (authorization) request view   xml
Currency Code Classifier Enumerates possible currency value. view   xml
Cycle Processing Mode Classifier Enumerates possible modes for processing of realtime transactions.

Certain credit card processors impose processing limitations on realtime transactions. Currently three modes are possible.
view   xml
Dantom Letter view   xml
Debit Account Classifier Enumeration of possible debit account types. view   xml
Default Industry Classifier Enumeration of possible default transaction industry types. view   xml
Delivery Mode Classifier Enumeration of possible delivery modes. view   xml
Deposit Account Type Classifier Enumeration of possible deposit account types. view   xml
Deposit Classifier Enumerates possible types of deposits. view   xml
Document Synchronization Action Classifier Enumerates an action that needs to be performed in real-time credit card processing. view   xml
Document Synchronization Status Classifier Enumerates possible statuses of document synchronization process. view   xml
Duplicate Policy Classifier view   xml
Dynamic Descriptor Profile view   xml
Eft Anb B2b Profile view   xml
Eft Anb B2b Retail Transaction view   xml
Eft Anb B2b Return Batch view   xml
Eft Peoples Bank Profile view   xml
Eft Peoples Bank Retail Transaction view   xml
Eft Peoples Bank Returns Batch view   xml
Eft Westamerica Remittance Batch view   xml
Eft Westamerica Remittance Batch Transaction view   xml
Eft Westamerica Remittance Profile view   xml
Email Content Entity that represents content of the email. view   xml
Email Profile view   xml
Email Template Entity that represents email template configuration information. view   xml
Email Transaction view   xml
Emulation Classifier Enumerates possible values of the profile field that can be used for proxy profiles. view   xml
Entry Classifier Enumerates possible values for credit card entering mode. view   xml
Entry Medium Classifier view   xml
Entry Mode Classifier view   xml
Entry PIN Mode Classifier view   xml
Extra Charge Classifier Enumerates possible values for Lodging extra charges. view   xml
Fallback Reason Code Classifier Enumerates possible values of fallback reason codes. view   xml
Fee Classifier view   xml
File Batch Represents a group of transactions within Sub Batch from which a single physical file for a Provider is generated.
Often, multiple file batches are required when Provider sets a limit on a number of transactions that can be included in a single file. If Sub Batch contains more transactions than the provider's limit, the transactions are split into multiple file batches.
view   xml
File Classifier Enumerates possible types of file in FTP Gates Log. view   xml
File Store Registry of interchange files that the system exchanges with roviders.
Request files are generated and placed into file store before they are uploaded. Response files are downloaded and placed into file store before they are parsed.

For efficiency reasons, the actual content of the files is stored in File Store Content.
view   xml
File Store Classifier The type of file store record. view   xml
File Store Content Helper entity used by File Store to store interchange file content. All meta information associated with the files are stored in File Store. view   xml
FirstData TransArmor Profile Entity that represents FirstData TransArmor profile information as it is represented in specification. view   xml
FIS Auth Retail Transaction view   xml
FiServ Profile view   xml
Fraud Profile view   xml
Fraud Sedra Profile view   xml
Front Gateway Profile view   xml
Front Gateway Transaction view   xml
FTP Gates File Content view   xml
FTP Gates Log view   xml
FTP Gates Log Status Classifier Enumerates possible statuses of transaction for FTP Gates. view   xml
Funds Balance Classifier view   xml
Funds Destination Classifier Enumeration of possible funds destination types. view   xml
Funds Distribution view   xml
Generic Email view   xml
Generic Email Batch view   xml
Generic Email Batch Status Classifier Enumerates possible statuses of email batch. view   xml
Generic Email File Batch view   xml
Generic Email Profile view   xml
Giact Account Verification Transaction view   xml
Holder Verification Mode Type Classifier Enumeration of possible holder verification mode types. view   xml
Holiday view   xml
Identity Verification Classifier Enumerates possible values that can be used for verification of customer’s identity. view   xml
IFullName view   xml
Interchange Code view   xml
Ip Address Classifier view   xml
IP Filtering Policy Classifier view   xml
Key Registry Entity that represents information associated with an encryption key. view   xml
Key Storage Classifier Enumeration of possible key storage types. view   xml
Letter Dantom Profile view   xml
Letter File Batch view   xml
Letter Profile view   xml
Letter Statement Content view   xml
Lodging Charge Classifier view   xml
Lodging Item view   xml
Log Level Classifier view   xml
MaxMind Response Classifier view   xml
Medium Classifier view   xml
Merchant Account Profile Represents a set of configuration settings that can be defined either on Merchant or Merchant Account level. view   xml
Merchant Account Service Classifier Enumeration of possible merchant account service types. view   xml
Merchant Address Entity that represents information about merchant's address. view   xml
Merchant Processing Cost Represents information about processing cost assigned to a merchant. view   xml
Metro To Batch view   xml
Metro To Transaction view   xml
Migration Status Classifier view   xml
Mpgs Auth Retail Transaction view   xml
Napse Vtol Auth Retail Transaction view   xml
Notification Status Classifier view   xml
Notification Transaction view   xml
Notification Webhook view   xml
Onboarding Action Classifier view   xml
Onboarding Application Stage view   xml
Onboarding Owner view   xml
Onboarding Stage Classifier view   xml
Onboarding Stage Status Classifier Enumeration of possible application statuses. view   xml
Onboarding Terminal Represents information about the terminal associated with an onboarded merchant. view   xml
Onboarding Terminal Action Classifier view   xml
Operation Type Enumeration of possible operation types available in the system. view   xml
Pago Auth Retail Transaction Represents information about realtime authorization transaction processed through Pago. view   xml
Paper Statement view   xml
Paper Statement Detail view   xml
Parameter Classifier Represents enumeration of parameters that are applied for sanitization. view   xml
Paymentech Orbital Profile Entity that represents information about merchant's profile assigned to Paymentech Orbital processor. view   xml
Paymentech Principal view   xml
Paymentech Stratus Chargeback Batch view   xml
Paymentech Stratus Chargeback Transaction view   xml
Paymentus Profile view   xml
Paypal Auth Retail Transaction view   xml
Petroleum Product Classifier Enumeration of possible types of petroleum products. view   xml
PGP Action Classifier Enumerates possible values of encryption. view   xml
Phone Call File Batch view   xml
Phone Call Profile view   xml
Phone Call TeleVox Profile view   xml
Post Rule view   xml
Pre Rule view   xml
Prestigious Property Indicator Classifier view   xml
Processing Cost Classifier Enumeration of possible types of processing costs available within the system.
The values can be the following:
'G' - Processing cost is not included in convenience fee.
'N' - Processing cost is included in convenience fee.
view   xml
Processing Cost Code view   xml
processing Ignorelist view   xml
Processing Log Financial transactions log, which records each systems' attempt to process any financial transaction with a Provider.
The primary purposes of this object is to analyze rebill process. Each transaction is represented with a Transaction object. When multiple attempts (rebills) are made for a single transaction, these attempts are recorded within Processing Log. For simplicity, the original (first) attempt is recorded as well.
view   xml
Processing Mode Classifier view   xml
Processing Policy Classifier Enumeration of possible processing policy types. view   xml
Processing Profile Base object representing Provider specific merchant account. Encapsulates all information necessary to identify a merchant in Provider's system.
Billing Profile may also contain configuration values defining system's behavior for this specific configuration.
view   xml
Processor Address Entity that represents information about the processor's address. view   xml
Profile Classifier Enumeration of possible types of profiles available in the system. view   xml
Propay Profile view   xml
Provider Represents a Provider within the system. view   xml
Provider Account Encapsulates communication settings necessary to establish connection with a server of a Provider.
The connection can be established to the servers of different types and communication can occur over different protocols.

Provider Account also stores information about security keys used for secure communication.

Common connection types are HTTPs for real-time processing and sFTP for batch processing.
view   xml
Provider Charge Transaction view   xml
Provider Classifier Enumerates possible providers through which the processing of any chargeback case is done. view   xml
Provider Configuration Encapsulates transformation, formatting and parsing logic used to generate Provider specific messages and/or files.
The logic behind message generation and parsing for each specification of a Provider is implemented as a group of pluggable components that are assembled together at run-time. The logic of the component initialization and assembly is stored in Provider Configuration.
view   xml
Provider Data Entry Classifier view   xml
Provider Data Registry view   xml
Provider Operation Classifier Enumerates possible types of provider-supported operations. view   xml
Provider Sequence Number view   xml
Provider Terminal Configuration view   xml
Provider Terminal Configuration Classifier view   xml
Provider Terminal Configuration Content view   xml
Provider Terminal Data view   xml
Provider Transaction Represents information about the transaction present on the processor's side. view   xml
Provider Transaction Container view   xml
Provider Type Classifier Enumeration of possible provider types. view   xml
Provisioning Tsys Profile view   xml
Provisioning Uni Pay Proxy Profile view   xml
Proxy Processing Cost Batch view   xml
Proxy Profile view   xml
Queuing Mode Classifier view   xml
Raw Account Data Mode Classifier Entity that enumerates possible ways of raw account data handling. view   xml
Reconciliation Profile view   xml
Reconciliation Profile Classifier view   xml
Redirect Info view   xml
Regulated Debit Classifier view   xml
Report Mode Classifier view   xml
Reprocessing Profile Response codes used by the system for financial transactions. Provider specific response codes are mapped into system response codes. The object also defines processing behavior for the codes.
Note: this object will be renamed in the short future.
view   xml
Response Code Classifier view   xml
Response Type Classifier Enumeration of possible transaction response types. view   xml
Retail Fis Profile view   xml
Retail ISO8583 Profile Encapsulates specific settings required for real-time transaction processing. Adds specific fields to the base fields of Billing Profile and Retail Profile. view   xml
Retail ISO8583 Profile Classifier Enumerates possible values of the profile field that is used in real-time credit card processing through ISO8583. view   xml
Retail Mpgs Profile view   xml
Retail Napse Vtol Profile view   xml
Retail Pago Profile Represents information about realtime Pago processing profile. view   xml
Retail Paypal Profile view   xml
Retail Profile Entity that represents real-time specific processing settings applied to Billing Profile. view   xml
Retail Proxy Profile view   xml
Retail Sigma Gateway Profile view   xml
Retail Taba Pay Profile view   xml
Retail Transaction Cycle Represents a group of real-time transactions that must be settled together.

The settlements process occurs when a cycle is closed. At this time, all non-captured transactions are voided, all voids (when applicable) are processed as authorization reversals and all authorizations and credits are settled with a Provider.
view   xml
Retail Transaction Cycle Classifier Enumeration of possible values for retail transaction cycle. view   xml
Retrieval Request Classifier view   xml
Return Profile view   xml
Return Profile Classifier Enumeration of possible return profile types. view   xml
Review Classifier Ennumeration of possible review statuses for the file. view   xml
Rule Action Classifier view   xml
Rule Operator Classifier view   xml
Sanitization Profile Represents information about sanitization profile. view   xml
Sanitization Profile Detail Represents detailed information about sanitization profile. view   xml
Sedra Fraud Transaction view   xml
Settlement Mode Classifier view   xml
Sigma Gateway Auth Retail Transaction view   xml
Signature Mode Classifier view   xml
Skip Trace Classifier view   xml
Skip Tracing Profile Entity that represents configuration settings of skip tracing profile.

Skip Tracing (or Skip Trace) - is the process of obtaining the updated contact information about a person based on their existing contact information for further debt collection.
view   xml
Skip Tracing Transaction view   xml
Sms Profile view   xml
SMTP Encryption Classifier Enumerates possible communication protocols, used for SMTP email encryption. view   xml
Special Program Classifier Enumeration of possible values for special programs available in the system. view   xml
Split Out Balance Entity that represents information about the balance assigned to the split out transaction. view   xml
Split Schema Entity that represents information about the applied split schema. view   xml
Split Schema Detail Entity that represents detailed information about the applied split schema. view   xml
Statement File Batch view   xml
Status Classifier Enumerates possible statuses of a transaction. view   xml
Stratus Token Transaction view   xml
Strong Auth Profile view   xml
Sub Batch Represents a sub-group of transactions within Batch or Retail Cycle.

Sub-batch is maintained for each group of transacions that have their own processing logic. For example, a batch that contains both credit card and ACH transactions will have two sub-batches in it.

Another example is a batch that contains transactions belonging to more than one Merchant Account. In such cases, when processing settings are different for each account, multiple sub-batches are created.
Error transactions are placed in a separate sub-batch. Decline transactions for rebill are placed in a separate sub-batch as well.
view   xml
Sub Batch Classifier Enumeration of possible sub batch types. view   xml
Sub Batch Content Classifier view   xml
Sub Request Classifier view   xml
Submission Base entity representing a group of transactions either processed together or grouped together for processing purposes. view   xml
Submission Classifier Enumerates types of submissions. view   xml
Submission Summary view   xml
Subscription Transaction Entity that represents information about subscription transaction. view   xml
Taba Pay Auth Retail Transaction view   xml
Tax Indicator Classifier Enumerates possible values for availability of tax information within a transaction. view   xml
TeleVox Phone Call view   xml
Template Classifier view   xml
Template Status Classifier view   xml
Tender Classifier Enumerates payment sources that can be used to fund prepaid cards and gift cards. view   xml
Terminal Device Status Classifier view   xml
Terminal Diagnostics view   xml
Terminal Support Mode Classifier view   xml
Theme Type Classifier Enumeration of possible color themes to be shown on a terminal screen. view   xml
Time Zone Classifier Enumerates possible values of time zones. view   xml
Token Code BIN view   xml
Token Profile Represents information about token profile. view   xml
Token Register BridgePay Profile Configuration settings required for communication with a BridgePay encryption appliance. view   xml
Token Register Profile Represents tokenization functionality for all provider profiles. view   xml
Token Register Stratus Profile Configuration settings required for communication with a Stratus encryption appliance. view   xml
Token Transaction Entity that represents information about token transaction. view   xml
Token Usage History view   xml
Tokenization File Store Entity that represents tokenization files storage. view   xml
Tokenization File Store Status Classifier Enumeration of possible tokenization file store statuses. view   xml
Tokenization Policy Classifier view   xml
Tokenization Provider Classifier view   xml
Tokenization Transaction Classifier Enumeration of tokenizaton transaction types. view   xml
Tokenizer Classifier Enumeration of possible tokenization appliance sources associated with the transaction. view   xml
Transaction Category Classifier Enumerates transaction categories. view   xml
Transaction Classifier Enumerates transaction processing modes. view   xml
Transaction Date Processing Classifier Enumerates possible values of transaction processing date. view   xml
Transaction Industry Classifier Enumerates transaction processing modes in industry. view   xml
Transaction Operation Classifier Enumeration of possible transaction processing operations. view   xml
Transaction Processing Cost Stores association assessments for processor's surcharges, incurred during transaction processing. view   xml
Transaction Processing Mode Classifier view   xml
Transaction Request view   xml
Transaction Resource view   xml
Transaction Status Classifier Enumerates possible values for status of transaction. view   xml
Transient Transaction view   xml
Trust Commerce Chargeback Batch Represents information about chargebacks batch file processed through TrustCommerce. view   xml
Trust Commerce Chargeback Transaction view   xml
Trust Commerce Reconciliation Batch Represents information about reconciliation batch file processed through TrustCommerce. view   xml
Tsys Account Update Transaction Type Classifier view   xml
Tsys Merchant Statement view   xml
Tsys Onboarding Terminal view   xml
Tsys Processing Cost view   xml
Tsys Provisioning Request Classifier view   xml
Tsys Provisioning Transaction view   xml
Type Service view   xml
Unipay Profile Classifier view   xml
Validation Channel Classifier view   xml
Vantiv Lowell Principal view   xml
Vantiv Lowell Profile view   xml
Vantiv Lowell Provisioning Transaction view   xml
Vantiv Tandem Discount Method Classifier Enumeration of possible discount methods applied within Vantiv Tandem processing system. view   xml
Vantiv Tandem Onboarding Owner view   xml
Vantiv Tandem Onboarding Terminal Represents information about the terminal associated with a merchant onboarded through Vantiv Tandem. view   xml
Verification Mode Classifier Entity that represents the ways how pre-tokenization verification can be handled. view   xml
Verification Profile view   xml
Void Reason Code Classifier Enumerates possible values of void reason codes. view   xml
Wallet Apple Pay Profile view   xml
Wallet Google Pay Profile view   xml
Wallet Profile view   xml
Webhook Data Classifier view   xml
Webhook Object Classifier view   xml
Wells Fargo Account Verification Transaction view   xml
UniCore Objects:
Access Policy Entity that represents information about access policy. view   xml
Access Policy Classifier Enumerates possible values for access policy. view   xml
Account Balance Algorithm Classifier Enumerates algorithms used by the system to apply payments against outstanding invoices. view   xml
Account Type Classifier Enumeration of possible account types available in the system. view   xml
Account Usage Classifier Enumeration of possible values of accaunt usage available in the system. view   xml
Activity Classifier view   xml
Amount Classifier Enumeration of possible amount types. view   xml
Analysis Policy Classifier Enumeration of possible analysis policy types. view   xml
Audit Action Classifier Enumeration of possible audit actions. view   xml
Authentication Classifier Enumeration of possible authentication types available for logging in to the portal. view   xml
Background Verification Result view   xml
Bank Account Type Classifier Enumeration of possible types of bank accounts. view   xml
Bank Identification Number view   xml
Batch Account Update Policy Classifier Enumerates possible values of batch account update policy.
Allows to select Account Update policy for batch files. Account Update can be done either before billing or after the first billing.
view   xml
Batch Processing Policy Classifier Enumerates possible values for batch processing policy.
Allows to select policy for batch processing if a validation file was generated by the system.
view   xml
Bin Rule Stores credit card BINs. view   xml
Blacklist Policy Classifier Enumeration of possible blacklist policy types. view   xml
Branding Profile Represents branding profile features. view   xml
Branding Profile Content Represents the fields associated with the content of a branding profile. view   xml
Card Brand Classifier view   xml
Channel Entity that represents channel set up for a given portfolio.
The channel represents an integration done with UniPay from/by an outside system.
view   xml
Charge Status Classifier Enumeration of possible statuses of the charge transaction. view   xml
Client Fee view   xml
Client Transaction Classifier Enumeration of possible client's transaction types. view   xml
Code Message view   xml
Code Uniqueness Scope Classifier Enumerates possible scopes of uniqueness of the reference code of the customer account object. view   xml
Collections Priority Classifier Enumerates priorities of an account in the 3rd party collections. view   xml
Commission Basis Classifier Defines basis for reseller commissions. view   xml
Content Classifier Enumeration of possible record content types. view   xml
Country Code Entity that represents information about country codes available in the system. view   xml
Credit Agency Status Classifier Enumerates reporting statuses of the merchant within the credit bureau. view   xml
Currency Code Entity that represents information about currency codes in the system. view   xml
Custom Field Entity that stores cutom fields on the reseller's level for onboarding application. view   xml
Customer Fee view   xml
Customer Level Classifier Enumerates customer's level based on the application usage. view   xml
Data Group view   xml
Data Group Item view   xml
Data Group Item To Merchant Account view   xml
Data Vault Entity that represents data vault. view   xml
Deactivation Reason Classifier Enumeration of possible reasons why the user account was deactivated. view   xml
Deposit Classifier Enumerates possible types of deposits. view   xml
Deposit Statement Config view   xml
Distribution Destination Classifier Enumeration of possible funds distribution destination types. view   xml
Distribution Schema Entity that represents general information about distribution schema. view   xml
Distribution Schema Detail Entity that represents detailed (or additional) information about distribution schema. view   xml
Distribution Source Classifier Enumeration of possible funds distribution sources. view   xml
Distribution Statement Entity that represents general information about distribution statement. view   xml
Distribution Statement Detail Entity that represents distribution statemenet detailed information. view   xml
Distribution Statement Detail Breakdown Entity that represents information about breakdown details of the distribution statement. view   xml
Entry Classifier Enumerates possible values for credit card entering mode. view   xml
Error Classifier Enumeration of possible types of error types. view   xml
Error Code view   xml
Fee Funding Policy Classifier Enumeration of possible fee funding policies available. view   xml
Fee History view   xml
Fee Schema view   xml
Fee Schema Detail view   xml
Fee Type Classifier view   xml
Fee Withdrawal Policy Classifier view   xml
Franchise Fee view   xml
Funding Mode Classifier view   xml
Funds Distribution Classifier Enumaration of possible funds distribution types. view   xml
Funds Source Classifier Ennumerates possible values of the sources of funds where money can go if it is not remitted to the merchant. view   xml
GL Account view   xml
Hsm Classifier view   xml
Item Fee Policy Classifier view   xml
Job Journal view   xml
Job Message Entity that represents information about job queue message. view   xml
Job Message Archive Entity that represents information about archived job messages. view   xml
Job Message Content Entity that represents content of the job message. view   xml
Job Message Status Classifier Enumeration of possible statuses of the job message. view   xml
Job Object Entity that represents information about job object. view   xml
Job Object Classifier Entity that enumerates types of the job objects. view   xml
Job Target Classifier view   xml
Limit Classifier Enumeration of possible types of limit for which the breakdown is defined. view   xml
Locale Classifier view   xml
Mail Mode Classifier Enumerates possible values for letter mailing policy. view   xml
Master Reseller Statement Entity that represents information included in master reseller statement. view   xml
Master Reseller Statement Detail Entity that represents detailed information included in master reseller statement. view   xml
Merchant Represents a Merchant that processes transactions through the system. view   xml
Merchant Account Represents the information of the merchant account. Can represent location, store, club or department. Used to subdivide data (on reports) and override global processing settings defined on Merchant level. view   xml
Merchant Account Activity Represents information about remittance and statement activity within the merchant account. view   xml
Merchant Account Group Encapsulates deposit information and stores all of the fields necessary for the remittance process to run. Depending on the configuration level of the merchant, each merchant or merchant account will have corresponding Merchant Account Group object for storing its information. view   xml
Merchant Account Group Statistics view   xml
Merchant Account Payment Statistics Represents merchant account payment statistics. view   xml
Merchant Activity Stores statistical time-sensitive information for a merchant, which is mostly used by internal processes to log last time when a certain action got performed. view   xml
Merchant Activity Statistics Represents merchant activity statistics. view   xml
Merchant Announcement view   xml
Merchant Balance History Represents available funds and transaction history of the merchant. view   xml
Merchant Charge view   xml
Merchant Charge Classifier Enumeration of possible charges available to be applied to the merchant. view   xml
Merchant Charge Payment view   xml
Merchant Classifier Enumerates types of merchant's organization with respect to the number of merchant accounts that it requires. view   xml
Merchant Cycle A set of days within a month (1-28) when a reconciliation process for a Merchant has to run. Reconciliation Merchant Statement is generated at this time.

The system is designed to run remittance process (described below) on 2 cycles: deposit cycle and reconciliation cycle.

Deposit cycle runs daily. It performs calculation and generates statements and deposits if and only if a payment was processed for given Merchant (Merchant Group) on the given date (this is done to accumulate returns information).

Reconciliation cycle runs on specified dates of a month and generates statements and deposits for the period since the last statement. It also incorporates processing results from deposit cycles that may have run during the time period covered by the cycle.

Deposits/withdrawals as well as fees and adjustments can be assigned for each cycle.
view   xml
Merchant Cycle Detail Represents detailed information about merchant cycle. view   xml
Merchant Deposit Statistics Represents merchant deposit statistics information. view   xml
Merchant Fee Represents fee structure (processing rates, service fees, etc) configured for this merchant. Contains information about how deposits and fees should be calculated based on transaction processed. view   xml
Merchant Fee Basis Classifier Entity that enumerates possible ways of merchant fee basis calculation. view   xml
Merchant Fee Detail Represents definition of a specific line item of the fee structure. Contains detailed information about merchant fees. view   xml
Merchant Fee Frequency Classifier Enumerates possible frequencies that can be used to apply merchant fees. view   xml
Merchant Fee Schema view   xml
Merchant Fee Schema Extended view   xml
Merchant Financial Statistics Represents information about merchant financial statistics. view   xml
Merchant Group Scheduled Adjustment Entity that represents information about merchant group scheduled adjustment. Scheduled adjustment allows manual adjustment to the future Merchant Statements. Scheduled adjustment has a fixed date in the future when it is applied to the newly generated statement. view   xml
Merchant Group Scheduled Adjustment Status Classifier Enumeration of possible merchant group scheduled adjustment statuses available in the system. view   xml
Merchant Nature Classifier Enumeration of possible merchant nature types available in the system. view   xml
Merchant Object view   xml
Merchant Processing Statistics view   xml
Merchant Processing Statistics Detail view   xml
Merchant Processing Statistics Fee Detail view   xml
Merchant Remittance Statistics view   xml
Merchant Statement Activity view   xml
Merchant Statement Detail Represents detailed information about merchant statement. Includes transaction submissions, deposits, reserves, processing and monthly fees etc. view   xml
Merchant Statement Detail Adjustment Classifier Enumeration of possible merchant statements details adjustments types. view   xml
Merchant Statement Detail Breakdown view   xml
Merchant Statement Export Config Entity that represents configuration settings of merchant statement exporting. view   xml
Merchant Statement Extended view   xml
Merchant Statement Extended Content view   xml
Merchant Statement Extended Detail view   xml
Merchant Statement Extended Detail Metadata view   xml
Merchant Statement Extended Fee Detail view   xml
Merchant Statement Extended Split Detail view   xml
Merchant Statement Statistics view   xml
Merchant Statement Statistics Breakdown view   xml
Merchant Statement Statistics Detail view   xml
Note Template view   xml
Note Template Classifier Enumerates possible values of note templates types within the system. view   xml
Object Classifier Enumeration of possible values of objects, that can be used as the creteria for selection for the velocity rule. view   xml
Ownership Structure Classifier Enumeration of possible types of ownership structures. view   xml
Page Store view   xml
Payment Classifier Enumerates possible types of payments (asset transactions). view   xml
Payment Form Classifier view   xml
Payment Option Classifier Enumerates possible types of payment options. view   xml
Payout Statement view   xml
Payout Statement Classifier view   xml
Payout Statement Detail view   xml
Period Classifier Represents the possible values of periods that are used as statistics period. view   xml
Portfolio Entity that represents information about the portfolio. view   xml
Pricing Classifier view   xml
Process Log view   xml
Processing Cost Classifier Enumeration of possible processing cost types. view   xml
Processing Deviation Represents the fields used for processing deviation statistics within a chosen period of time. view   xml
Processing Deviation Breakdown view   xml
Processing Limit Encapsulates Processing Limit information. view   xml
Processing Reconciliation Statistics Represents statistics associated with processor reconciliation report. view   xml
Processing Statistics Represents the fields used for processing statistics within a chosen period of time. view   xml
Provider Profile Log view   xml
Reconciliation State Classifier Enumeration of possible reconciliation states. view   xml
Refund Pricing Mode Classifier view   xml
Region Code Entity that represents information about region codes available in the system. view   xml
Remittance Basis Classifier Enumerates date options that can be used as basis for remittance process. view   xml
Remittance Mode Classifier Enumerates possible configurations for the remittance logic used for a given merchant. See Remittance for additional details. view   xml
Remittance Reconciliation Statistics view   xml
Remittance Reconciliation Statistics Classifier view   xml
Remittance Source Classifier Enumerates possible values for remittance sources.

See Remittance Source definition for additional information.
view   xml
Remittance Transaction view   xml
Remittance Transaction Classifier Enumeration of remittance transaction types. view   xml
Report Generation Classifier view   xml
Report Queue Entity that represents report queue information. view   xml
Report Status Classifier Enumeration of possible report statuses. view   xml
Report Type Classifier Enumeration of possible report formats that can be downloaded. view   xml
Reseller Represents a reseller that brought merchant/merchant account and is associated with it for relationship management. view   xml
Reseller Activity Entity that represents information about activity of the reseller. view   xml
Reseller Classifier Enumeration of possible types of resellers available. view   xml
Reseller Commission Entity that represents information about reseller's comissions. view   xml
Reseller Commission Detail Entity that represents additional details about reseller's comissions. view   xml
Reseller Scheduled Adjustment view   xml
Reseller Scheduled Adjustment Type Classifier view   xml
Reseller Statement Reseller statement, compiled based on actual processing volumes and reseller fee details. It shows all the transactions processed for the given reseller during the specified time interval and all the fees deduced. view   xml
Reseller Statement Detail Entity that represents additional information about reseller statement. view   xml
Reseller Statement Extended Breakdown view   xml
resource Store view   xml
Response Data view   xml
Returns Delivery Mode Classifier Enumerates delivery options for ACH returns and chargebacks for a merchant. view   xml
Role Entity that represent role of the user in the system. view   xml
Role Classifier Enumerates security roles supported by the system. view   xml
Role Policy Classifier view   xml
Routing Number Represents fields that contain information about routing number. view   xml
Security Level Classifier view   xml
Settings view   xml
Split Out Balance Log view   xml
State Classifier List of states. view   xml
Statement Merchant statement, compiled based on actual processing volumes and merchant fee details. It shows all the transactions processed for the given merchant during the specified time interval and all the fees deduced. Merchant statement is compiled for every remittance. view   xml
Statement Classifier Enumeration of the possible values determining a type of a merchant statement. view   xml
Statement Detail Group view   xml
Statement Detail List Export view   xml
Statement Emailing Policy Classifier view   xml
Statement Fee Detail List Export view   xml
Statement List Export view   xml
Statement Policy Classifier Enumeration of the possible values determining how a merchant statement is generated. view   xml
Statement Source Classifier view   xml
Statement Status Classifier Enumerates possible statuses of a merchant or reseller statement. view   xml
Submission Classifier Enumerates types of submissions. view   xml
System Audit Log Represents information about system audit log. view   xml
System Error Log Entity that represents information about system error log. view   xml
Tax Rate Stores tax rates for merchant from different countries. view   xml
Time Period Classifier Enumeration of possible values for estimation time period for which transaction volume and average transaction amount are defined. view   xml
Time Zone Code Entity that represents general information about time zones. view   xml
Tokenization Format Classifier view   xml
Tokenization Removal Classifier Entity that represents modes that are used to remove tokenization. view   xml
Tokenization Update Policy Classifier view   xml
Transaction Classifier Enumerates types of asset transactions. view   xml
Transaction List Export view   xml
Transaction Source Classifier Enumerates possible values for origins/sources of a transaction. view   xml
Update Log Entity that represents detailed information about the performed updates. view   xml
User Human user that has access to the system. view   xml
User Classifier Enumeration of possible users types available within the system. view   xml
User Permission Entity that represents current user permission configurations. view   xml
User Role Entity that represents user's role in the system short information. view   xml
User Status Classifier Enumeration of possible user statuses within the system. view   xml
Vault Content view   xml
UniRun Objects:
Allowance Rate Classifier Enumerates possible values for income tax allowance rate category view   xml
Benefits Policy Classifier Enumeration of possible benefits policy types. view   xml
Chargeback Queue Classifier Enumerates possible values for chargebacks queue, indicating current state of the chargeback. view   xml
Clothing Article A clothing apparel article that can be purchased by an employee view   xml
Clothing Article Design Design of a clothing article available for purchase by employees view   xml
Clothing Item Represents a clothing item purchased or returned by an employee. view   xml
Clothing Size Classifier Enumerates possible clothing sizes view   xml
Document Digital document associated with an employee account. view   xml
Document Code Enumerates types of documents that can be associated with an employee account. view   xml
Employee Represents an employee of the company view   xml
Employee Order Represents an apparel order made for an employee view   xml
Employee Order Status Classifier Enumerates statuses of an employee order view   xml
Employee Record Groups employee related information associated with his or her current employment in the company. If an employee is hired more than once, he or she will have multiple employment records associated with him or her. view   xml
Employee Record Status Classifier Enumerates statuses of an employee record. view   xml
File Store Content Stores binary content of the documents and files view   xml
Gender Classifier Enumerates possible gender values view   xml
Integration Action Classifier view   xml
Item Return Policy Classifier Enumerates types of return policy that may apply to a purchased item view   xml
Legal Document Classifier Enumerates legal documents recognized by US government and used for employment eligibility verification. view   xml
Legal Status Classifier Enumerates possible values for a person's legal status within a country view   xml
Payment Classifier view   xml
Race Classifier Enumerates types of human races view   xml
Signature Stores digital signatures associated with the digital documents. view   xml
UniSell Objects:
Change Account view   xml
Contract view   xml
Contract Adjustment view   xml
Discount Code view   xml
Informed Consent view   xml
Membership view   xml
Membership Merchant Account Entity that represents membership merchant account information. view   xml
Membership Upgrade view   xml
Payment view   xml