Category links

API Links

Token

Action: POST

Endpoint: /api/CoreCredit/Token/Token

Use this API to either generate access token or refresh token to access CoreCard APIs.

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

UserID

string

Optional

This Tage reflects User ID provided by CoreCARD to login in CoreCard System.

Allowable Values:

128

Password

string

Optional

This Tage reflects User Password used for login purpose.

Allowable Values:

32

GrantType

string

Mandatory

This Tage reflects Grant Type. Grant Type values are 'AccessToekn','RefreshToken' default value should be AccessToken.

Allowable Values:

20

RefreshToken

string

Optional

This Tage reflects Refresh Token. It is used to re generate Access Token when the GrantType value is RefreshToken.

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,
  "UserID": "TestUser",
  "Password": null,
  "GrantType": "AccessToken",
  "RefreshToken": null
}
Response fields details
Fields Description

Token

string

This tag reflects Access Token which is used to access CoreCard API's.

RefreshToken

string

This tag reflects Refresh Token. It is used to re generate Access Token when the GrantType value is RefreshToken.

IssuedAt

datetime

This tag reflects the IssuedAt. It is the time when token provided to access CoreCard API.

Expires

datetime

This tag reflects the Expires. It is the time when provided Access Token has been expired.

RefreshTokenExpires

datetime

This tag reflects the Expires. It is the time when provided Refresh Token has been expired.

AdditionalUserLoginResponseModel

AdditionalUserLoginResponseModel

Sample response body 

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "Token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "RefreshToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "IssuedAt": "03/31/2016 00:00:00",
    "Expires": "03/31/2016 00:00:00",
    "RefreshTokenExpires": "03/31/2016 00:00:00",
    "AdditionalUserLoginResponseModel": null
  }
}
POST /api/CoreCredit/Token/Token