Get Merchant Reserve Parameters
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantReserveParameters
Use this API to retrieve parameters defined to calculate reserve funds. Reserve funds are required to remain in a reserve account against future disputes and returns. Each month, at the end of the month, the system calculates the required reserve funds, based on the parameters configured on the reserve table specific to that merchant account.
Request fields details
| Fields | Description |
|---|---|
|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
|
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
|
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
|
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
|
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
|
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
|
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
|
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
|
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
|
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
|
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
|
MerchantID integer Conditional |
Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 Condition: Mandatory If MerchantNumber not Inputted in API Request |
|
MerchantNumber string Conditional |
Merchant Number which is assgined to a Merchant Valid Values:0-9 Format:XXXXX Example:12345 Condition: Mandatory If MerchantID not Inputted in API Request Allowable Values: 10 |
Sample request body
{
"Source": "WEB",
"IPAddress": "10.120.0.1",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"MerchantID": 11389,
"MerchantNumber": null
}
Response fields details
| Fields | Description |
|---|---|
|
ReserveProcessingControls
|
ReserveProcessingControls |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"ReserveProcessingControls": {
"AddPastDue90ToReserve": "Yes",
"PastDue": "Amount",
"AddUnmailedtoReserve": "Yes",
"AddCreditBalancestoReserve": "No",
"AddnoFinanceChargeAccountstoReserve": "Yes",
"PercentOfNewBalanceAddToReserve": 0.0,
"ReserveTable": "BENJAMINS",
"IncludedAccountStatus1": "B-Bankruptcy",
"IncludedAccountStatus2": "D - Dispute Account",
"IncludedAccountStatus3": "H - Hold Statements",
"IncludedAccountStatus4": "E - Employee Account",
"IncludedAccountStatus5": "U - Undeliverable"
}
}
}