Category links

API Links

AddPartnerID

Action: POST

Endpoint: /api/AddPartnerID

API Version 1.3

Request fields details
Fields Description

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

InstitutionID

Int32

Mandatory

Institution ID of product. Valid Values:0-9 Example : 1230

Action

Int32

Mandatory

Flag to To decide add or update action Valid values : 1 = Add Partner ID 2 = Update Partner ID Status Example : 2

PartnerIDManage

array

Optional

PartnerIDManage

PartnerID

string

Mandatory

Partner ID to be created. Multiple PartnerIDs can be requested for creation or status change Valid Values :A-Z, a-z, 0-9 Example : 1589 , PIDA001

Allowable Values:

250

Status

Int32

Conditional

Status of the partner ID Valid values : 1 - Active(default) 2 - Inactive Example: Active Condition : Mandatory when Action =2 and parsed when Action =1.

Sample request body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "InstitutionID": 1234,
  "Action": 2,
  "PartnerIDManage": [
    {
      "PartnerID": "12345",
      "Status": 2
    }
  ]
}
Response fields details
Fields Description

Message

string

Returns Error Message in case of Error.

Status

boolean

Returns result of API processing. If any error is found then value will be 'false' else 'true'.

ErrorCode

string

Returns Error Code in case of Error.

ResponseData

This is group of below data elements.

Sample response body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {}
}