Merchant Fee UML

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.

Defines what types of cards are getting deposited through remittance process in case of batch processing.
The value is a mask consisting of 9 characters.
Each position in the mask is reserved for a specific account type:
1-Visa, V if deposited, else 0
2-MasterCard, M if deposited, else 0
3-Discover, D if deposited, else 0
4-ACH, X if deposited, else 0
5-Amex, A if deposited, else 0
6-Visa PINdebit, 1 if deposited, else 0
7-MasterCard PINdebit, 2 if deposited, else 0
8-EBT, E if deposited, else 0
9-bankCard, B if deposited, else 0.
The last four digits are always 0000, since the four respective card types are never deposited during batch processing.
For example, if all card types (except for the last four) are deposited, the value looks as follows: VMDXA0000.

Defines what fees are charged on different transaction types under batch processing.
The value is a mask, consisting of 35 characters divided into 5 groups. Each group consists of a letter, specifying the outcome of transaction (A for approval, D for decline, V for void, B for blacklist, E for error), followed by 6 boolean characters (0 for false, 1 for true).
First 3 out of 6 boolean characters concern processing fees, while the last 3 concern per-item fees.
Characters 1-3 out of these 6 boolean values specify, whether processing fees are charged on this type of transaction during regular processing rebill, and retry. Characters 4-6 specify whether per-item fees are charged during regular processing, rebill, and retry or not.
Fees on Void transactions are not charged during batch processing, so the 6 characters following the letter V are always zeros.
Example
The value A111111D111111V000000B110110E100100 means that
1 approvalRegularProcessing = true
2 approvalRebillProcessing = true
3 approvalRetryProcessing = true
4 approvalRegularItem = true
5 approvalRebillItem = true
6 approvalRetryItem = true

declineRegularProcessing = true
declineRebillProcessing = true
declineRetryProcessing = true
declineRegularItem = true
declineRebillItem = true
declineRetryItem = true

void - all boolean values in the group are always false

blacklistRegularProcessing = true
blacklistRebillProcessing = true
blacklistRegularItem = true
blacklistRebillItem = true

errorProcessing = true
errorItem = true

Any additional information (or short descrition) provided by the merchant.

Reference to the entity that represents fee schema information.

Code of the fee template selected for the portfolio.

Identifier of the object used for references; auto-incremented integer value.

Indicates whether the record is active in the system.

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.

Reference to the entity that represents merchant cycle information.

Reference to the entity that represents merchant fee details information.

Name of the merchant fee.

Parameters applied to the merchant fee.

Defines what types of cards are getting deposited through remittance process in case of real-time processing.
The value is a mask consisting of 9 characters.
Each position in the mask is reserved for a specific account type:
1-Visa, V if deposited, else 0
2-MasterCard, M if deposited, else 0
3-Discover, D if deposited, else 0
4-ACH, X if deposited, else 0
5-Amex, A if deposited, else 0
6-Visa PINdebit, 1 if deposited, else 0
7-MasterCard PINdebit, 2 if deposited, else 0
8-EBT, E if deposited, else 0
9-bankCard, B if deposited, else 0.
For example, if all cards except Amex, Visa PINDebit and EBT are deposited, the field will look as follows: VMDX0020B.

Defines, what fees are charged on different transaction types under real-time processing.
The value is a mask, consisting of 35 characters divided into 5 groups. Each group consists of a letter, specifying the outcome of transaction (A for approval, D for decline, V for void, B for blacklist, E for error), followed by 6 boolean characters (0 for false, 1 for true).
First 3 out of 6 boolean characters concern processing fees, while the last 3 concern per-item fees.
Characters 1-3 out of these 6 boolean values specify, whether processing fees are charged on this type of transaction during regular processing rebill, and retry. Characters 4-6 specify whether per-item fees are charged during regular processing, rebill, and retry or not.
Processing and per-item fees are not charged for transactions comming back as errors (under real-time processing), so the last 6 charachters in the value (following the letter E) are always zeros.
Example
the value A100100D100100V100100B100100E000000 means that
approvalProcessing = true
approvalItem = true
declineProcessing = true
declineItem = true
voidProcessing = true
voidItem = true
blacklistProcessing = true
blacklistItem = true
errorProcessing = false (always)
errorItem = false (always).

Secondary identifier which can be used to cross-reference records between TidyPay and integrated systems.

Reference to the java class, which provides definition of the fee schema.