Network
You can maintain multiple merchant networks within the CoreCard system and move a merchant from one merchant network to another as per business terms. A merchant establishment can be assigned to a merchant network during onboarding to the CoreCard system, or it may be updated later to be part of a merchant network.
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 } } }
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 } } }