ConvenienceFee

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  ConvenienceFee
Represents rules according to which convenience fee is charged on merchant’s transactions.
id
References: Convenience Fee.Id
XML Representation: attribute
Attributes:
Default Value
Identifier of the object used for references; auto-incremented integer value.

System identifier of a merchant.
accountProcessingPolicy
References: Convenience Fee.Account Processing Policy
XML Representation: attribute
Attributes:
Default Value
Type of the card that is charged with convenience fee.
The values can be the following:
'V' - Visa
'M' - MasterCard
'X' – American Express
'D' – Discover/Diner's
'A' – Direct debit

Type of the card is to be charged with convenience fee. The values can be the following:
'V' - Visa
'M' - MasterCard
'X' – American Express
'D' – Discover/Diners
'A' - ACH
processingCost
References: Convenience Fee.Processing Cost CL
XML Representation: attribute
Attributes:
Default Value
Indicates whether processing cost is included or not.
The values can be the following:
'G' - Indicates that processing cost is not included
'N' - Indicates that processing cost is included


Indicates whether processing cost is included or not. The values can be the following:
'include' - processing cost is included
'ignore' - processing cost is not included
amountLevel1
References: Convenience Fee.Amount Level1
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as fixed amount that is charged to transactions that fall into the first range of transaction amount (for example, from $0 to $15).

Convenience fee represented as fixed amount that is charged on transactions that fall into first set range of transaction amount (for example, from $0 to $15).
percentageLevel1
References: Convenience Fee.Percentage Level1
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into the first range of transaction amount (for example, from $0 to $15).

Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into first set range of transaction amount (for example, from $0 to $15).
thresholdLevel1
References: Convenience Fee.Threshold Level1
XML Representation: attribute
Attributes:
Default Value
amountLevel2
References: Convenience Fee.Amount Level2
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as fixed amount that is charged on transactions that fall into the second range of transaction amount (for example, from $15 to $50).

Convenience fee represented as fixed amount that is charged on transactions that fall into second set range of transaction amount.
percentageLevel2
References: Convenience Fee.Percentage Level2
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into the second range of transaction amount (for example, from $15 to $50).

Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into second set range of transaction amount.
thresholdLevel2
References: Convenience Fee.Threshold Level2
XML Representation: attribute
Attributes:
Default Value
amountLevel3
References: Convenience Fee.Amount Level3
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as fixed amount that is charged on transactions that fall into the third range of transaction amount (for example, from $50 to $80).

Convenience fee represented as fixed amount that is charged on transactions that fall into third set range of transaction amount.
percentageLevel3
References: Convenience Fee.Percentage Level3
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into the third range of transaction amount (for example, from $50 to $80).

Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into third set range of transaction amount.
thresholdLevel3
References: Convenience Fee.Threshold Level3
XML Representation: attribute
Attributes:
Default Value
Test description
amountLevel4
References: Convenience Fee.Amount Level4
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as fixed amount that is charged on transactions that fall into the fourth range of transaction amount (for example, from $80 to $100).

Convenience fee represented as fixed amount that is charged on transactions that fall into fourth set range of transaction amount.
percentageLevel4
References: Convenience Fee.Percentage Level4
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into the fourth range of transaction amount (for example, from $80 to $100).

Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into fourth set range of transaction amount.
thresholdLevel4
References: Convenience Fee.Threshold Level4
XML Representation: attribute
Attributes:
Default Value
amountLevel5
References: Convenience Fee.Amount Level5
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as fixed amount that is charged on transactions that fall into the fifth range of transaction amount (for example, from $100 and more).

Convenience fee represented as fixed amount that is charged on transactions that fall into fifth set range of transaction amount.
percentageLevel5
References: Convenience Fee.Percentage Level5
XML Representation: attribute
Attributes:
Default Value
Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into the fifth range of transaction amount (for example, from $100 and more).

Convenience fee represented as a transaction’s percentage that is charged on transactions that fall into fifth set range of transaction amount.
isActive
References: Convenience Fee.Is Active
XML Representation: attribute
Attributes:
Default Value

XML Sample:

<convenienceFee
    id="2000" 
    accountProcessingPolicy="M" 
    processingCost="include" 
    amountLevel1="1" 
    percentageLevel1="0" 
    thresholdLevel1="" 
    amountLevel2="2.5" 
    percentageLevel2="0" 
    thresholdLevel2="" 
    amountLevel3="5" 
    percentageLevel3="0.75" 
    thresholdLevel3="" 
    amountLevel4="0" 
    percentageLevel4="3" 
    thresholdLevel4="" 
    amountLevel5="0" 
    percentageLevel5="5.35" 
    isActive="" 
    newField2="" 
    newField4="" />

"<convenienceFee id=\"2000\" accountProcessingPolicy=\"M\" processingCost=\"include\" amountLevel1=\"1\" percentageLevel1=\"0\" thresholdLevel1=\"\" amountLevel2=\"2.5\" percentageLevel2=\"0\" thresholdLevel2=\"\" amountLevel3=\"5\" percentageLevel3=\"0.75\" thresholdLevel3=\"\" amountLevel4=\"0\" percentageLevel4=\"3\" thresholdLevel4=\"\" amountLevel5=\"0\" percentageLevel5=\"5.35\" isActive=\"\" newField2=\"\" newField4=\"\" />"

JSON Sample:

{
  "id": 2000,
  "accountProcessingPolicy": "M",
  "processingCost": "include",
  "amountLevel1": 1,
  "percentageLevel1": 0,
  "thresholdLevel1": "",
  "amountLevel2": 2,
  "percentageLevel2": 0,
  "thresholdLevel2": "",
  "amountLevel3": 5,
  "percentageLevel3": 0,
  "thresholdLevel3": "",
  "amountLevel4": 0,
  "percentageLevel4": 3,
  "thresholdLevel4": "",
  "amountLevel5": 0,
  "percentageLevel5": 5,
  "isActive": "",
  "newField2": "",
  "newField4": ""
}

XURL Sample:

?id=2000&accountProcessingPolicy=M&processingCost=include&amountLevel1=1&percentageLevel1=0&thresholdLevel1=&amountLevel2=2.5&percentageLevel2=0&thresholdLevel2=&amountLevel3=5&percentageLevel3=0.75&thresholdLevel3=&amountLevel4=0&percentageLevel4=3&thresholdLevel4=&amountLevel5=0&percentageLevel5=5.35&isActive=&newField2=&newField4=&
id=2000
accountProcessingPolicy=M
processingCost=include
amountLevel1=1
percentageLevel1=0
thresholdLevel1=
amountLevel2=2.5
percentageLevel2=0
thresholdLevel2=
amountLevel3=5
percentageLevel3=0.75
thresholdLevel3=
amountLevel4=0
percentageLevel4=3
thresholdLevel4=
amountLevel5=0
percentageLevel5=5.35
isActive=
newField2=
newField4=