MerchantReturnsReserve

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  MerchantReturnsReserve
Encapsulates returns reserve related information.
Available Fields:
minimumAmount
References: Merchant Account Group.Return Reserve MIN Amount
XML Representation: attribute
Attributes:
Minimum amount of money for ACH returns that must be held in reserve at all times. See Reserves definition for additional information.
requiredAmount
References: Merchant Account Group.Return Reserve Requested Amount
XML Representation: attribute
Attributes:
Amount of money for ACH returns 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.Return Reserve Collected Amount
XML Representation: attribute
Attributes: ReadOnly
Amount of money for ACH returns 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.Return Reserve Rate
XML Representation: attribute
Attributes:
Percentage of total transaction volume that should be retained as reserve for ACH returns. Using this rate and the Return Reserve Period the requested amount of return reserve is dynamically calculated and adjusted on each remittance. See Reserves definition for additional information.
period
References: Merchant Account Group.Return Reserve Period
XML Representation: attribute
Attributes:
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 Return Reserve Enabled
XML Representation: attribute
Attributes:
Indicates whether return reserve is enabled. If not enabled, money will not be withheld in the reserve.

XML Sample:

<returns minimumAmount="100"  requiredAmount="100"  rate="100"  period="1"  isEnabled="true" />
"<returns 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
Copyright © Constellation Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.