Get MSR
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMSR
Use this API to retrieve information about a specific merchant, store, or register within an Institution or a specific merchant, store, or register and all associated hierarchies within it.
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 |
|
InstitutionID integer Optional |
Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard. |
|
MSRLevel string Optional |
Type of Account to be created Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1 Allowable Values: 1 |
|
MSRNumber string Optional |
Identifier for Merchant/Store/Register Account to be created Valid Values:A-Z, 0-9 Allowable Values: 12 |
|
GetSubTree string Optional |
GetSubTree Possible Values 0: No(default) To get only Matching Store/Merchant/Registers 1: Yes, To get All Stores, Merchants, Registers under the merchant.Will display all Store and register hierarchy. Allowable Values: 5 |
Sample request body
{
"Source": "Web",
"IPAddress": "10.120.0.0",
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.120.0.0",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"InstitutionID": null,
"MSRLevel": null,
"MSRNumber": null,
"GetSubTree": null
}
Response fields details
| Fields | Description |
|---|---|
|
ResponseID string |
This number will ensure that API hit our internal servers. This will always be unique. It can also be null when API is returned from our external servers example – If we pass blank User Id and Password in input then this will be null. This ID can be used for tracking purpose of any request hit the corecard internal servers. Example:12365478 Allowable Values: 15 |
|
MSRList array |
List Containing matching records |
Sample response body
{
"Message": "Request processed successfully.",
"Status": true,
"ErrorCode": "ERR01155",
"ResponseData": {
"ResponseID": "65687878",
"MSRList": [
{
"InstitutionID": null,
"ParentMSRNumber": null,
"MSRLevel": null,
"MSRNumber": null,
"MSRName": null,
"MerchantDescription": null,
"MerchantRateTable": null,
"BillingCycle": null,
"MerchantReserveTable": null,
"ContactType": null,
"FirstName": null,
"LastName": null,
"AddressLine1": null,
"AddressLine2": null,
"City": null,
"State": null,
"PostalCode": null,
"County": null,
"Country": null,
"CustomerID": null,
"MSRNumber1": null,
"MSRNumber2": null,
"MSRNumber3": null,
"MSRFaxNumber": null,
"MSREmail1": null,
"MSREmail2": null,
"MSRLegalEntityName": null,
"MSRDBAName": null,
"CompanyName": null,
"Position": null,
"MSRTaxIdentificationNumber": null,
"MSRACHRoutingNumber": null,
"MSRACHCheckingAccnum": null,
"MSRACHAccName": null,
"LastUpdateDate": null,
"LastUpdateUserID": null,
"MSRTermOverrideInd": null,
"MSRWebServicesPassword": null,
"MSRCreationDate": null,
"MSROverrideFeeRate": null,
"MSROverrideReserveRate": null,
"MSRCreditFirstName": null,
"MSRCreditLastName": null,
"MSRCreditWorkPhone": null,
"MSRCreditMobilePhone": null,
"MSRCreditEmail1": null,
"MSRAccountingFirstName": null,
"MSRAccountingLastName": null,
"MSRAccountingWorkPhone": null,
"MSRAccountingMobilePhone": null,
"MSRAccountingEmail1": null,
"MSRSalesFirstName": null,
"MSRSalesLastName": null,
"MSRSalesWorkPhone": null,
"MSRSalesMobilePhone": null,
"MSRSalesEmail1": null,
"MSRSponserID": null,
"MSRArrangementID": null,
"MSRAccountManagerFirstName": null,
"MSRAccountManagerLastName": null,
"ParentMSRSalesFirstName": null,
"ParentMSRSalesLastName": null,
"MSRExternalID": null,
"MSRExternalCustomerID": null,
"MSRPIN": null,
"MSREnrollmentDate": null,
"MerchantCategory": null,
"MSRCreditLimitInd": null,
"MSRCreditLimitMaxAmount": null,
"MSRDirectBatchInd": null,
"MSRApplicationTypeOverride": null,
"MSRFeeWaiver": null,
"MSRFeeDays": null,
"MSRBillingFrequency": null,
"MSRGSDInd": null,
"MSRExternalInd": null,
"MSRExtCompanyID": null,
"MSRConsumerDirectOptIn": null,
"MSRMemail2": null,
"MSRContactPhone": null,
"MSRServiceAreaAddLine1": null,
"MSRServiceAreaAddLine2": null,
"MSRServiceAreaCity": null,
"MSRServiceAreaState": null,
"MSRServiceAreaZip": null,
"ServiceDescription": null,
"MSRServiceWebsite": null,
"MSRServiceAreaRadius": null,
"MSRServiceLocationLongitude": null,
"MSRServiceLocationLatitude": null,
"MSRLogoID": null,
"MSRServiceLocationPoint": null,
"MSRServiceLocationRadiusMiles": null,
"MSRProgram": null,
"MSRVersion": null,
"MSRSettlementLevel": 0,
"MSRPolicyIdentifier": null,
"MSRHighLinePolicy": null,
"MSRLineAssignmentPolicy": null,
"NetworkID": null,
"NetworkName": null,
"MSRSplitFee": null,
"MerchantLogo": null,
"WeekDayHours": null,
"WeekendHours": null,
"SiteURL": null,
"Motto": null,
"CardActivationSiteURL": null,
"Disclosure": null,
"MTAcode": null,
"CardDescription": null,
"NameOnCard": null,
"ContactNumber": null,
"Tran_CompanyID": null,
"Tran_CompanyName": null
}
]
}
}