Category links

API Links

Token

Token

Token

Action: POST

Endpoint: /api/Token

POST /api/Token

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

Request Fields Detail
Fields Description

UserID

string

Optional

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

Allowable Values:

40

Password

string

Optional

This tag reflects User Password used for login purpose.

Allowable Values:

32

GrantType

string

Optional

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

Allowable Values:

32

RefreshToken

string

Optional

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

APIVersion

string

Mandatory

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

Mandatory

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

Mandatory

Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB.

Allowable Values:

50

CallerID

string

Optional

Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR

Allowable Values:

20

CalledID

string

Optional

Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR

Allowable Values:

20

SessionID

string

Optional

Reserved for future use

Allowable Values:

50

ANI

string

Optional

Reserved for future use

Allowable Values:

0

DNS

string

Optional

Reserved for future use

Allowable Values:

0

Language

string

Optional

Flag to retrieve error message in specific language Example: 'en' for English

Allowable Values:

2

RequestDate

string

Optional

Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10

Allowable Values:

19

Sample Request Body
{
  "UserID": "TestUser",
  "Password": "XXXXXXXXXX",
  "GrantType": "AccessToken",
  "RefreshToken": "",
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": ""
}
Response Fields Detail
Fields Description

access_token

string

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

token_type

string

Type of token.

expires_in

string

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

refresh_token

string

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

issued

string

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

expires

string

userName

string

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

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "access_token": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
    "token_type": "bearer",
    "expires_in": "53999",
    "refresh_token": "XXXXXXXXXXXXXXXXXXXXXXXXXX",
    "userName": "TestUser"
  }
}