Category links

API Links

Merchant Offering

Merchant offering is the credit plan or interest rate that a merchant may apply to a purchase falling within the range of maximum and minimum transaction amounts. A merchant can be marked with various merchant offerings and you can receive details of such offerings from the CoreCard system using API. The customer may select a specific merchant offering during a purchase.

Get Plan And Payment By Amount

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/GetPlanAndPaymentByAmount

POST /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."
  }
}

Get Merchant Offering

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantOffering

POST /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

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

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
        }
      ]
    }
  }
}

Manage Merchant Offering

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/ManageMerchantOffering

POST /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

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

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": {}
  }
}

Manage Merchant Offering Template

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/ManageMerchantOfferingTemplate

POST /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

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

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

IsDefaultTemplate

integer

Mandatory

Flag to check whether the tempate is default or not. Valid Values:0,1 Format:X Example:Y/N

MessageFlag

integer

Mandatory

Flag to what action has to perform on the template,0 or 1 for Create or Update Valid Values:0-1 Format:X Example:0,1

ProductID

string

Mandatory

Product ID Valid Values:0-9 Format:XXXX Example:1234 Tag modified by: Jaihind | Merchant offering template

Allowable Values:

100

MerchantOfferingList

array

Conditional

MerchantOfferingList

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": "MOT1002",
  "IsDefaultTemplate": 0,
  "MessageFlag": 1,
  "ProductID": "3425",
  "MerchantOfferingList": [
    {
      "CreditPlanMaster": 0,
      "MerchantRateTable": 0,
      "LowPurchaseAmount": 0.0,
      "HighPurchaseAmount": 0.0,
      "IsChecked": 0
    }
  ]
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Merchant Offering Template Updated Successfully.",
    "Status": true,
    "ErrorCode": "ERR04218",
    "ResponseData": {}
  }
}

Get Merchant Offering Template

Action: POST

Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantOfferingTemplate

POST /api/CoreCredit/MerchantManagement/GetMerchantOfferingTemplate

Use this API to get the template details of a merchant in PDF Format. To get the merchant offering list, institution ID and template ID are the mandatory fields to provide as input to the API.  Response will return the details such as credit plan master associated with card account, merchant rate table, account ID etc.

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

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

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

string

Mandatory

ID assigned to a Program Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard.

Allowable Values:

100

TemplateID

string

Mandatory

Unique ID assigned to template when created Valid Values:0-9, A-Z Format:XXXX Example:MOT1001

Allowable Values:

50

TemplateName

string

Optional

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": null,
  "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,
  "ProductID": "3425",
  "TemplateID": "MOT1002",
  "TemplateName": ""
}
Response fields detail
Fields Description

MerchantOfferingList

array

MerchantOfferingList

Sample response body

{
  "application/json": {
    "Message": "Success.",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "MerchantOfferingList": [
        {
          "AccountID": 1015,
          "CreditPlanMaster": 6155,
          "MerchantRateTable": 952,
          "LowPurchaseAmount": 2000.0,
          "HighPurchaseAmount": 65000.0,
          "IsChecked": 1,
          "TemplateID": "MOT1002",
          "DefaultTemplate": 0,
          "TemplateVersionID": "Template V 15"
        }
      ]
    }
  }
}