Category links

API Links

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 details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

InstitutionID

integer

Mandatory

Unique identification number for Institution Valid Values: 0-9 Format: XXXX Example: Fixed value needs to pass which is provided by Corecard.

ProductID

string

Mandatory

ID assigned to a Program Valid Values:0-9(with comma seprated) Format: XXXX Example: Fixed value provided by CoreCard. Tag modified by: Jaihind | Merchant offering template

Allowable Values:

100

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 details
Fields Description

Sample response body

{
  "Message": "Merchant Offering Template Created Successfully.",
  "Status": true,
  "ErrorCode": "ERR04223",
  "ResponseData": null
}