MerchantChargebacksReserve

Type:  Struct
Abstract:  no
Status:  Active
Encapsulates chargeback reserve related information.
minimumAmount
References: Merchant Account Group.Chargeback Reserve Min Amount
XML Representation: attribute
Attributes:
Default Value 0
Minimum amount of money that must be held in reserve at all times. See Reserves definition for additional information.
requiredAmount
References: Merchant Account Group.Chargeback Reserve Requested Amount
XML Representation: attribute
Attributes:
Default Value
Amount of money that must be maintained as chargebacks reserve. Requested amount gets dynamically adjusted as time progresses and processing volume changes. The requested amount should never drop below the minimum amount. See Reserves definition for additional information.
collectedAmount
References: Merchant Account Group.Chargeback Reserve Collected Amount
XML Representation: attribute
Attributes: ReadOnly
Default Value
Amount of money available in the reserve after the last remittance happened. See Reserves definition for additional information.

Note: This field is read-only and cannot be modified.
rate
References: Merchant Account Group.Chargeback Reserve Rate
XML Representation: attribute
Attributes:
Default Value 0
Percentage of total transaction volume that should be retained as reserve. Using this rate and the Chargeback Reserve Period the requested amount of chargeback reserve is dynamically calculated and adjusted on each remittance. See Reserves definition for additional information.
period
References: Merchant Account Group.Chargeback Reserve Period
XML Representation: attribute
Attributes:
Default Value 0
Time period in days, used to determine the requested amount of the reserve. See Reserves definition for additional information.
isEnabled
References: Merchant Account Group.Is Chargeback Reserve Enabled
XML Representation: attribute
Attributes:
Default Value
Indicates whether chargeback reserve is enabled. If not enabled, money will not be withheld in the reserve.

XML Sample:

<chargebacks minimumAmount="100"  requiredAmount="100"  rate="100"  period="1"  isEnabled="true" />

"<chargebacks minimumAmount=\"100\" requiredAmount=\"100\" rate=\"100\" period=\"1\" isEnabled=\"true\" />"

JSON Sample:

{
  "minimumAmount": "100",
  "requiredAmount": "100",
  "rate": "100",
  "period": "1",
  "isEnabled": true
}

XURL Sample:

?minimumAmount=100&requiredAmount=100&rate=100&period=1&isEnabled=true&
minimumAmount=100
requiredAmount=100
rate=100
period=1
isEnabled=true