Documentation
for developers and administrators
Home
APIs
Processing
Billing
Management
Webhooks
Manuals
Terminology
User Guides
User Interface Reference
How-To Tutorials
Lessons
Data Dictionaries
UniCore
UniCharge
UniBill
Build
Properties Definition
Resources (Directory Structure)
Zip and Country Codes
Development
Log Files
Permissions
JNDI Names
Job Queues
Reference Materials
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
Entire website
This section only
MerchantRefundsReserve
Type:
Struct
Abstract:
no
Status:
Active
Java Class:
MerchantRefundsReserve
Encapsulates refund reserve related information.
Available Fields:
collectedAmount
isEnabled
remainingAmount
requiredAmount
requiredAmount
References:
Merchant Account Group.
Refund Reserve Requested Amount
XML Representation:
attribute
Attributes:
Default Value
Amount of the reserve that the system needs to maintain. See
Reserves
definition for additional information.
collectedAmount
References:
Merchant Account Group.
Refund Reserve Collected Amount
XML Representation:
attribute
Attributes:
ReadOnly
Default Value
Amount of the reserve that the system managed to collect at the time of the last remittance. See
Reserves
definition for additional information.
Note: This field is read-only and cannot be modified.
remainingAmount
References:
Merchant Account Group.
Refund Reserve Remaining Amount
XML Representation:
attribute
Attributes:
ReadOnly
Default Value
Amount of money, against which refunds can be made. See
Reserves
definition for additional information.
Note: This field is read-only and cannot be modified.
isEnabled
References:
Merchant Account Group.
Is Refund Reserve Enabled
XML Representation:
attribute
Attributes:
Default Value
Indicates whether refund reserve is enabled. If not enabled, limited refunds are allowed.
XML Sample:
<refunds
requiredAmount
=
"100"
isEnabled
=
"true"
/>
"<refunds requiredAmount=\"100\" isEnabled=\"true\" />"
JSON Sample:
{
"requiredAmount"
:
"100"
,
"isEnabled"
:
true
}
XURL Sample:
?requiredAmount=100&isEnabled=true&
requiredAmount
=
100
isEnabled
=
true