Merchant Management
You can use the CoreCard system to establish a merchant and its sub-entity to onboard a merchant and merchant network. This can be used to sell cards from the different card programs offered. Multiple parallel hierarchies of child merchants can be created under each merchant node, whereas each of the merchant nodes can have multiple store hierarchies underneath.
Further, many merchant establishments can be grouped to form a merchant network. Card accounts originated from any of the network merchants can be used to make purchases from all of the merchants in the same network. An individual merchant establishment can offer different credit plans (i.e., purchase schemes) or interest rates to cardholders for cardholder transactions.
Your card's account transactions originating on a merchant or activity record, or the merchant reserve parameters of a specific merchant establishment, can be retrieved using CoreCard's designated API.

Update MSR
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/UpdateMSR
Use this API to update details of a merchant, store, or register for an institution based on MSR-level input. A user may update the merchant, store, or register names, as well as address details, bank account numbers, and ACH routing numbers.
Request fields detail
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 Default: en - English 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 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 Mandatory |
Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard. |
MSRLevel integer Mandatory |
Type of Account to be Updated Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1 Allowable Values: 1 |
MSRNumber integer Mandatory |
Identifier for Merchant/Store/Register Account to be created Valid Values:0-9 Allowable Values: 5 |
ParentMSRNumber integer Mandatory |
Identifier for Parent account under which Merchant/Store/Register Account to be Updated. Valid Values:0-9 Allowable Values: 5 |
MSRName string Mandatory |
Name of the Merchant. Valid Values:A-Z,0-9 Example:ABC LLC Allowable Values: 100 |
MerchantDescription string Conditional |
Description of Account Valid Values:A-Z,0-9 Example:ABC LLC Condition : Required for Merchant and Ignored for Stored/Register Allowable Values: 30 |
ContactType integer Mandatory |
Type of contact of Merchant Valid Values: 0 = None 1 = Billing 2 = Settlement 3 = Administration 4 = Department 5 = Division Example:3 Allowable Values: 50 |
MerchantState string Mandatory |
Merchant’s State Valid Values:A-Z,0-9 Example:Alabama Allowable Values: 5 |
MSRWorkNumber string Optional |
MSR Work Phone Number Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRHomePhone string Optional |
MSR Home Phone Number Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRMobilePhone string Optional |
MSR Mobile Phone Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSRFaxNumber string Optional |
MSR Fax Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSREmail1 string Optional |
MSR Email1 Format:abc@cc.com Example:user1@gmail.com Allowable Values: 100 |
MSREmail2 string Optional |
MSR Email2 Format:abc@cc.com Example:user1@gmail.com Allowable Values: 100 |
MSRLegalEntityName string Optional |
Name of the Legal Entity Valid Values:A-Z,0-9 Example:ABC LLC Allowable Values: 30 |
MSRDBAName string Optional |
Do Business As Name Valid Values:A-Z,0-9 Example:ABC LLC Allowable Values: 50 |
MSRTaxIdentificationNumber string Optional |
Organization’s Tax Id Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 25 |
MSRReserveTable integer Optional |
Merchant Reserve Table Account Id Valid Values:0-9 Format:XXXXXXXXXXXX Example:4785 |
MSRACHROUTINGNUMBER string Conditional |
ABA Routing Number Valid Values:0-9 Format:XXXXXX Example:5478968 Allowable Values: 9 |
MSRACHCHECKINGACCNUM string Conditional |
Bank Account Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Condition:Required when SettlementLevel = 0 Allowable Values: 19 |
MSRACHACCNAME string Conditional |
Account Name Condition:Required when SettlementLevel = 0 Allowable Values: 100 |
MSRTermOverrideInd string Optional |
Merchant TermOverride Indicator Allowable Values: 5 |
MSROverrideFeeRate decimal Optional |
Override Fee Rate |
MSROverrideReserveRate decimal Optional |
Override Reserve Rate |
MSRCreditFirstName string Optional |
Credit First Name Allowable Values: 50 |
MSRCreditLastName string Optional |
Credit Last Name Allowable Values: 50 |
MSRCreditWorkPhone string Optional |
Credit Work Phone Valid Values:0-9 Format:XXXXXX Example:5478968 Allowable Values: 20 |
MSRCreditMobilePhone string Optional |
Credit Mobile Phone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSRCreditEmail1 string Optional |
Credit Email 1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRAccountingFirstName string Optional |
Accounting First Name Allowable Values: 50 |
MSRAccountingLastName string Optional |
Accounting Last Name Allowable Values: 50 |
MSRAccountingWorkPhone string Optional |
Accounting Work Phone Valid Values:0-9 Format:XXXXXXXX Example:54789686 Allowable Values: 20 |
MSRAccountingMobilePhone string Optional |
Accounting Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRAccountingEmail1 string Optional |
Accounting Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRSalesFirstName string Optional |
Sales First Name Allowable Values: 50 |
MSRSalesLastName string Optional |
Sales Last Name Allowable Values: 50 |
MSRSalesWorkPhone string Optional |
Sales Work Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRSalesMobilePhone string Optional |
Sales Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRSalesEmail1 string Optional |
Sales Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRSponserID string Optional |
Merchant Sponser ID Allowable Values: 200 |
MSRArrangementID string Optional |
Arrangement ID Allowable Values: 200 |
MSRAccountManagerFirstName string Optional |
Account Manager First Name Allowable Values: 50 |
MSRAccountManagerLastName string Optional |
Account Manager Last Name Allowable Values: 50 |
ParentMSRSalesFirstName string Optional |
Parent Merchant Sales First Name Allowable Values: 50 |
ParentMSRSalesLastName string Optional |
Parent Merchant Sales Last Name Allowable Values: 50 |
MSRExternalCustomerID string Optional |
External CustomerID Allowable Values: 200 |
MSRExternalID string Optional |
External MerchantID Allowable Values: 50 |
MSRPIN string Optional |
Merchant PIN Allowable Values: 200 |
MSREnrollmentDate datetime Optional |
Enrollment Date Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
MSRCreditLimitInd string Optional |
Credit Limit Indicator Allowable Values: 50 |
MSRCreditLimitMaxAmount decimal Optional |
Credit Limit Max Amount |
MSRDirectBatchInd string Optional |
Direct Batch Indicator Allowable Values: 50 |
MSRApplicationTypeOverride string Optional |
Application Type Override Allowable Values: 50 |
MSRFeeWaiver string Optional |
Fee Waiver Allowable Values: 10 |
MSRFeeDays string Optional |
Fee Days Allowable Values: 200 |
MSRBillingFrequency string Optional |
Billing Frequency Allowable Values: 50 |
MSRGSDInd string Optional |
Merchant GSD Indicator Allowable Values: 200 |
MSRExternalInd string Optional |
External Merchant Indicator Allowable Values: 200 |
MSRExtCompanyID string Optional |
External Company ID Allowable Values: 200 |
MSRConsumerDirectOptIn string Optional |
Consumer Direct Opt-In Allowable Values: 200 |
MSRMemail2 string Optional |
Merchant Email 2 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRContactPhone string Optional |
ContactPhone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSRServiceAreaAddLine1 string Optional |
Service Area Address Line1 Allowable Values: 50 |
MSRServiceAreaAddLine2 string Optional |
Service Area Address Line2 Allowable Values: 50 |
MSRServiceAreaCity string Optional |
Service Area City Allowable Values: 40 |
MSRServiceAreaState string Optional |
Service Area State Allowable Values: 5 |
MSRServiceAreaZip string Optional |
Service Area Zip Allowable Values: 10 |
MSRServiceWebsite string Optional |
Service Website Allowable Values: 300 |
MSRServiceAreaRadius string Optional |
Service Area Radius Allowable Values: 15 |
MSRServiceLocationLongitude string Optional |
Service Location Longitude Allowable Values: 200 |
MSRServiceLocationLatitude string Optional |
Service Location Latitude Allowable Values: 200 |
MSRLogoID string Optional |
ProductID (Logo ID) of Merchant. Allowable Values: 200 |
MSRServiceLocationPoint string Optional |
Service Location Point Allowable Values: 200 |
MSRServiceLocationRadiusMiles string Optional |
Service Location Radius Miles Allowable Values: 15 |
MSRProgram string Optional |
Program (ProductName) Allowable Values: 100 |
MSRVersion string Optional |
Version Allowable Values: 25 |
MSRPolicyIdentifier integer Conditional |
PolicyIdentifier, will result in digits only Ie. 1 or 2. Possible Value: 1=Grandfathered, 2=Standard Condition:Required when MSRLevel = 0 Allowable Values: 1 |
MSRHighLinePolicy integer Conditional |
HighLinePolicy, will result in digits only Ie. 0 or 1. Possible Values: 0 = No, 1 = Yes Condition:Required when MSRLevel = 0 Allowable Values: 1 |
MSRLineAssignmentPolicy integer Optional |
Line Assigned Policy of Merchant Possible Value: 1=Grandfathered, 2=Standard |
MSRWebServicesPassword string Optional |
Merchant Web Services Password. Allowable Values: 120 |
MSRCreationDate datetime Optional |
Merchant Creation Date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
MSRSplitFee integer Optional |
SplitFee for Merchant Settlement 1 = YES (for seperate credit and debit amount) 0 = NO/NULL (for combine credit and debit amount) Allowable Values: 10 |
MSRTemplateID string Optional |
TemplateID of Merchant Offering Template. Example:MOT1001 Allowable Values: 100 |
AddressLine1 string Mandatory |
MSR Address Line 1. Valid Values:A-Z,0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string Optional |
MSR Address Line 2. Valid Values:A-Z,0-9 Example:Park Avenue Allowable Values: 50 |
City string Mandatory |
City Name of the MSR address Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 40 |
PostalCode string Mandatory |
Postal code of MSR address Valid Values:0-9 Format:XXXXXX Example:5478968 Allowable Values: 10 |
County string Optional |
County of MSR Valid Values:0-9 Format:XXXXX Example:54789 Allowable Values: 40 |
Country string Mandatory |
Country Name of the MSR address Example:USA Allowable Values: 5 |
CustomerID string Mandatory |
Id Number for Contact/Merchant/Store/Register Allowable Values: 100 |
CompanyName string Mandatory |
Company Name Allowable Values: 50 |
FirstName string Mandatory |
Card holder's First name. Valid Values:A-Z Example:User Allowable Values: 50 |
LastName string Mandatory |
Card holder's Last name. Valid Values:A-Z Example:Smith Allowable Values: 50 |
Position integer Optional |
Employment position of the card holder Valid Values: 0 - None 1 - President 2 - Vice 3 - Director 4 - Manager 5 - Administrator Example: 4 |
MerchantCategory string Optional |
Merchant Category Allowable Values: 200 |
ServiceDescription string Optional |
Service Description Allowable Values: 256 |
NetworkName string Optional |
Name of Network from which Merchant needed to be associated Allowable Values: 50 |
NetworkID int64 Optional |
NetworkID of Network from which Merchant needed to be associated Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 |
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, "InstitutionID": 3235, "MSRLevel": 1, "MSRNumber": 6000, "ParentMSRNumber": 11607, "MSRName": "M 6000", "MerchantDescription": "M 6000", "ContactType": 1, "MerchantState": "AL", "MSRWorkNumber": null, "MSRHomePhone": null, "MSRMobilePhone": null, "MSRFaxNumber": "45577777", "MSREmail1": "abc@xyz.com", "MSREmail2": null, "MSRLegalEntityName": null, "MSRDBAName": null, "MSRTaxIdentificationNumber": null, "MSRReserveTable": 4785, "MSRACHROUTINGNUMBER": "011000015", "MSRACHCHECKINGACCNUM": "12457857875", "MSRACHACCNAME": null, "MSRTermOverrideInd": 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, "MSRExternalCustomerID": null, "MSRExternalID": null, "MSRPIN": null, "MSREnrollmentDate": 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, "MSRServiceWebsite": null, "MSRServiceAreaRadius": null, "MSRServiceLocationLongitude": null, "MSRServiceLocationLatitude": null, "MSRLogoID": null, "MSRServiceLocationPoint": null, "MSRServiceLocationRadiusMiles": null, "MSRProgram": null, "MSRVersion": null, "MSRPolicyIdentifier": null, "MSRHighLinePolicy": null, "MSRLineAssignmentPolicy": null, "MSRWebServicesPassword": null, "MSRCreationDate": null, "MSRSplitFee": null, "MSRTemplateID": null, "AddressLine1": "Address Line 1", "AddressLine2": "Address Line 2", "City": "New York", "PostalCode": "45678", "County": null, "Country": "USA", "CustomerID": "47855", "CompanyName": "Corecard", "FirstName": "First", "LastName": "Last", "Position": 4, "MerchantCategory": "1", "ServiceDescription": null, "NetworkName": "Network_2", "NetworkID": 1002 }
Response fields detail
Fields | Description |
---|---|
ResponseID string |
This number indicates that API responded. Response ID is unique. |
Sample response body
{ "application/json": { "Message": "Request processed successfully", "Status": true, "ErrorCode": "ERR01155", "ResponseData": { "ResponseID": "57324863" } } }
Get Plan And Payment By Amount
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetPlanAndPaymentByAmount
This brings plans and payments for given Product/Merchant/Transaction Amount.
Request fields detail
Fields | Description |
---|
Sample request body
[ { "in": "header", "name": "Authorization", "description": "access token", "required": true, "type": "string", "default": "Bearer " }, { "in": "body", "name": "body", "description": "GetPlanAndPaymentByAmountRequestModel.", "schema": { "$ref": "#/definitions/GetPlanAndPaymentByAmountRequestModel" } } ]
Response fields detail
Fields | Description |
---|
Sample response body
{ "200": { "description": "Success", "schema": { "$ref": "#/definitions/GetPlanAndPaymentByAmountResponseModelApiResult" }, "examples": { "application/json": { "Message": "Processed Successfully.", "Status": true, "ErrorCode": "ERR01149", "ResponseData": { "ResponseID": "56882604", "CreditPlanMasterAndPaymentInformationDetails": [ { "CreditPlanMaster": "6071", "CreditPlanDescription": "Fixed APR of 5.99%-28.99% for 48 Months", "CreditPlanType": "EPP", "LoanTerm": "48", "LowRate": "5.99%", "HighRate": "28.99%", "InterestRate": "5.99% - 28.99%", "TotalInterestAmount": "$127.04 - $700.16", "EMIAmount": "$23.48 - $35.42", "DefermentPeriod": null, "OptionalPaymentToAvoidInterest": null, "MonthlyMinimumRequiredPayment": null } ] } } } }, "ERR02105": { "description": "Mandatory field cannot be null." }, "ERR02177": { "description": "Transaction amount can not be blank." }, "ERR03138": { "description": "Invalid Transaction Amount." }, "ERR03203": { "description": "Invalid Merchant." }, "ERR03574": { "description": "No CPM Details Found." }, "ERR01149": { "description": "Processed Successfully." }, "ERR03116": { "description": "Invalid Program." } }
Merchant Rate Table
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/MerchantRateTable
Use this API to insert a new merchant rate table or update an existing merchant rate table. The API requires the institution ID, MRTID, merchant rate table, fee type, discount fee timing, fee calculation basis, and other information. The API will also retrieve the stated fee type for any merchant, fee calculation logic, discount timing, and other criteria.
Request fields detail
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 Default: en - English 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 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 |
UpdateFlag integer Mandatory |
Indicates whether request is an insert request or update request 1: for Update request 0: for Insert request |
InstitutionId integer Mandatory |
Unique identification number for Institution. Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
MRTID string Conditional |
Merchant rate table ID is mendatory when request is an update request Valid Values:0-9,A-Z Format: XXX Example: 561 Condition: Mandatory when its an update request Allowable Values: 19 |
MerchantRateTable string Conditional |
This tag refers to the Rate table of that plan. Valid Values:A-Z, 0-9 Format:XXXXXX Example:6 Months No Interest if Paid in Full Allowable Values: 20 |
MerchantRateParentName string Optional |
It is used to provide Parent to inherit Merchant Rate Table Valid Values:0-9, A-Z Format: XXXX Example: MRT1 Allowable Values: 20 |
FeeType integer Conditional |
Type of Fee included - 0: Discount 1: Participation Valid Values:0,1 Format:X Example:0,1 |
DiscountFeeTiming integer Mandatory |
Frequency of Discount Fee- 0: Daily 1: Weekly 2: Cycle 3: Per Transaction Valid Values:0,1,2,3 Format: X Example: 0,1,2,3 |
FeeCalculationBasis integer Mandatory |
On what basis the fee will calculated as - 0: Count 1: Amount 2: Both Valid Values:0,1,2 Format: X Example: 0,1,2 |
VolumeType integer Mandatory |
Volume Type 0: Daily 1: Weekly Valid Values:0,1 Format: X Example: 0,1 |
FeeCalculation string Conditional |
Fee Calculation 0: Percent of volume amount Valid Values:0 Format: X Example: 0 Allowable Values: 20 |
AmountPerVolume decimal Optional |
Amount Per Volume Valid Values:0-9 Format: XX.XX Example: 245.22 |
AmountPerTransaction decimal Optional |
Amount per transaction. Valid Values:0-9 Format: XX.XX Example: 245.22 |
TransactionCode string Optional |
Transaction Code for the posting of Single Transaction. Valid Values: 427248 = Principal Adjustment Allowable Values: 20 |
MRTDetailList array |
MRTDetailList |
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, "UpdateFlag": 0, "InstitutionId": 3235, "MRTID": "", "MerchantRateTable": null, "MerchantRateParentName": "", "FeeType": 1, "DiscountFeeTiming": 0, "FeeCalculationBasis": 0, "VolumeType": 0, "FeeCalculation": "0", "AmountPerVolume": 1.0, "AmountPerTransaction": 1.0, "TransactionCode": "02", "MRTDetailList": [ { "FICOScore": 10, "FixedRate1": 20.0, "FixedRate2": 23.0, "FixedRate3": 33.0, "FixedRate4": 43.0, "FixedRate5": null, "TierLimitIndicator": "0", "TierMaxBalance1": null, "TierMaxBalance2": null, "TierMaxBalance3": null, "TierMaxBalance4": null } ] }
Response fields detail
Fields | Description |
---|---|
ResponseID string |
This number indicates that API responded.Response ID is unique.This value will be null if no authentication information was passed. Response ID can be used for tracking |
Sample response body
{ "application/json": { "Message": "MRT Inserted Successfully", "Status": true, "ErrorCode": "ERR01158", "ResponseData": { "ResponseID": "56742560" } } }
Get Merchant Offering
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantOffering
Use this API to retrieve the credit plans offered by a merchant to the customer for making repayment against a purchase by using the merchant ID. The API returns the merchant details, such as credit plan number, merchant rate, minimum and maximum purchase amount eligible for merchant offering.
Request fields detail
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 Default: en - English 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 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 |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXXXX Example: 562489 |
ProductMapping integer Mandatory |
Product Mapping Code. Valid Values: 0-9 Format: XXXX Example: 3399 |
MerchantNumber string Conditional |
Number which is assigned to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 11642 Allowable Values: 9 |
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": 11607, "MerchantNumber": null, "ProductMapping": 3399 }
Response fields detail
Fields | Description |
---|---|
MerchantOfferingResult array |
Array for Merchant Offerings |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "MerchantOfferingResult": [ { "AccountID": 1001, "CreditPlanMaster": "6049", "MerchantRateTable": "776", "LowPurchaseAmount": 0.0, "HighPurchaseAmount": 25000.0, "SelectedOffering": true } ] } } }
Create Network
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/CreateNetwork
Use this API to add merchant establishments providing common services in a network (e.g., all dental clinics that provide dental treatments and make offers to cardholders through a network). The API allows the creation of a unique network within an Institution.
Request fields detail
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 Default: en - English 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 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 Mandatory |
Unique identification number for Institution Valid Values:0-9 Example:Fixed value needs to pass which is provided by Corecard. |
NetworkName string Mandatory |
Name of the Network Allowable Values: 50 |
NetworkDescription string Optional |
Description of the Network Valid Values: Text Allowable Values: 200 |
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": 45824, "NetworkName": "Network1", "NetworkDescription": "Description of Network1" }
Response fields detail
Fields | Description |
---|---|
NetworkID int64 |
System generated ID Assigned on the Network Example: 12345 |
Sample response body
{ "application/json": { "Message": "Network created successfully", "Status": true, "ErrorCode": "ERR01178", "ResponseData": { "NetworkID": 1005 } } }
Create MSR
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/CreateMSR
Use this API to create merchant, store, or register (i.e., merchant and its hierarchy) entities in the CoreCARD system. The API is used to create one entity at a time based on input MSR-level information.
Note
A merchant entity should be created before creating a store entity and a store entity should be created before creating a register in the system.
Request fields detail
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 Default: en - English 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 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 |
MSRLevel string Mandatory |
Type of Account to be created Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1 Allowable Values: 1 |
MSRNumber string Mandatory |
Identifier for Merchant/Store/Register Account to be created Valid Values:A-Z, 0-9 Allowable Values: 5 |
ParentMSRNumber string Mandatory |
Identifier for Parent account under which Merchant/Store/Register Account to be created. Valid Values:A-Z,0-9 Allowable Values: 5 |
MSRName string Mandatory |
Name of the Merchant. Valid Values:A-Z,0-9 Example:ABC LLC Allowable Values: 100 |
MerchantDescription string Conditional |
Description of Account Valid Values:A-Z,0-9 Example:ABC LLC Condition : Required for Merchant and Ignored for Stored/Register Allowable Values: 30 |
ContactType string Mandatory |
Type of contact of Merchant Valid Values: 0 = None 1 = Billing 2 = Settlement 3 = Administration 4 = Department 5 = Division Example:3 Allowable Values: 50 |
MerchantState string Mandatory |
Merchant’s State Valid Values:A-Z,0-9 Example:Alabama Allowable Values: 5 |
MSRNumber1 string Optional |
MSR Contact number Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRNumber2 string Optional |
MSR Contact number Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRNumber3 string Optional |
MSR Contact number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSRFaxNumber string Optional |
MSR Fax Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSREmail1 string Optional |
MSR Email1 Format:abc@cc.com Example:user1@gmail.com Allowable Values: 100 |
MSREmail2 string Optional |
MSR Email2 Format:abc@cc.com Example:user1@gmail.com Allowable Values: 100 |
MSRLegalEntityName string Optional |
Name of the Legal Entity Valid Values:A-Z,0-9 Example:ABC LLC Allowable Values: 30 |
MSRDBAName string Optional |
Do Business As Name Valid Values:A-Z,0-9 Example:ABC LLC Allowable Values: 50 |
MSRTaxIdentificationNumber string Optional |
Organization’s Tax Id Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 25 |
MSRReserveTable integer Optional |
Merchant Reserve Table Account Id Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 |
MSRACHRoutingNumber string Conditional |
ABA Routing Number Valid Values:0-9 Format:XXXXXX Example:5478968 Allowable Values: 9 |
MSRACHCheckingAccnum string Conditional |
Bank Account Number Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Condition:Required when SettlementLevel = 0 Allowable Values: 19 |
MSRACHAccName string Conditional |
Account Name Condition:Required when SettlementLevel = 0 Allowable Values: 100 |
MSRTermOverrideInd string Optional |
Merchant TermOverride Indicator Allowable Values: 5 |
MSROverrideFeeRate decimal Optional |
Override Fee Rate |
MSROverrideReserveRate decimal Optional |
Override Reserve Rate |
MSRCreditFirstName string Optional |
Credit First Name Allowable Values: 50 |
MSRCreditLastName string Optional |
Credit Last Name Allowable Values: 50 |
MSRCreditWorkPhone string Optional |
Credit Work Phone Valid Values:0-9 Format:XXXXXX Example:5478968 Allowable Values: 20 |
MSRCreditMobilePhone string Optional |
Credit Mobile Phone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSRCreditEmail1 string Optional |
Credit Email 1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRAccountingFirstName string Optional |
Accounting First Name Allowable Values: 50 |
MSRAccountingLastName string Optional |
Accounting Last Name Allowable Values: 50 |
MSRAccountingWorkPhone string Optional |
Accounting Work Phone Valid Values:0-9 Format:XXXXXXXX Example:54789686 Allowable Values: 20 |
MSRAccountingMobilePhone string Optional |
Accounting Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRAccountingEmail1 string Optional |
Accounting Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRSalesFirstName string Optional |
Sales First Name Allowable Values: 50 |
MSRSalesLastName string Optional |
Sales Last Name Allowable Values: 50 |
MSRSalesWorkPhone string Optional |
Sales Work Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRSalesMobilePhone string Optional |
Sales Mobile Phone Valid Values:0-9 Format:XXXXXXXXX Example:547896865 Allowable Values: 20 |
MSRSalesEmail1 string Optional |
Sales Email1 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRSponserID string Optional |
Merchant Sponser ID Allowable Values: 200 |
MSRArrangementID string Optional |
Arrangement ID Allowable Values: 200 |
MSRAccountManagerFirstName string Optional |
Account Manager First Name Allowable Values: 50 |
MSRAccountManagerLastName string Optional |
Account Manager Last Name Allowable Values: 50 |
ParentMSRSalesFirstName string Optional |
Parent Merchant Sales First Name Allowable Values: 50 |
ParentMSRSalesLastName string Optional |
Parent Merchant Sales Last Name Allowable Values: 50 |
MSRExternalCustomerID string Optional |
External CustomerID Allowable Values: 200 |
MSRExternalID string Optional |
External MerchantID Allowable Values: 50 |
MSRPIN string Optional |
Merchant PIN Allowable Values: 200 |
MSREnrollmentDate datetime Optional |
Enrollment Date Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
MSRCreditLimitInd string Optional |
Credit Limit Indicator Allowable Values: 50 |
MSRCreditLimitMaxAmount decimal Optional |
Credit Limit Max Amount |
MSRDirectBatchInd string Optional |
Direct Batch Indicator Allowable Values: 50 |
MSRApplicationTypeOverride string Optional |
Application Type Override Allowable Values: 50 |
MSRFeeWaiver string Optional |
Fee Waiver Allowable Values: 10 |
MSRFeeDays string Optional |
Fee Days Allowable Values: 200 |
MSRBillingFrequency string Optional |
Billing Frequency Allowable Values: 50 |
MSRGSDInd string Optional |
Merchant GSD Indicator Allowable Values: 200 |
MSRExternalInd string Optional |
External Merchant Indicator Allowable Values: 200 |
MSRExtCompanyID string Optional |
External Company ID Allowable Values: 200 |
MSRConsumerDirectOptIn string Optional |
Consumer Direct Opt-In Allowable Values: 200 |
MSRMemail2 string Optional |
Merchant Email 2 Valid Values:A-Z,0-9 Format:abc@cc.com Example:user1@cc.com Allowable Values: 100 |
MSRContactPhone string Optional |
ContactPhone Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 Allowable Values: 20 |
MSRServiceAreaAddLine1 string Optional |
Service Area Address Line1 Allowable Values: 50 |
MSRServiceAreaAddLine2 string Optional |
Service Area Address Line2 Allowable Values: 50 |
MSRServiceAreaCity string Optional |
Service Area City Allowable Values: 40 |
MSRServiceAreaState string Optional |
Service Area State Allowable Values: 5 |
MSRServiceAreaZip string Optional |
Service Area Zip Allowable Values: 10 |
MSRServiceWebsite string Optional |
Service Website Allowable Values: 300 |
MSRServiceAreaRadius string Optional |
Service Area Radius Allowable Values: 15 |
MSRServiceLocationLongitude string Optional |
Service Location Longitude Allowable Values: 200 |
MSRServiceLocationLatitude string Optional |
Service Location Latitude Allowable Values: 200 |
MSRLogoID string Optional |
ProductID (Logo ID) of Merchant. Allowable Values: 200 |
MSRServiceLocationPoint string Optional |
Service Location Point Allowable Values: 200 |
MSRServiceLocationRadiusMiles string Optional |
Service Location Radius Miles Allowable Values: 15 |
MSRProgram string Optional |
Program (ProductName) Allowable Values: 100 |
MSRVersion string Optional |
Version Allowable Values: 25 |
MSRSettlementLevel integer Conditional |
Merchant Settlement Level. Only one merchant can have settlement level 'Yes' in any hierarchy tree. Possible Values:0 = No , 1 = Yes Condition:Required when MSRLevel = 0 |
MSRPolicyIdentifier string Conditional |
PolicyIdentifier, will result in digits only Ie. 1 or 2. Possible Value: 1=Grandfathered,2=Standard Condition:Required when MSRLevel = 0 Allowable Values: 1 |
MSRHighLinePolicy string Conditional |
HighLinePolicy, will result in digits only Ie. 0 or 1. Possible Values:0 = No , 1 = Yes Condition:Required when MSRLevel = 0 Allowable Values: 1 |
MSRLineAssignmentPolicy string Optional |
Line Assigned Policy of Merchant Possible Value: 1=Grandfathered,2=Standard |
MSRWebServicesPassword string Optional |
Merchant Web Services Password. Allowable Values: 120 |
MSRCreationDate datetime Optional |
Merchant Creation Date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
MSRSplitFee string Optional |
SplitFee for Merchant Settlement 1= YES “or seperate credit and debit amount†0 = NO/NULL â€for combine credit and debit amount†Allowable Values: 10 |
MSRTemplateID string Optional |
TemplateID of Merchant Offering Template. Example:MOT1001 Allowable Values: 100 |
InstitutionID integer Mandatory |
Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard. |
AddressLine1 string Mandatory |
MSR Address Line 1. Valid Values:A-Z,0-9 Example:123 HWY Allowable Values: 50 |
AddressLine2 string Optional |
MSR Address Line 2. Valid Values:A-Z,0-9 Example:Park Avenue Allowable Values: 50 |
City string Mandatory |
City Name of the MSR address Example:Los Angeles Allowable Values: 25 |
PostalCode string Mandatory |
Postal code of MSR address Valid Values:0-9 Format:XXXXXX Example:5478968 Allowable Values: 10 |
County string Optional |
County of MSR Valid Values:0-9 Format:XXXXX Example:54789 Allowable Values: 40 |
Country string Mandatory |
Country Name of the MSR address Example:USA Allowable Values: 5 |
CustomerID string Mandatory |
This Tag reflects the customer ID Allowable Values: 100 |
CompanyName string Mandatory |
Company Name Allowable Values: 50 |
FirstName string Mandatory |
Card holder's First name. Valid Values:A-Z Example:User Allowable Values: 50 |
LastName string Mandatory |
Card holder's Last name. Valid Values:A-Z Example:Smith Allowable Values: 50 |
Position string Optional |
Employement position of the card holder Valid Values:A-Z,0-9 Example:Manager |
BillingCycle string Mandatory |
Biiling cycle Valid Values:Monthly1 - Monthly28 Example:Monthly10 Allowable Values: 9 |
MerchantCategory string Optional |
Merchant Category Allowable Values: 200 |
ServiceDescription string Optional |
Service Description Allowable Values: 256 |
NetworkName string Optional |
Name of Network from which Merchant needed to be associated Allowable Values: 50 |
NetworkID int64 Optional |
NetworkID of Network from which Merchant needed to be associated Valid Values:0-9 Format:XXXXXXXXXXXX Example:547896865689 |
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, "MSRLevel": null, "MSRNumber": null, "ParentMSRNumber": null, "MSRName": null, "MerchantDescription": null, "ContactType": null, "MerchantState": null, "MSRNumber1": null, "MSRNumber2": null, "MSRNumber3": null, "MSRFaxNumber": null, "MSREmail1": null, "MSREmail2": null, "MSRLegalEntityName": null, "MSRDBAName": null, "MSRTaxIdentificationNumber": null, "MSRReserveTable": null, "MSRACHRoutingNumber": null, "MSRACHCheckingAccnum": null, "MSRACHAccName": null, "MSRTermOverrideInd": 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, "MSRExternalCustomerID": null, "MSRExternalID": null, "MSRPIN": null, "MSREnrollmentDate": 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, "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, "MSRWebServicesPassword": null, "MSRCreationDate": null, "MSRSplitFee": null, "MSRTemplateID": null, "InstitutionID": null, "AddressLine1": null, "AddressLine2": null, "City": null, "PostalCode": null, "County": null, "Country": null, "CustomerID": null, "CompanyName": null, "FirstName": null, "LastName": null, "Position": null, "BillingCycle": null, "MerchantCategory": null, "ServiceDescription": null, "NetworkName": null, "NetworkID": null }
Response fields detail
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 |
Sample response body
{ "application/json": { "Message": "Request processed successfully.", "Status": true, "ErrorCode": "ERR01155", "ResponseData": { "ResponseID": "65687878" } } }
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 detail
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 Default: en - English 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 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 Mandatory |
Unique identification number for Institution. Example:Fixed value needs to pass which is provided by Corecard. |
MSRLevel string Mandatory |
Type of Account to be created Valid Values: 0 = Merchant,1 = Store,2 = Register Example:1 Allowable Values: 1 |
MSRNumber string Mandatory |
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 detail
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
{ "application/json": { "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 } ] } } }
Get Template History
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetTemplateHistory
Use this API to list down the Merchant Template History and Merchant Template History Details for its version ID. Use the Template ID and value in Template History Indicator will fetch out the result. If the value in the indicator is provided as '0' then it will list out the template history and if the value is provided as '1' then it will list out CPM, MRT for that template version.
Request fields detail
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 Default: en - English 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 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 |
TemplateID string Mandatory |
Unique ID assigned to template when created Valid Values:0-9, A-Z Format:XXXX Example:MOT1001 Allowable Values: 100 |
TemplateVersionID string Conditional |
Template Version ID , if any changes made on template it changes Valid Values:0-9, A-Z Format:XXXX Example:Template V1 Conditinon: It is mandatory when Indicator = 1. Allowable Values: 100 |
TemplateHistoryIndicator integer Mandatory |
Tag to check what the result of API should display 0 - List of template history 1 - List of CPM,MRT for that template version Valid Values:0-1 Format:X Example:0,1 |
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, "TemplateID": "MOT1001", "TemplateVersionID": null, "TemplateHistoryIndicator": 0 }
Response fields detail
Fields | Description |
---|---|
MerchantTempalteHistory array |
Array of history of template version. |
MerchantTempalteHistoryDetails array |
Array of history of template version. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "MerchantTempalteHistory": [ { "TemplateHistoryUniqueKey": 1, "TemplateVersionID": "Template V 1", "LogDateTime": "04/30/2020 01:55:39", "UserID": "user123" } ], "MerchantTempalteHistoryDetails": null } } }
Get Merchant Statement
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantStatement
Use this API to obtain merchant statements by merchant IDs and statement dates.
Request fields detail
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 |
MerchantID integer Conditional |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549 |
MerchantStatementDate datetime Mandatory |
Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY Example: 05/01/2020 |
ProductName string Mandatory |
Reflects the name of product for the account Valid Values: a-z Format: xxxxxx Example: abcsolutionsrevolving Allowable Values: 50 |
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 Default: en - English 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 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 |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXXXXXXX Example: 205136549 |
MerchantNumber string Conditional |
Merchant Number which is assigned to a Merchant, Mandatory If Merchant ID not Inputted in API Request. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 9 |
MerchantStatementDate datetime Mandatory |
Date for which Merchant statement is generated Valid Values: 0-9 Format: MM/DD/YYYY Example: 05/01/2020 |
ProductID integer Mandatory |
ID assigned to a Program. Valid Values:0-9 Example:Fixed value provided by CoreCard. |
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": 11629, "MerchantNumber": null, "MerchantStatementDate": "03/31/2016 00:00:00", "ProductID": 3399 }
Response fields detail
Fields | Description |
---|---|
MerchantStatementAdjustmentList array |
Header of Merchant Statement Adjustment Group Which will contain all details Adjustements as a |
MerchantFeeBreakdownList array |
Header of Merchant Fee Breakdown Details |
GrandTotalList array |
Header of Grand Total List, contains the Grand Totals for Transaction Volume, Transaction Counts and Merchant Fee |
MerchantStatementHistoryList array |
Header of Merchant Statement History array Which will contain all details for Each Transaction occured for the Merchant in an array. |
MerchantStatementAdjustmentList array |
Header of Merchant Statement Adjustment Group Which will contain all details Adjustements as a |
MerchantFeeBreakdownList array |
Header of Merchant Fee Breakdown Details |
GrandTotalList array |
Header of Grand Total List, contains the Grand Totals for Transaction Volume, Transaction Counts and Merchant Fee |
MerchantStatementHistoryList array |
Header of Merchant Statement History array Which will contain all details for Each Transaction occured for the Merchant in an array. |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "ERR0000", "ResponseData": { "MerchantStatementAdjustmentList": [ { "MerchantName": "Andrisen Morton", "MerchantNumber": "35519", "MerchantStatementDate": "12/25/2015 00:00:00", "MerchantStatementFromDate": null, "MerchantStatementToDate": "12/25/2015 00:00:00", "ProductName": "ABC ECO", "GrossSalesCount": 48, "ReturnReversalsCount": 22, "GrossSalesAmount": 107665.37, "ReturnReversalsAmount": 84968.24, "MerchantFee": 538.32, "MerchantFeeReversal": 0.0, "NetAmountDue": 107127.05, "TotalAmountDue": 22158.81, "TotalAmountDueCount": 70 } ], "MerchantFeeBreakdownList": [ { "CreditPlanMaster": "Fixed APR of 3.99%-28.99% for 24 Months - 4.90", "TransactionCounts": 1, "MerchantRate": 4.9, "TransactionsVolume": 2000.0, "MerchantFee": -98.0 } ], "GrandTotalList": [ { "GrandTotalTransactionsVolume": 4054.0, "GrandTotalTransactionCounts": 4, "GrandTotalMerchantFee": -214.48 } ], "MerchantStatementHistoryList": [ { "PurchaseTranID": 1.2337203685480192E+17, "ReversalTranID": null, "Transactiontime": "01/15/2017 06:32:33", "TransactionPostTime": "01/15/2017 06:32:33", "TransactionAmount": 2000.0, "MerchantFee": -98.0, "CreditPlanMaster": "Fixed APR of 3.99%-28.99% for 24 Months - ", "CPMID": 6067, "TransactionDescription": "Purchase", "MerchantRate": 4.9, "NetSettlementAmount": 1902.0 } ] } } }
Get Merchant Network Control
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantNetworkControl
Use this API to get the current status of existing merchant account network access for the account created under the merchant. Status such as Open or Blocked can be identified through merchant ID or merchant number.
Request fields detail
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 |
MerchantId integer Mandatory |
Specific ID Assigned to a Merchant. Valid Values: 0-9 Format: XXXX Example: 562489 |
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 Default: en - English 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 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 |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request. Valid Values: 0-9 Format: XXXX Example: 562489 |
MerchantNumber string Conditional |
Merchant Number which is assigned to a Merchant, Mandatory If Merchant ID not Inputted in API Request. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 50 |
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": 25636, "MerchantNumber": null }
Response fields detail
Fields | Description |
---|---|
AccountsNetworkAccess integer |
Defines Network Access for Merchant Accounts is Open or Blocked 0-Open, 1-Blocked Valid Values: 0 or 1 Format: XXXX Example: 1 |
AccountsNetworkAccess integer |
Defines Network Access for Merchant Accounts is Open or Blocked 0-Open, 1-Blocked Valid Values: 0 or 1 Format: XXXX Example: 1 |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "AccountsNetworkAccess": 1 } } }
Merchant Status Update
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/MerchantStatusUpdate
Use this API to update the status of the merchant associated with an institution. Merchant status can be updated either from active to closed or to fraud or vice-versa. To update the merchant status merchant number and merchant status ID that needs to be updated should be provided in the input of the API.
Request fields detail
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 |
MerchantNumber string Mandatory |
Merchant Number which is assigned to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 11642 Allowable Values: 9 |
MerchantStatusID integer Mandatory |
Status id of merchant status that need to be updated. Valid Values: 1000 = Active, 1001 = Potential Fraud,1002 = Fraud, 1003 = Closed |
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 Default: en - English 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 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 |
MerchantNumber string Mandatory |
Merchant Number which is assigned to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 11642 Allowable Values: 9 |
MerchantStatusID integer Mandatory |
Status id of merchant status that need to be updated. Valid Values: 1000 = Active, 1001 = Potential Fraud,1002 = Fraud, 1003 = Closed |
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, "MerchantNumber": "11111111", "MerchantStatusID": 1 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "ERR0000", "ResponseData": {} } }
Get Update Velocity Check Threshold
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetUpdateVelocityCheckThreshold
The purpose of this API is to get or update the threshold value of velocity for a merchant. Merchant number and decision flag are the mandatory input to provide based on which system will decide if the existing threshold value should be returned or new value should be updated.
Request fields detail
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 |
MerchantNumber string Mandatory |
Merchant Number which is assigned to a Merchant. Valid Values- 0-9 Format:XXXXXX Example:11642 Allowable Values: 9 |
DecisionFlag integer Mandatory |
Decide if threshold need to get or update. Valid values: 0 = Get, 1=Update |
UpdatedThresholdValue integer Conditional |
Updated threshold value for application count. Valid Values: 0-9 Example: 3 Condition: This field is mandatory if Decision flag value will be '1' (Update) |
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 Default: en - English 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 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 |
MerchantNumber string Mandatory |
Merchant Number which is assigned to a Merchant. Valid Values- 0-9 Format:XXXXXX Example:11642 Allowable Values: 9 |
DecisionFlag integer Mandatory |
Decide if threshold need to get or update. Valid values: 0 = Get, 1=Update |
UpdatedThresholdValue integer Conditional |
Updated threshold value for application count. Valid Values: 0-9 Example: 3 Condition: This field is mandatory if Decision flag value will be '1' (Update) |
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, "MerchantNumber": "11111111", "DecisionFlag": 0, "UpdatedThresholdValue": null }
Response fields detail
Fields | Description |
---|---|
CurrentThresholdValue integer |
Description:Current threshold value for application count. Valid Values: 0-9 Example: 3 |
CurrentThresholdValue integer |
Description:Current threshold value for application count. Valid Values: 0-9 Example: 3 |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "CurrentThresholdValue": 3 } } }
Get Merchant Statement List
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantStatementList
Use this API to get the list of historical generated PDF statements for a merchant based on the monthly cycle range. To get the historical PDF statement user needs to provide merchant ID as input which will list out the merchant statement generated, unique identifier of the merchant statement, and the date of merchant statement.
Request fields detail
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 |
MerchantID integer Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXX Example: 562489 |
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 Default: en - English 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 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 Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXX Example: 562489 |
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": 11642 }
Response fields detail
Fields | Description |
---|---|
ListStatementHistory array |
Array of Historical Statements this Will contain statement year and below statement year array of statements details for the Statement Year. |
ListStatementHistory array |
Array of Historical Statements this Will contain statement year and below statement year array of statements details for the Statement Year. |
Sample response body
{ "application/json": { "Message": "Success.", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "ListStatementHistory": [ { "MerchantStatementYear": 2017, "ListStatement": [ { "FilePath": "?Path=output/6-1332/1341/Statements/2018-07-31/Normal/5000000000000033_2018-07-31_439554_4.pdf", "MerchantStatementDate": "01/13/2017 23:00:02" } ] } ] } } }
Insert Merchant Template
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/InsertMerchantTemplate
Use this API to add a new template to create a merchant entity under an institution. Merchant template is used to create a merchant entity by the user with minimum input as the template itself carries most of the pre-requisite mandatory values.
Request fields detail
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 Default: en - English 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 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 Mandatory |
Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard. |
ProductID integer Mandatory |
ID assigned to a Program Valid Values: 0-9 Format: XXXX Example: Fixed value provided by CoreCard. |
TemplateName string Mandatory |
The name we give while creating a template. Valid Values:0-9, A-Z Format:XXXX Example:testing. Allowable Values: 100 |
DefaultTemplate integer Mandatory |
Flag to check whether the tempate is default or not. Valid Values:0,1 Format: X Example: 0/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, "InstitutionID": 3235, "ProductID": 3399, "TemplateName": "Custom Merchant Template", "DefaultTemplate": 0 }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Merchant Offering Template Created Successfully.", "Status": true, "ErrorCode": "ERR04223", "ResponseData": null } }
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 detail
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 |
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 Default: en - English 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 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 |
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 detail
Fields | Description |
---|---|
Account
|
MerchantPLAccountModel |
Account
|
MerchantPLAccountModel |
Sample response body
{ "application/json": { "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 } } } }
Manage Merchant Offering
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/ManageMerchantOffering
The Purpose of this API is update the attributes of the Plan(s) offered to a Merchant.
Request fields detail
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 |
MerchantId integer Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXX Example: 562489 |
MerchantOfferingList array |
Details of Merchant Offering Plans available for the Merchant |
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 Default: en - English 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 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 Mandatory |
Specific ID Assigned to a Merchant, Mandatory If Merchant Number not Inputted in API Request Valid Values: 0-9 Format: XXXX Example: 562489 |
MerchantOfferingList array |
Details of Merchant Offering Plans available for the Merchant |
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": 11607, "MerchantOfferingList": [ { "MerchantOfferedPlanID": 1001, "CreditPlanMaster": null, "MerchantRateTable": null, "LowPurchaseAmount": null, "HighPurchaseAmount": null, "IsChecked": 1 } ] }
Response fields detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Merchant Offering Updated.", "Status": true, "ErrorCode": "ERR04219", "ResponseData": {} } }
Template Change
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/TemplateChange
This API is to initiate the template change request for a Merchant.
Request fields detail
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 Default: en - English 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 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 |
MerchantNumber string Mandatory |
Merchant Number which is assgined to a Merchant, Mandatory If MerchantID not Inputted in API Request Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 25 |
TemplateName string Mandatory |
The name we give while creating a template. Valid Values:0-9,A-Z Format:XXXX Example:testing. Allowable Values: 100 |
MessageId integer Optional |
Unique ID of Action which we are going to perform on API. Valid Values:0-9 Format:X Example:0,1 |
MessageFlag integer Mandatory |
Action which need to perform on template. flag 0 : RETURN CURRENT TEMPLATE NAME flag 1 : TEMPLATE CHANGE REQUEST Valid Values:0,1 Format:X Example:0,1 |
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, "MerchantNumber": "99663300", "TemplateName": null, "MessageId": null, "MessageFlag": 0 }
Response fields detail
Fields | Description |
---|---|
TemplateName string |
The name we give while creating a template. Valid Values:0-9,A-Z Format:XXXX Example:testing. Allowable Values: 200 |
TemplateList array |
List of templates which is associated to that merchant. Valid Values:0-9,A-Z Format:XXXX Example:testing,test123 |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "TemplateName": "GSHIGHLINE", "TemplateList": [ { "NewTemplateName": "GSHIGHLINE" } ] } } }
Get Merchant Non-monetary Activity Log
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantNonMonetaryActivityLog
Use this API to get the non-monetary activity log for a merchant.
Request fields detail
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 |
MerchantNumber string Conditional |
Merchant Number which is assigned to a Merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantAcctID is mandatory Allowable Values: 9 |
MerchantID string Conditional |
A unique id generated by corecard sytem for a merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantID is mandatory. Allowable Values: 10 |
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 Default: en - English 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 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 |
MerchantNumber string Conditional |
Merchant Number which is assigned to a Merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantAcctID is mandatory Allowable Values: 9 |
MerchantID string Conditional |
A unique id generated by corecard sytem for a merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Condition: MerchantNumber/MerchantID is mandatory. 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, "MerchantNumber": "92218", "MerchantID": null }
Response fields detail
Fields | Description |
---|---|
NonMonetaryActivities array |
Get or Set NonMonetaryActivities |
NonMonetaryActivities array |
Get or Set NonMonetaryActivities |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "NonMonetaryActivities": [ { "MerchantNumber": "92218", "UserID": "PortalSuperUser", "IPAddress": "10.150.0.223", "RequestDateTime": "05/03/2019 06:45:01", "RequestOutCome": "Success", "FieldAffected": "MPLStmtPrintSeq", "FieldOldValue": "0", "FieldNewValue": "0", "Source": "Web" } ] } } }
Get Template PDF Details
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetTemplatePDFDetails
Use this API to get the template details of a merchant in PDF format. PDF will have the details such as credit plan master associated with card account, merchant rate table, interest rate, and plan type such as EPP for ILP and deferred for a deferred plan.
Request fields detail
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 Default: en - English 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 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 |
TemplateID string Mandatory |
Description: Unique ID assigned to template when created Valid Values:0-9,A-Z Format:XXXX Example:MOT1001 Allowable Values: 50 |
TemplateName string Optional |
Description: The name we give while creating a template. Valid Values:0-9,A-Z Format:XXXX Example:testing. Allowable Values: 50 |
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, "TemplateID": "MOT1001", "TemplateName": null }
Response fields detail
Fields | Description |
---|---|
MerchantOffersList array |
MerchantOffersList |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "MerchantOffersList": [ { "IsChecked": 1, "CreditPlanMaster": "ABC_Regular_revolving", "MerchantRateTable": "5.00%", "InterestRate": "29.99%", "PlanType": "2" } ] } } }
Get Merchant Transaction Log
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantTransactionLog
Use this API to get the transaction log of a merchant. When merchant number is provided as the input of this API, it gets the logs containing CPM name, the discount per cent, discount fee, all the transaction type such as purchase, payment, transaction description and account holder's name in the response.
Request fields detail
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 Default: en - English 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 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 |
MerchantNumber string Mandatory |
Merchant Number which is assigned to a Merchant. Valid Values:0-9 Format: XXXXXXXXX Example: 205136549 Allowable Values: 50 |
StoreNumber string Optional |
Unique Number which is assgined to a Store. Valid Values:0-9 Example: 205136549 Allowable Values: 10 |
RegisterNumber string Optional |
Unique Number which is assigned to a register. Valid Values:0-9 Example: 205136549 Allowable Values: 30 |
FromDate datetime Optional |
Starting date of transaction search. Used as a criteria for Transaction Filter. Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: Default value should be 1 month before date from current date |
ToDate datetime Optional |
End date of transaction search. Used as a criteria for Transaction Filter Valid Values: 0-9 Format: MM/DD/YYYY Example: 02/01/2020 Condition: Default value should be 1 day before date from current date |
TransactionDateTime datetime Optional |
Date and Time transaction when occurred Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 12:10:01 |
TransactionID decimal Optional |
Description - Transaction Number for the transaction being posted. Valid Values:0-9 a-z Format:XXXXXXXXXXXXXXXX Example:23654789 |
PostDateTime datetime Optional |
This is the time when transaction actually got posted in system. Valid Values: valid date Format:MM/DD/YYYY HH:MM:SS Example: 01/01/2020 12:10:01 |
AccountNumber string Optional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
ApplicationNumber string Optional |
Unique Number generated for the Account creation Application . Valid Values:0-9 Example:8002201421 Allowable Values: 20 |
FirstName string Optional |
First name of account holder Valid Values:a-z Format:XXXX Example:John Allowable Values: 50 |
LastName string Optional |
Last name of account holder Valid Values:a-z Format:XXXX Example:Smith Allowable Values: 50 |
TransactionType string Optional |
Description -Type of Transaction (Purchase debit,payment reversal etc) Valid Values: 23 - DIRECTED PAYMENT 3 - INTEREST CREDIT 2 - INTEREST DEBIT 21 - NON-DIRECTED PAYMENT 28 - NON-DIRECTED PAYMENT REVERSAL 22 - PAYMENT REVERSAL 49 - PRINCIPAL CREDIT 48 - PRINCIPAL DEBIT 40 - PURCHASE DEBIT 43 - PURCHASE DEBIT REVERSAL 41 - PURCHASE RETURN 42 - PURCHASE RETURN REVERSAL 29 - REVERSAL OF NON-DIRECTED PAYMENT REVERSAL Format: XX Example: 41 Allowable Values: 25 |
CreditPlanMaster integer Optional |
Plan name associated with the card account. Valid Values:A-Z, 0-9 Format:XXXXXX Example:6 Months No Interest if Paid in Full |
Amount decimal Optional |
Amount for which transaction occurred Valid Values: 0-9 Format: $XX.XX Example: $20.00 |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch Default Value would be 50. Valid Values:0-9 Format:XX Example:20 |
PageIndex integer Optional |
Number of page Default value would be 0 Valid Values:0-9 Format:XX Example:12 |
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, "MerchantNumber": "33333333", "StoreNumber": null, "RegisterNumber": null, "FromDate": null, "ToDate": null, "TransactionDateTime": null, "TransactionID": null, "PostDateTime": null, "AccountNumber": null, "ApplicationNumber": null, "FirstName": null, "LastName": null, "TransactionType": null, "CreditPlanMaster": null, "Amount": null, "BatchSize": 1, "PageIndex": 1 }
Response fields detail
Fields | Description |
---|---|
TransactionRecords array |
Get or Set TransactionRecords |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "TransactionRecords": [ { "TransactionID": "123372036854802020", "MerchantName": "Merchant 3", "MerchantNumber": "33333333", "AccountNumber": "8000000000000136", "ApplicationNumber": "8002200246", "FirstName": "JOSEPH", "LastName": "GILSON", "StoreNumber": "Merchant_Store 3", "RegisterNumber": null, "TransactionType": "PURCHASE DEBIT", "Amount": 3000.0, "TransactionDateTime": "01/16/2017 01:48:57", "PostDateTime": "01/16/2017 01:48:57", "TransactionDescription": "3020 = DOMESTIC SALE (THIRD PARTY)", "TransactionCode": "3020 = DOMESTIC SALE (THIRD PARTY)", "CreditPlanMaster": "18 Months No Interest if Paid in Full", "Operator": "Gsadmin", "DiscountPercent": "10.00", "DiscountFee": "300.00", "ReverseFlag": "0", "ReturnFlag": "0", "PrintReceiptflag": "1", "CreditPlanDescription": "6 Months No Interest if Paid in Full", "TransactionStatus": "fail" } ] } } }
Manage Merchant Offering Template
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/ManageMerchantOfferingTemplate
This API is to edit the template with respect to Product and Institution.
Request fields detail
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 Default: en - English 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 |