Get MSR Balances
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMSRBalances
Use this API to get all the balances of merchant, store, and register such as total sales volume, total sales amount, daily, weekly, monthly, yearly gross amount etc. other details along with merchant name and merchant number.
Request fields details
| Fields | Description |
|---|---|
|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 ---- es: means Spanish Allowable Values: 10 |
|
ExternalIP string |
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 |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 |
|
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 |
|
MSRNumber string Mandatory |
Description - Identifier for Merchant/Store/Register Account to be created Valid Values: 0-9 Format: XXXX Example: 562489 Allowable Values: 12 |
|
MSRLevel integer |
Description - Type of Account to be created Valid Values: 0: Merchant, 1: Store 2: Register Format: XXXXXX Example: 1 |
|
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 |
|
MSRNumber string Mandatory |
Identifier for Merchant/Store/Register Account to be created Valid Values: 0-9 Format: XXXX Example: 562489 Allowable Values: 12 |
|
MSRLevel integer Mandatory |
Type of Account to be created Valid Values: 0: Merchant, 1: Store 2: Register Format: XXXXXX Example: 1 |
Sample request body
{
"Source": "Web",
"IPAddress": null,
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.205.0.56",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"MSRNumber": "8831",
"MSRLevel": 1
}
Response fields details
| Fields | Description |
|---|---|
|
Account
|
MerchantPLAccountModel |
|
Account
|
MerchantPLAccountModel |
Sample response body
{
"Message": "Success",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"Account": {
"MerchantID": 11639,
"InstitutionID": 3235,
"InstitutionName": "ABC, LLC",
"MerchantName": "Merchant 6",
"StoreName": null,
"RegisterName": null,
"MerchantDescription": "Desc",
"MerchantNumber": "666666666",
"NetworkName": null,
"NetworkID": 0,
"SplitFee": null,
"TemplateName": null,
"ProductMapping": "ABC Patient Solutions Revolving",
"SinceBillBalanceBroughtForward": 0.0,
"SinceBillAdjustments": 0.0,
"TotalNumberOfAccounts": 0,
"AtLastBillPreviousBalance": 0.0,
"SinceBillPreviousBalance": 0.0,
"AtLastBillInStorePayments": 0.0,
"SinceBillInStorePayments": 0.0,
"AtLastBillDirectPayments": 0.0,
"SinceBillDirectPayments": 0.0,
"AtLastBillReturns": 0.0,
"SinceBillReturns": 0.0,
"AtLastBillSales": 0.0,
"SinceBillSales": 0.0,
"AtLastBillFinanceCharge": 0.0,
"SinceBillFinanceCharge": 0.0,
"AtLastBillNSFFees": 0.0,
"SinceBillNSFFees": 0.0,
"AtLastBillNSFFeeCredits": 0.0,
"SinceBillNSFFeeCredits": 0.0,
"AtLastBillOtherDebits": 0.0,
"SinceBillOtherDebits": 0.0,
"AtLastBillOtherCredits": 0.0,
"SinceBillOtherCredits": 0.0,
"AtLastBillInStoreOtherCredits": 0.0,
"SinceBillInStoreOtherCredits": 0.0,
"AtLastBillInStoreOtherDebits": 0.0,
"SinceBillInStoreOtherDebits": 0.0,
"AtLastBillNetOutstanding": 0.0,
"SinceBillNetOutstanding": 0.0,
"WeeklySalesCount": 0,
"WeeklySalesAmount": 0.0,
"WeeklyReturnsCount": 0,
"WeeklyReturnsAmount": 0.0,
"WeeklyDirectPaymentsCount": 0,
"WeeklyDirectPaymentsAmount": 0.0,
"WeeklyInStorePaymentsCount": 0,
"WeeklyInStorePaymentsAmount": 0.0,
"WeeklyTotalPaymentsCount": 0,
"WeeklyTotalPaymentsAmount": 0.0,
"WeeklyGrossVolumeCount": 0,
"WeeklyGrossVolumeAmount": 0.0,
"WeeklyNetVolumeCount": 0,
"WeeklyNetVolumeAmount": 0.0,
"WeeklyDiscount": 0.0,
"MonthlyActiveAccounts": 0,
"MonthlyActiveAccountsLastCycle": 0,
"MonthlyAccountsFee": 0.0,
"MonthlyCurrentReserve": 0.0,
"MonthlyPreviousReserve": 0.0,
"MonthlyMerchantFee": 0.0,
"MonthlyPrimeRateAdjustment": 0.0,
"MonthlyOtherCharges": 0.0,
"MonthlyOutstandingBalanceAccounts": 0.0,
"SettlementAmount": 0.0,
"PreviousSettlementAmount": 0.0,
"DisputeAmount": 0.0,
"DisputeCount": 0,
"DailySalesCount": 0,
"DailySalesAmount": 0.0,
"DailyReturnsCount": 0,
"DailyReturnsAmount": 0.0,
"DailyDirectPaymentsCount": 0,
"DailyDirectPaymentsAmount": 0.0,
"DailyInStorePaymentsCount": 0,
"DailyInStorePaymentsAmount": 0.0,
"DailyTotalPaymentsCount": 0,
"DailyTotalPaymentsAmount": 0.0,
"DailyGrossVolumeCount": 0,
"DailyGrossVolumeAmount": 0.0,
"DailyNetVolumeCount": 0,
"DailyNetVolumeAmount": 0.0,
"DailyNSFFees": 0.0,
"DailyNSFFeeCredits": 0.0,
"DailyOtherCredits": 0.0,
"DailyOtherDebits": 0.0,
"DailyDiscount": 0.0,
"YearlySalesCount": 0,
"YearlySalesAmount": 0.0,
"YearlyReturnsCount": 0,
"YearlyReturnsAmount": 0.0,
"YearlyDirectPaymentsCount": 0,
"YearlyDirectPaymentsAmount": 0.0,
"YearlyInStorePaymentsCount": 0,
"YearlyInStorePaymentsAmount": 0.0,
"YearlyTotalPaymentsCount": 0,
"YearlyTotalPaymentsAmount": 0.0,
"YearlyDisputesCount": 0,
"YearlyDisputesAmount": 0.0,
"YearlyGrossVolumeCount": 0,
"YearlyGrossVolumeAmount": 0.0,
"YearlyNetVolumeCount": 0,
"YearlyNetVolumeAmount": 0.0,
"YearlyFinanceCharge": 0.0,
"YearlyNSFFeeCredits": 0.0,
"YearlyNSFFees": 0.0,
"YearlyOtherDebits": 0.0,
"YearlyOtherCredits": 0.0,
"YearlyDiscount": 0.0,
"YearlyBaseFee": 0.0,
"YearlyAccountsFee": 0.0,
"YearlyPrimeRateAdjustment": 0.0,
"YearlyMerchantFee": 0.0,
"YearlySettlementAmount": 0.0,
"YearlyOtherCharges": 0.0,
"LifetimeSalesCount": 0,
"LifetimeSalesAmount": 0.0,
"LifetimeReturnsCount": 0,
"LifetimeReturnsAmount": 0.0,
"LifetimeDirectPaymentsCount": 0,
"LifetimeDirectPaymentsAmount": 0.0,
"LifetimeInStorePaymentsCount": 0,
"LifetimeInStorePaymentsAmount": 0.0,
"LifetimeTotalPaymentsCount": 0,
"LifetimeTotalPaymentsAmount": 0.0,
"LifetimeDisputesCount": 0,
"LifetimeDisputesAmount": 0.0,
"LifetimeGrossVolumeCount": 0,
"LifetimeGrossVolumeAmount": 0.0,
"LifetimeNetVolumeCount": 0,
"LifetimeNetVolumeAmount": 0.0,
"LifetimeFinanceCharge": 0.0,
"LifetimeNSFFees": 0.0,
"LifetimeNSFFeeCredits": 0.0,
"LifetimeOtherDebits": 0.0,
"LifetimeOtherCredits": 0.0,
"LifetimeDiscount": 0.0,
"LifetimeBaseFee": 0.0,
"LifetimeAccountsFee": 0.0,
"LifetimePrimeRateAdjustment": 0.0,
"LifetimeMerchantFee": 0.0,
"LifetimeSettlementAmount": 0.0,
"LifetimeOtherCharges": 0.0,
"DelinquencyTotalDue": 0.0,
"DelinquencyCurrentDue": 0.0,
"DelinquencyPastDue": 0.0,
"DelinquencyOneCyclePastDue": 0.0,
"DelinquencyTwoCyclesPastDue": 0.0,
"DelinquencyThreeCyclesPastDue": 0.0,
"DelinquencyFourCyclesPastDue": 0.0,
"DelinquencyFiveCyclesPastDue": 0.0,
"DelinquencySixCyclesPastDue": 0.0,
"DelinquencySevenCyclesPastDue": 0.0,
"DelinquencyTotalPastDue": 0.0,
"MPLMerchantStatus": 1000,
"PolicyIdentifier": "Grandfathered",
"LineAssignedPolicy": "Grandfathered",
"IsChildFlag": 0,
"MPLMerchantStatusName": null
}
}
}