Category links

API Links

Get Card Activation Parameters

Action: POST

Endpoint: /api/CoreCredit/UserManagement/GetCardActivationParameters

Use this API to retrieve the card activation validation parameters defined on the program for an institution within CoreCARD's system. Further, these parameter values can be used to validate and activate a card.

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 Example:Fixed value needs to pass which is provided by Corecard.

ProductID

integer

Optional

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

CardNumber

string

Conditional

Card Number of account holder. Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236 Condition: At least one of CardNumber/AdminNumber is required.

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Format:XXXXXXXX Example:7488888 Condition: At least one of CardNumber/AdminNumber is required.

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": null,
  "ProductID": null,
  "CardNumber": null,
  "AdminNumber": 100989
}
Response fields details
Fields Description

Validation1

string

Validation 1 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation2

string

Validation 2 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation3

string

Validation 3 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation4

string

Validation 4 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation5

string

Validation 5 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Validation6

string

Validation 6 for Card Activation. Example: Phone Number Condition: As per configuration

Allowable Values:

2

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "Validation1": "7",
    "Validation2": "11",
    "Validation3": "0",
    "Validation4": "0",
    "Validation5": "0",
    "Validation6": "0"
  }
}