Merchant UML

Represents a Merchant that processes transactions through the system.

For UniBill only.
Represents the type of balancing algorithm that is used to balance payments on customer account.

Number of days from the last account update that have to pass before the next account update is done.

Additional password for the account.

Time period that fixed commission paid to an agent is relevant.

Filter that defines for which AVS response codes settlement is allowed.

Fixed commission, paid to an agent who restored customer's account back to electronic draft using bank account.

Represents the selected (or current) type 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.

Represents the selected (or current) type of batch processing policy.
Allows to select policy for batch processing if a validation file was generated by the system.

• All Or Fail - if there is at least one invalid transaction in the request file, validation error file is generated and the request file is not processed at all.
• Any Valid - all valid transactions included in a request file are processed by a processor. Invalid transactions are placed into the validation error file and should be re-processed as a separate file after correcting all of the issues.

Total amount of a file, necessary for duplicate validation mechanism to get activated.

Minimum number of transactions that must be present in a batch in order for this batch to get validated for potential duplicates or inconsistencies. If a batch is lower than indicated number of transactions, it will not be verified for duplicates.

Enumeration of possible blacklist policy types available in the system.

Reference to the entity that represents legal information of the merchant.

Fee applied to phone calls.

Credit card charge fee amount.

Credit card charge fee amount.

Fee applied to chargebacks associated with merchant's credit card.

Fee applied to credit transactions associated with merchant's credit card.

Fee applied to returns associated with merchant's credit card.

Reference to the entity that represents the channel.

Reference to the entity that represents information about fee, which is charged when a chargeback is received.

City of the Merchant's postal address.

Reference to the entity that represents client's fee information.

Unique identifier of the merchant generated by the gateway.

For UniBill only.
Represents the type of scope, within which customer account's ID is unique.

Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age1 is linked to Collections email code1).

Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age2 is linked to Collections email code2).

Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age3 is linked to Collections email code3).

Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age4 is linked to Collections email code4).

Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age5 is linked to Collections email code5).

Code of an email template set up with a mailing service for the first email sent to the customer from 3rd party collections.

Code of an email template set up with a mailing service for the second email sent to the customer from 3rd party collections.

Code of an email template set up with a mailing service for the third email sent to the customer from 3rd party collections.

Code of an email template set up with a mailing service for the fourth email sent to the customer from 3rd party collections.

Code of an email template set up with a mailing service for the fifth email sent to the customer from 3rd party collections.

Fixed fee amount, which is applied to the customer's account when it is sent to 3rd party collections.

Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age1 is linked to Collections letter code1).

Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age2 is linked to Collections letter code2).

Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age3 is linked to Collections letter code3).

Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age4 is linked to Collections letter code4).

Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age5 is linked to Collections letter code5).

Code of a letter template set up with a printhouse for the first letter sent to the customer from 3rd party collections.

Code of a letter template set up with a printhouse for the second letter sent to the customer from 3rd party collections.

Code of a letter template set up with a printhouse for the third letter sent to the customer from 3rd party collections.

Code of a letter template set up with a printhouse for the fourth letter sent to the customer from 3rd party collections.

Code of a letter template set up with a printhouse for the fifth letter sent to the customer from 3rd party collections.

Period in days after which collections fees are applied.

Percentage of the customer's account ballance, which is applied as a fee when the account is sent to 3rd party collections.

Fixed amount (per item) commission paid to an agent who managed to collect a debt on a customer account in 1st party collections.

Percentage of a payment collected, paid as a commission to an agent who managed to collect balance on an account in the 1st party collections.

Fixed amount (per item) commission paid to an agent who managed to collect a debt on a customer account in 3st party collections.

Percentage of a payment collected, paid as a commission to an agent who managed to collect balance on an account in the 1st party collections.

Reference to the entity that represents information about the collector.

Flag controlling whether or a customer's confirmation is required on an email address to consider it valid.

When set to true, any email submitted into the system for a given customer will be disabled by default and will receive a message with a verification link. Once a customer clicks on the link, the email address gets validated and can be used for processing.

The feature is useful for cases when it is absolutely necessary to ensure that the email on customer's record is valid.

UniBill only.

Name of the primary business contact for the merchant.

Country code of the merchant.

Date when the record was created.

Represents the type of reporting status of the merchant within the credit bureau.

Fixed commission, paid to an agent who restored customer's account back to electronic draft using credit card.

Filter that defines for which CSC response codes settlement is allowed.

Convenience fee of the customer indicated by the agent.

Fee, applied to the customer's account when a chargeback occurs.

Fee, applied to the customer account when the payment plan is put on freeze.

Fee, applied to the customer's account when a hard decline occurs.

Fee, applied to the customer's account if a payment was not collected on time.

Time period after which Late fee is applied to the customer's account (in case when the payment was not collected on time).

Represents the type of customer's level based on the application usage.

Convenience fee of the customer indicated on payment portal.

Return fee of the customer.

City of the customer's service address.

Fax number of the customer's service address.

Phone number of the customer's service address.

State of the customer's service address.

Street of the customer's service address.

Working hours of the customer's service.

ZIP/postal code of the customer's service address.

Fee, applied to the customer's account when a soft decline occurs.

Fee, applied to the customer's account for a paper statement of the account.

Regulates whether a merchant uses Data Export mechanism for reports. Two reports are available for data export: Transaction Export Summary and Deposit Export. Default value is "----------".
There are three available values:
1. E - export;
2. N - export and notify;
3. "-" - do not export.
For example, field format "-E----------" indicated that only Deposit Export report is exported.

Date when the record was deactivated.

UniBill only.
The number of soft declines allowed before the payment option is deactivated.

Reference to the entity that represents default user defined for this merchant.

Specific identifier assigned for a merchant.

Fee, which is charged for accessing documents within a membership portal (for example, electronic libraries documents).

Time period for which access to a document will be allowed.

Fee associated with merchant's credit card.

Processor's fee share associated with merchant's credit card.

Fee applied to credit transactions associated with merchant's EFT card.

Fee applied to returns associated with merchant's EFT card.

Merchant's contact email.

This value is used to send remittance statements.

Expiration date of email code account.

Expiration period of the email account code.

Code of an email template, sent out when a payment is made through an agent portal.

Code of an email template, sent out when a previously issued credit is reversed.

Code of an email template, sent out when refund has been cancelled.

Code of an email template set up with a mailing service that is sent when a chargeback occurs.

Code of an email template, sent out when a credit is issued.

Code of an email template, sent out when a payment is collected by an agent through self-service portal as part of electronic draft.

Code of an email template set up with a mailing service that is sent when a hard decline occurs.

Code of email template, sent out when an invoice is created.

Code of an email template, set up with a mailing service for invoice notification email.

Code of an email template, sent out when late fee gets applied.

Code of an email template, sent out when a payment is made through a self-service portal.

Code of an email template, sent out when refund occurs.

Code of an email template set up with a mailing service that is sent when a soft decline occurs.

Code of a letter template set up with a mailing service for a statement of the account.

Code of an email template, sent out when void is done.

Code of an email template set up with a mailing service that is sent when a new account is created.

Fee applied to emails.

Number of days after which invoice is created and notification email is sent.

Reference to the entity that represents information about fee, which is charged when a customer record is created (the fee is charged one-time only).

Merchant's fax number.

Reference to the entity that reresents processor's fee.

Name of the public PGP key.

Reference to the entity that represents information about fee, which is charged when a payment plan is set on freeze (the fee is charged one-time only).

Reference to the entity that represents information about fee, which is charged when a payment plan is set on freeze (the fee is charged on recurring basis, replacing the regular payment plan amount).

Reference to the entity that represents information about fee, which is charged on hard declines (transactions that were declined with the reason that suggests that further reattempts are futile).

Period in months for which forecasting data needs to be available within the system.

Forecasting data shows expected recurring billing revenue projected in time in the future. A value of 12 in this field indicates that the system will provide projections for up to 12 months.

Provisioning information associated with a merchant.

Indicates whether account aggregation ACH mechanism is used for this merchant or not.

Indicates whether account aggregation cards mechanism is used for this merchant or not.

Indicates whether returns should be delivered on daily basis or accumulated and delivered as part of the response file when next request file is sent.

Indicates whether the record is active and can process through the system.

For internal use only.

Indicates whether the certain information should be added to the returns file.

Indicates whether the explicit approval of a user is required to process a batch, submitted into UniCharge.

UniBill only.
Indicates whether multiple payment plans are allowed on a single customer account.

Indicates whether the email invoice notification includes invoice notification only.

Indicates whether expiration date validation is enabled or not.

Indicates whether duplicate file validation based on file's content (in addition to the existing file name duplicate validation) is active or not.

Indicates whether bad phone numbers are kept on the account after skiptracing process completes.

UniBill only.
Indicates whether late fees are applied on accounts in 3rd party collections.

Indicates whether chargeback letter is a statement or not (statements contain data tables).

Indicates whether hard decline letter is a statement or not (statements contain data tables).

Indicates whether soft decline letter is a statement or not (statements contain data tables).

Indicates whether the invoice notification includes invoice only.

Indicates whether an explicit approval is required before merchant statement is processed.

Defines how remittance is done - at the merchant (isMultipleRemittance=false) or account (isMultipleRemittance=true) level.
The value is based on the merchant profile settings.

Indicates that the return files will be generated several times a day

Indicates whether payment option is disabled when defined number of declines is received for this payment option.

Indicates whether decline fees are assessed for declines coming from scheduled payments.

Indicates whether realtime review is required or not.

Indicates whether an account has to have outstanding balance for soft decline email to come out.

Indicates whether an account has to have outstanding balance for soft decline letter to come out.

Indicates whether an explicit approval is required before reseller statement is processed.

Indicates whether chargeback fees are reversed when chargebacks are reversed.

Indicates whether routing number validation is enabled or not.

For UniBill only.
Indicates whether skiptracing process is enabled on a customer account.

Indicates whether the transaction processing optimization is enabled in the system.

Controls whether or not routing number updates received from the Federal Reserve System are passed back to the merchant.

Reference to the enitity that represents information about fee, which is charged if there is an outstanding balance by a period indicated as late period.

Percentage of a payment collected against late fee that is paid as a commission to an agent who managed to collect the payment.

Code of a letter template set up with a printhouse when a chargeback occurs.

Code of a letter template set up with a printhouse when a hard decline occurs.

Code of a letter template set up with a printhouse when a soft decline occurs.

Code of a letter template set up with a printhouse for a statement of the account.

Code of a letter template set up with a printhouse that is sent when a new account is created.

Fee applied to letters.

Represents the type of selected mailing mode that is used for this merchant.

Reference to the entity that represents the information of the merchant account.

Reference to deposit and fee information for the merchant.

Reference to the Merchant activity object that contains statistical information about merchant's processing.

Represents the type of merchant from the standpoint of the number of merchant accounts that it uses.

Identifier of the associated configuration that is used for creation of profiles list.

Represents the type of this merchant record.

A set of parameters that are used to govern the setup of the merchant with the respect to its merchant accounts, merchant IDs, descriptors, deposit accounts and fees. It comprises 5 parameters, defining of which will make it possible to determine how the merchant / merchant account should be configured.

The field can take values consisting of 5 symbols (for example, SSSSM or MMMMA).
1st position (Accounts) - S for single, M for multiple.
2nd position (Tax IDs) - S for single, M for multiple.
3rd position (Descriptors) - S for single, M for multiple.
4th position (Deposit accounts) - S for single, M for multiple.
5th position (Fees) - M (merchant) or A (account).

Multiple accounts indicates whether merchant is gonna be using multiple accounts or only single one. For more information see For more information see Merchant Configuration Guide

Multiple tax IDs assumes multiple accounts to be true and indicates whether or not each of the accounts is gonna belong to separate organizations with their own tax IDs. For more information see Merchant Configuration Guide

Multiple descriptors assumes multiple accounts to be true and indicates whether or not each of the locations will be using its own separate card descriptor or the same descriptors of use across all of them. For more information see Merchant Configuration Guide

Multiple deposit accounts assumes multiple accounts to be true and, when remittance mechanism is used, indicates whether each of the accounts is going to have its own deposit accounts or whether single deposit accounts will be used for everyone. For more information see Merchant Configuration Guide

Multiple recurring fees assumes multiple accounts to be true and indicates whether recurring fees will be applied to the merchant or to each individual account. For more information see Merchant Configuration Guide

Minimum amount of debt that gets reported to a credit bureau.

Minimum perpetual billing count.

The DBA name of the merchant.

For UniBill only. List of states, for which collection fee is not applied.

List of states for which credit reporting is not done.

Provides a place to store short generic notes about the merchant.

Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age1 is linked to notification email code1).

Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age2 is linked to notification email code2).

Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age3 is linked to notification email code3).

Code of an email template set up with a mailing service for the first notification email sent to the customer in case the customer's account became delinquent.

Code of an email template set up with a mailing service for the second notification email sent to the customer in case the customer's account became delinquent.

Code of an email template set up with a mailing service for the third notification email sent to the customer in case the customer's account became delinquent.

Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age1 is linked to notification letter code1).

Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age2 is linked to notification letter code2).

Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age3 is linked to notification letter code3).

Notification Letter Code (Invoice)

Code of a letter template set up with a printhouse for the first notification letter sent to the customer in case the customer's account became delinquent.

Code of a letter template set up with a printhouse for the second notification letter sent to the customer in case the customer's account became delinquent.

Code of a letter template set up with a printhouse for the third notification letter sent to the customer in case the customer's account became delinquent.

Period in days after which a notification letter is sent.

The URL address for offline callbacks.

Merchant code of the parent object.

The age of the debt in days at which customer account moves from the first collections phase into the second collections phase.

See Collections Phases for additional information.

The age of the debt in days at which customer account moves from the second collections phase into the third collections phase.

See Collections Phases for additional information.

The age of the debt in days at which customer account moves from the third collections phase into the fourth collections phase.

See Collections Phases for additional information.

Merchant's contact phone.

UniBill only. The maximum size of a document that a customer can upload through a self-service portal.

UniBill only. The number of documents that a customer can upload through a self-service portal.

Reference to the entity that represents welcoming page.

Reference to the entity that represents the portfolio attached to the merchant.

Percentage of a payment collected against the invoice that is paid as a commission to an agent who managed to collect the payment.

Shows the time of the day that marks the end of the business day.
This time is set according to the server time zone but should be adjusted for merchant/merchant account individually, if needed. For example, if server time zone is set as EST but a particular merchant/merchant account operates according to PST, the cutoff time setting should be set as 3 AM, in case if cutoff processing time should occur at midnight.
Any transactions processed before this time are dated as the date-processed, while any transactions processed after this time are dated as being processed the next day.

Merchant's password for transaction processing API. This value in combination with Merchant Code serves as a set of credentials to authenticate the submitter of a transaction.

Transaction processing server.

Optional identifier of the Merchant that can be used to cross-reference the Merchant record between multiple systems.

See Reference Code definition for additional information.

Represents the type of remittance basis that is used for this merchant. Works in conjunction with ACH remittance period, CC remittance period and AmEx remittance period.

Represents the type of transaction for which remittance process is going to be applied.

See Remittance for additional information.

Reference to a merchant that contains settings necessary to execute remittance operations.

Code of the entity where information about the reseller is stored.

Reference to the entity that represents the reseller associated with the merchant.

Stores values of the lables on the user interface that were renamed to accomodate merchant's specific business terminology. The values are stored using Properties format.

Reference to the entity that represents information about fee, which is charged when previously declined transaction gets approved as a part of automated retry process.

Retry fee of the customer.

Reference to the entity that represents information about fee, which is charged when a return on direct debit payment is received.

Percentage of a payment collected against return fee that is paid as a commission to an agent who managed to collect the payment.

URL of a page, where returns and chargebacks are delivered as they are loaded into the system.

Represents the type of delivery option for ACH returns and chargebacks for this merchant.

Time of the returns payment transaction generation.

Period in days during which two subsequent skiptraces will not be allowed. For example, if skip trace period is 60 days and the skiptrace is done on January 1st, another skiptrace on this account will not be allowed until March 1st.

Reference to the entity that represents information about fee, which is charged on soft declines (transactions that were declined with the reason that suggests that further reattempt might be successful).

Wait period (in days) before soft decline email is sent out.

Wait period (in days) before soft decline letter is sent out.

State of the Merchant's postal address.

City of merchant's postal address that should be used on a printed statement.

Reference to the entity that represents information about fee, which is charged for cases when a payment plan is paid by a customer who comes to facility and makes a payment in person.

Merchant's email that should be used on a printed statement.

Footer message of the merchant statement.

Header message of the merchant statement.

Merchant's mail name that should be used on a printed statement

Merchant's phone that should be used on a printed statement.

State of merchant's postal address that should be used on a printed statement.

Street address (line 2) of merchant's postal address that should be used on a printed statement.

Street address (line 1) of merchant's postal address that should be used on a printed statement.

Zip code of merchant's postal address that should be used on a printed statement.

Street address (line 1) of the Merchant's postal address.

Street address (line 2) of the Merchant's postal address.

URL of a page, where status of a submission (batch) is delivered.

Use "Federal Tax Id" in "Business Info" object instead of this field.

Age at which all of the payment plans of a customer get terminated.

Age of a non-committed debt which cannot be reported to credit bureau, at which the outstanding debt is written off.

Time zone of a merchant.

System code indicating the time zone.

Enumeration of possible tokenization policy formats available for the merchant in the system.

Reference to the entity that represents modes that are used to remove tokenization.

Enumeration of possible tokenization updated policy formats available for the merchant in the system.

ZIP code of Merchant's postal address.