Category links

API Links

Account Management

The CoreCard system provides various APIs to manage account-related activities. In a broader sense, you can perform account management activities in two ways:

Adding or Updating the existing account management parameters using CoreCard APIs, e. g., changing PAN number if it is compromised, adding manual status etc.

Getting the details of account management parameters using CoreCard APIs, e. g., getting details of account balances, account status, transaction history, load transaction history, other account-related attributes like card limit, etc. 

AddNotes

Action: POST

Endpoint: /api/AddNotes

POST /api/AddNotes

Use this API is to add notes to account or to add memo to transaction.

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

MemoType

string

Optional

Type of Note Example: 1 - Account Level 2 - Transaction Level 3 - Status 4 - Manual Transaction 5 - Card Replacement on Legitimate Address 6 - Card Replacement on Fraudulent Address

Allowable Values:

2

ClientId

string

Mandatory

Client Id Valid Values: 1422245 Format:XXXXX

Allowable Values:

20

Comment

string

Optional

Additional Comment can be specified for Logging. Valid values :A-Z, a-z

Allowable Values:

369

MemoReason

string

Optional

Flag for PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

5

MemoTransactionId

string

Optional

Transaction ID of Transaction for which memo needs to be added Example : 147852369

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "4797333",
  "MemoType": "0",
  "ClientId": "6317",
  "Comment": "Test",
  "MemoReason": "",
  "MemoTransactionId": ""
}
Response Fields Detail
Fields Description

Sample Response Body

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

AddPartnerID

Action: POST

Endpoint: /api/AddPartnerID

POST /api/AddPartnerID

Use this API to add or update the status of a partner ID.

Request Fields Detail
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

Unique identification number for Institution Valid Values:0-9 Format: XXXX

Action

Int32

Mandatory

Flag to identify call action as: 1 Add Partner ID 2 Update status of Partner ID

PartnerIDManage

array

Optional

PartnerIDManage

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 Detail
Fields Description

Sample Response Body

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

ChangeOverDraftStatus

Action: POST

Endpoint: /api/ChangeOverDraftStatus

POST /api/ChangeOverDraftStatus

Use this API to opt in or opt out overdraft facility.

Request Fields Detail
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

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 E.g:1005 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

OverDraftStatus

string

Mandatory

This tag will display the current status of Overdraft facility for the account. Valid Values : 1 = Opt In 2 = Opt-Out

Allowable Values:

1

OverDraftAmount

string

Mandatory

This flag will display the Amounrt of overdraft allowed for Account. Valid values : 0-999 Condition : This tag is mandatory when overdraft flag value is 1

Allowable Values:

3

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "",
  "CardNumber": "",
  "ProxyNumber": "1316728",
  "OverDraftStatus": "",
  "OverDraftAmount": ""
}
Response Fields Detail
Fields Description

Sample Response Body

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

GetCardBalanceDetails

Action: POST

Endpoint: /api/GetCardBalanceDetails

POST /api/GetCardBalanceDetails

Use this API to get the Balance details of Account which includes details like Available balance, current balance , Pending Auths, Last and next statement date, Derived and Card manual status.

Request Fields Detail
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

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition : At least one of Card Number/Proxy Number is required.

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition : At least one of Card Number/Proxy Number is required.

Allowable Values:

16

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1316728",
  "CardNumber": ""
}
Response Fields Detail
Fields Description

CardNumber

string

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001

Allowable Values:

16

AccountNumber

string

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893

Allowable Values:

19

AvailableBalance

decimal

Available balance on the account Valid values : 0-9 E.g.: 100.50

CurrentBalance

decimal

This tag indicates the current balance of the account

LastCreditAmount

decimal

Last Credited Amount in the card Valid Values: 0-9 Format: XXX.XX Example: 150.00

NextStatementDate

datetime

Next Statement Date Format: YYYY-MM-DDTHH:MM:SS Example: 2021-05-01T00:00:00

LastStatementDate

datetime

Last Statement Date Format: YYYY-MM-DDTHH:MM:SS Example: 2021-04-01T00:00:00

CurrentCardPendingAuths

string

It shows pending auth transaction on current Card. Example: 100.00

Allowable Values:

8

CustomAccountID

string

Any custom ID which is used to uniquely identify the Account. Valid values: A-Z, a-z, 0-9 Example:123456789

Allowable Values:

25

DerivedStatusDescription

string

Status which is derived by considering Card Status (manual and generated), account status (manual and generated) and Card plastic status Example: Active

Allowable Values:

100

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "CardNumber": "406685******0935",
    "AccountNumber": "60000000032471",
    "AvailableBalance": 12.0,
    "CurrentBalance": 12.0,
    "LastCreditAmount": 12.0,
    "NextStatementDate": "2020-12-22T00:00:00",
    "LastStatementDate": "2017-02-12T00:00:00",
    "CurrentCardPendingAuths": "0.10",
    "CustomAccountID": "",
    "DerivedStatusDescription": "Active"
  }
}

GetCardholderSpendLimits

Action: POST

Endpoint: /api/GetCardholderSpendLimits

POST /api/GetCardholderSpendLimits

Use this API to View the card level spend limits.

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "AccountNumber": "",
  "ProxyNumber": "1314932"
}
Response Fields Detail
Fields Description

ViewAccountSpendRuleResult

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "ViewAccountSpendRuleResult": {
      "InternationalUseAllowed": "0",
      "CashAccessAllowed": "1",
      "PINPurchaseAllowed": "",
      "OnlineTransactionsAllowed": "1",
      "POSTransactionsAllowed": "1",
      "BypassCardMonetaryLimit": "1",
      "BypassCardMonetaryPeriod": "",
      "BypassMerchantCategoryRestrictions": "1",
      "BypassMerchantCategoryPeriod": "",
      "CardSingleTransactionLimit": 5500.0,
      "CardDailySpendLimitCount": 100,
      "CardDailySpendLimitAmount": 5500.0,
      "CardWeeklySpendLimitCount": 120,
      "CardWeeklySpendLimitAmount": 5600.0,
      "CardMonthlySpendLimitCount": 130,
      "CardMonthlySpendLimitAmount": 5700.0,
      "CardNotPresentCardSingleTransactionLimit": 5500.0,
      "CardNotPresentCardDailySpendLimitCount": 10,
      "CardNotPresentCardDailySpendLimitAmount": 5500.0,
      "CardNotPresentCardWeeklySpendLimitCount": 12,
      "CardNotPresentCardWeeklySpendLimitAmount": 5500.0,
      "CardNotPresentCardMonthlySpendLimitCount": 11,
      "CardNotPresentCardMonthlySpendLimitAmount": 5600.0,
      "PINPOSCardSingleTransactionLimit": 100.0,
      "PINPOSCardDailySpendLimitCount": 1,
      "PINPOSCardDailySpendLimitAmount": 200.0,
      "PINPOSCardWeeklySpendLimitCount": 2,
      "PINPOSCardWeeklySpendLimitAmount": 400.0,
      "PINPOSCardMonthlySpendLimitCount": 5,
      "PINPOSCardMonthlySpendLimitAmount": 500.0,
      "SignaturePOSCardSingleTransactionLimit": 200.0,
      "SignaturePOSCardDailySpendLimitCount": 11,
      "SignaturePOSCardDailySpendLimitAmount": 200.0,
      "SignaturePOSCardWeeklySpendLimitCount": 12,
      "SignaturePOSCardWeeklySpendLimitAmount": 250.0,
      "SignaturePOSCardMonthlySpendLimitCount": 13,
      "SignaturePOSCardMonthlySpendLimitAmount": 350.0,
      "ContactlessCardSingleTransactionLimit": 200.0,
      "ContactlessCardDailySpendLimitCount": 11,
      "ContactlessCardDailySpendLimitAmount": 200.0,
      "ContactlessCardWeeklySpendLimitCount": 12,
      "ContactlessCardWeeklySpendLimitAmount": 250.0,
      "ContactlessCardMonthlySpendLimitCount": 13,
      "ContactlessCardMonthlySpendLimitAmount": 350.0,
      "RecurringTransactionAllowed": "0",
      "MerchantCategory": [
        {
          "MerchantCategoryCodePlan": "44",
          "MerchantCategoryCodePlanSelection": "0",
          "MCCDailyPlanLimitCount": 1,
          "MCCDailyPlanLimitAmount": 100.0,
          "MCCMonthlyPlanLimitCount": 2,
          "MCCMonthlyPlanLimitAmount": 200.0,
          "MCCWeeklyPlanLimitCount": 3,
          "MCCWeeklyPlanLimitAmount": 300.0,
          "MCCDescription": "Eating Places And Restaurants",
          "MCCPlanDescription": "Eating Places And Restaurants"
        }
      ],
      "ContactlessTransactionAllowed": "0",
      "CardNotPresentTransactionAllowed": "0"
    }
  }
}

GetLexNexResults

Action: POST

Endpoint: /api/GetLexNexResults

POST /api/GetLexNexResults

Use this API to fetch the result of Lexis Nexis inquiry for the account in context.

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1310574"
}
Response Fields Detail
Fields Description

LexNexList

array

CVICheckValue

string

score of Comprehensive Verification Index Example: 0,10,20

NASCheckValue

string

Name Address SSN (NAS) Check tag shows Reason Codes triggered on the card Example: 10 Input First name, Address, and SSN matched

InquiryDate

datetime

Lexis Nexis Inquiry Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

RenewInquiryEnability

string

Field to display whether manual inquiry button will be enabled or not on CM Screen. Valid Values: Disable and Enable Example: Enable

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "LexNexList": [
      {
        "RiskCodes": "25: Unable to verify address"
      }
    ],
    "CVICheckValue": "10",
    "NASCheckValue": "4",
    "InquiryDate": "2019-12-03T00:00:00",
    "RenewInquiryEnability": "Enable"
  }
}

GetListofPartneridMID

Action: POST

Endpoint: /api/GetListofPartneridMID

POST /api/GetListofPartneridMID

Use this API for getting list of Partner ID and list of MID present on an account/card number.

Request Fields Detail
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

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 E.g:1005 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000031747",
  "CardNumber": "",
  "ProxyNumber": ""
}
Response Fields Detail
Fields Description

PartnerIDManage

array

MerchantIDManage

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "PartnerIDManage": [
      {
        "PartnerID": "PIDB1001",
        "Status": "Active",
        "IncludeExcludeFlag": "Exclude"
      }
    ],
    "MerchantIDManage": [
      {
        "MerchantID": "MerchantIDA00011",
        "IncludeExcludeFlag": "Exclude"
      }
    ]
  }
}

GetMemoDetails

Action: POST

Endpoint: /api/GetMemoDetails

POST /api/GetMemoDetails

Use this API to view details of Notes captured on an Account.

Request Fields Detail
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

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

FromDate

string

Optional

Starting date of Memo search. Used as a criteria to get memo. Valid Values:0-9 Format : MMDDYYYY Example : 03102015

Allowable Values:

8

ToDate

string

Optional

End date of Memo search. Used as a criteria to get memo. Valid Values:0-9 Format : MMDDYYYY Example : 03112015

Allowable Values:

8

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000031747",
  "CardNumber": "",
  "ProxyNumber": "",
  "FromDate": "",
  "ToDate": ""
}
Response Fields Detail
Fields Description

VIEWCOMMENT

array

List of view comment detail.

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "VIEWCOMMENT": [
      {
        "NoteId": 1336319,
        "AccountNumber": "60000000031747",
        "CreationDate": "2020-01-01T00:00:00",
        "CreationTime": "13:27:40",
        "NoteText": "abcd",
        "UserID": "CCAdmin",
        "NoteReason": "Account Level",
        "NoteType": "Account Level",
        "Source": "CoreMoney",
        "LastUpdatedBy": "CCAdmin"
      }
    ]
  }
}

GetPartnerID

Action: POST

Endpoint: /api/GetPartnerID

POST /api/GetPartnerID

Use this API to get list of partner ID's associated with the institution.

Request Fields Detail
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

This tag indicates Institution ID of product. Example : 1230 etc.

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "InstitutionID": 1230
}
Response Fields Detail
Fields Description

PartnerIDManage

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "PartnerIDManage": [
      {
        "PartnerID": "8578541",
        "Status": "Active"
      }
    ]
  }
}

GetRestrictedCountries

Action: POST

Endpoint: /api/GetRestrictedCountries

POST /api/GetRestrictedCountries

Use this API to fetch the list of Restricted countries for performing scheme transaction.

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: Atleast one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values: 0-9 Example: 1005 Condition: At least one of Account Number/CardNumber/ProxyNumber is required

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "4066846120015507",
  "AccountNumber": "60000000041050",
  "ProxyNumber": "1318431"
}
Response Fields Detail
Fields Description

RestrictedCountryList

array

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "RestrictedCountryList": [
      {
        "Country": "ZW"
      }
    ]
  }
}

LexNexRenewInquiry

Action: POST

Endpoint: /api/LexNexRenewInquiry

POST /api/LexNexRenewInquiry

Use this API to Renew Lexis Nexis inquiry for the account in context.

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316728"
}
Response Fields Detail
Fields Description

InquiryDate

datetime

Lexis Nexis Inquiry Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "InquiryDate": "2019-12-03T00:00:00"
  }
}

PartnerIDMIDMapping

Action: POST

Endpoint: /api/PartnerIDMIDMapping

POST /api/PartnerIDMIDMapping

Use this API for mapping partner ID's with Merchant ID's.

Request Fields Detail
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

Unique identification number for Institution Valid Values:0-9 Format: XXXX

Action

Int32

Mandatory

This tag is used decide action. Valid values : 1 = Add Merchant ID 2 = Update Merchant ID Status

PartnerIDMIDMapping

array

Optional

PartnerIDMIDMapping

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,
  "PartnerIDMIDMapping": [
    {
      "PartnerID": "65434567",
      "MerchantID": "9852457",
      "Status": 2
    }
  ]
}
Response Fields Detail
Fields Description

Sample Response Body

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

PartnerIDorMerchantIDAccountMapping

Action: POST

Endpoint: /api/PartnerIDorMerchantIDAccountMapping

POST /api/PartnerIDorMerchantIDAccountMapping

Use this API for mapping Partner ID or Merchant ID with Account number.

Request Fields Detail
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

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 E.g:1005 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

PartnerID

string

Conditional

This tag indicates the Partner ID Condition: Either partner ID or Merchant ID is mandatory

Allowable Values:

250

MerchantID

string

Conditional

This tag indicates the Merchant ID Condition: Either partner ID or Merchant ID is mandatory

Allowable Values:

16

IncludeExcludeFlag

string

Conditional

This tag decides whether to include or exclude the partner ID or Merchant ID for POS Transactions for the account number/Card Number Valid Values : 1 = Include PartnerID / MerchantID for POS transactions. 2 = Exclude PartnerID / MerchantID for POS transaction Condition : If 1 is passed, then only the passed partner/merchant id will be allowed for POS transactions and remaining all partnerID/MerchantID will be restricted. If 2 is passed, then only the passed partnered/merchantid will be restricted for POS transactions and remaining all partnerID/MerchantID will be allowed. Either IncludeExcludeFlag or RemovePartnerIDorMerchantID flag is required mandatorily

Allowable Values:

1

RemovePartnerIDorMerchantID

string

Conditional

This tag is used to remove the partner ID / Merchant ID Valid values: 1 = Remove PartnerID / MerchantID Condition : Either IncludeExcludeFlag or RemovePartnerIDorMerchantID flag is required mandatorily

Allowable Values:

1

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "60000000031747",
  "CardNumber": "",
  "ProxyNumber": "",
  "PartnerID": "PIDA001",
  "MerchantID": "",
  "IncludeExcludeFlag": "1",
  "RemovePartnerIDorMerchantID": ""
}
Response Fields Detail
Fields Description

AccountNumber

string

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893

PartnerID

string

This tag indicates the Partner ID

MerchantID

string

This tag indicates the Merchant ID

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "AccountNumber": "60000000031747",
    "PartnerID": "PIDA001",
    "MerchantID": ""
  }
}

ProductTransfer

Action: POST

Endpoint: /api/ProductTransfer

POST /api/ProductTransfer

Use this API to transfer account to other product.

Request Fields Detail
Fields Description

APIVersion

string

Version of the API to be invoked Example: 1.3

Allowable Values:

10

IPAddress

string

IP Address of sender Example: 10.206.0.204

Allowable Values:

15

Source

string

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

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

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

Reserved for future use

Allowable Values:

50

ANI

string

Reserved for future use

Allowable Values:

0

DNS

string

Reserved for future use

Allowable Values:

0

Language

string

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

Allowable Values:

2

RequestDate

string

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

Allowable Values:

19

CardNumber

string

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition : At least one of Account Number/Proxy Number/Card Number is required.

Allowable Values:

16

AccountNumber

string

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Account Number/Proxy Number/Card Number is required.

Allowable Values:

19

ProxyNumber

string

Proxy Number of the cardholder Valid values: 0-9 Example: 1005 Condition: At least one of Account Number/Proxy Number/Card Number is required.

Allowable Values:

19

DestinationProductID

Int32

Product ID of destination product Example : 1598

Allowable Values:

10

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "AccountNumber": "60000000086840",
  "ProxyNumber": "1376425",
  "DestinationProductID": 1739
}
Response Fields Detail
Fields Description

Sample Response Body

{
  "Message": "Request Accepted",
  "Status": true,
  "ErrorCode": "70334",
  "ResponseData": {}
}

ResetAccountGeneratedStatus

Action: POST

Endpoint: /api/ResetAccountGeneratedStatus

POST /api/ResetAccountGeneratedStatus

Use this API to set the Generated status of account to its previous status.

Request Fields Detail
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

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number/Account Number is required.

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "AccountNumber": "",
  "CardNumber": "",
  "ProxyNumber": "1310574"
}
Response Fields Detail
Fields Description

AccountGeneratedStatus

string

Generated Status of account Example :Active

Sample Response Body

{
  "Message": "Account Generated Status reset successfully.",
  "Status": true,
  "ErrorCode": "70105",
  "ResponseData": {
    "AccountGeneratedStatus": "Active"
  }
}

UpdateAccountStatus

Action: POST

Endpoint: /api/UpdateAccountStatus

POST /api/UpdateAccountStatus

Use this API to update Account manual status.

Request Fields Detail
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

ProxyNumber

string

Mandatory

Proxy Number of the cardholder Valid values:0-9 Example:1005

Allowable Values:

19

AccountManualStatus

string

Mandatory

Account Manual Status code Example - 10 Please refer Appendix Card/Account Status Code Values

Allowable Values:

4

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1321236",
  "AccountManualStatus": "2"
}
Response Fields Detail
Fields Description

AccountNumber

string

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893

Sample Response Body

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

UpdateMemoDetails

Action: POST

Endpoint: /api/UpdateMemoDetails

POST /api/UpdateMemoDetails

Use this API to update or delete existing memo on account.

Request Fields Detail
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

CardNumber

string

Conditional

This tag indicates the Card Number of the cardholder Valid values:0-9 Clear Card Number. Example: *********4567[For Compliance masked BIN and Extended BIN]. Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

16

AccountNumber

string

Conditional

This tag indicates the Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

NoteId

Int32

Mandatory

It is a Unique ID of Notes Ex-1332199

ProxyNumber

string

Conditional

This tag indicates the Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Account Number/CardNumber/ProxyNumber is required.

Allowable Values:

19

NoteText

string

Conditional

Description of Activity Performed on Account. Condition: 1. NoteText is Mandatory if DecisionFlag = 1 2. If DecisionFlag = 2, then NoteText value should be 'MEMO'

Allowable Values:

2000

NoteReason

string

Conditional

Description : This tag indicates PreDefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

5

DecisionFlag

string

Mandatory

Description: Indicator for Updating or Deleting Memo. Below are the Possible Values 1 = Update 2 = Delete

Allowable Values:

2

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "AccountNumber": "60000000032596",
  "NoteId": 1336351,
  "ProxyNumber": "",
  "NoteText": "ABCD",
  "NoteReason": "10",
  "DecisionFlag": "1"
}
Response Fields Detail
Fields Description

Sample Response Body

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

UpdateSpendLimits

Action: POST

Endpoint: /api/UpdateSpendLimits

POST /api/UpdateSpendLimits

Use this API to update card level spend limits

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001

Allowable Values:

16

AccountNumber

string

Conditional

Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893

Allowable Values:

19

ProxyNumber

string

Conditional

The Proxy Number from where a transaction shall be initiated Valid values: 0-9 Example: 1001741741741

Allowable Values:

19

InternationalUseAllowed

string

Optional

This tag decides whether the card is allowed access for International Use or not. Valid values : 0 = Yes, 1 = No Example: 0 , International usage allowed.

Allowable Values:

1

CashAccessAllowed

string

Optional

Cash access Transaction allowed or not. Valid values : 0 = No, 1 = Yes Example: 1

Allowable Values:

1

PINPurchaseAllowed

string

Optional

Whether purchase of materials only after the PIN is entered. Valid values : 0 = No, 1 = Yes Example: 1

Allowable Values:

1

OnlineTransactionsAllowed

string

Optional

Whether Online Transactions are allowed for the Card. Valid values : 0 = No, 1 = Yes Example: 1

Allowable Values:

1

POSTransactionsAllowed

string

Optional

Whether Posting of Transactions are allowed. Valid values : 0 = No, 1 = Yes Example: 1

Allowable Values:

1

BypassCardMonetaryLimit

string

Optional

To Identify the time limit to byepass the monetary limit available for the card currently. Valid Values 0 = Yes, 1 = No Example: 1

Allowable Values:

1

BypassCardMonetaryPeriod

string

Optional

This tags defined the timeframe till which spend limits check should not impose on card. Valid Values: 0 = For next Transaction 1 = For next Day 2 = For One Month 3 = Forever

Allowable Values:

1

BypassMerchantCategoryRestrictions

string

Optional

This tag decides whether Merchant Category Restrictions can be bypassed or not. Valid values: 0 = No, 1 = Yes Example: 1

Allowable Values:

1

BypassMerchantCategoryPeriod

string

Optional

To decide the time period for Merchant Category Restrictions bypasseing. Valid Values: 0 = For next Transaction 1 = For next Day 2 = For One Month 3 = Forever

Allowable Values:

1

CardSingleTransactionLimit

decimal

Optional

If BypassMerchantCategoryRestrictions is 1(Yes), then this field is mandatory. Possible Values:0 = For next Transaction 1 = For next Day 2 = For One Month 3 = Forever

CardDailySpendLimitCount

Int32

Optional

Number of times card can be allowed to be used on a day Valid values:0-9 Example: 5

CardDailySpendLimitAmount

decimal

Optional

Daily Allowed amount limit for card use. Valid Values: 0-9 CardMonthlySpendLimitCountExample: 120

CardMonthlySpendLimitCount

Int32

Optional

Number of times card can be allowed to be used in a month Valid values:0-9 Example: 5

CardMonthlySpendLimitAmount

decimal

Optional

Monthly Allowed amount limit for card use. Valid Values: 0-9 Example: 120

CardWeeklySpendLimitCount

Int32

Optional

Number of times card can be allowed to be used on a Week Valid values:0-9 Example: 5

CardWeeklySpendLimitAmount

decimal

Optional

Weekly Allowed amount limit for card use. Valid Values: 0-9 Example: 120

MerchantCategory

array

Optional

RecurringTransactionAllowed

string

Optional

Recurring Transactions allowed or not. Valid values: 0 = No, 1 = Yes Example: 1

Allowable Values:

1

ReasonDescription

string

Optional

Predefined Memo Reasons. Please refer appendix Section : Memo Reason

Allowable Values:

50

NotesText

string

Optional

Notes entered by the user Valid Values : A-Z,0-9 Example : Limits updated

Allowable Values:

396

RestrictedCounty

string

Optional

Countries Example : |IN|US|AU|IO|

CardNotPresentCardSingleTransactionLimit

decimal

Optional

Single Transaction Limit for card not present transaction Example: 120

CardNotPresentCardDailySpendLimitCount

Int32

Optional

Daily allowed transaction count for card not present transaction Example: 5

CardNotPresentCardDailySpendLimitAmount

decimal

Optional

Daily allowed transaction amount for card not present transaction Example: 150

CardNotPresentCardWeeklySpendLimitCount

Int32

Optional

Weekly allowed transaction count for card not present transaction Example: 5

CardNotPresentCardWeeklySpendLimitAmount

decimal

Optional

Weekly allowed transaction amount for card not present transaction Example: 150

CardNotPresentCardMonthlySpendLimitCount

Int32

Optional

Monthly allowed transaction count for card not present transaction Example: 5

CardNotPresentCardMonthlySpendLimitAmount

decimal

Optional

Monthly allowed transaction amount for card not present transaction Example: 150

PINPOSCardSingleTransactionLimit

decimal

Optional

Single Transaction Limit for Pin POS transaction Example: 120

PINPOSCardDailySpendLimitCount

Int32

Optional

Daily allowed transaction count for Pin POS transaction Example: 5

PINPOSCardDailySpendLimitAmount

decimal

Optional

Daily allowed transaction amount for Pin POS transaction Example: 150

PINPOSCardWeeklySpendLimitCount

Int32

Optional

Weekly allowed transaction count for Pin POS transaction Example: 5

PINPOSCardWeeklySpendLimitAmount

decimal

Optional

Weekly allowed transaction amount for Pin POS transaction Example: 150

PINPOSCardMonthlySpendLimitCount

Int32

Optional

Monthly allowed transaction count for Pin POS transaction Example: 5

PINPOSCardMonthlySpendLimitAmount

decimal

Optional

Monthly allowed transaction amount for Pin POS transaction Example: 150

SignaturePOSCardSingleTransactionLimit

decimal

Optional

Single Transaction Limit for Signature POS transaction Example: 120

SignaturePOSCardDailySpendLimitCount

Int32

Optional

Daily allowed transaction count for Signature POS transaction Example: 5

SignaturePOSCardDailySpendLimitAmount

decimal

Optional

Daily allowed transaction amount for Signature POS transaction Example: 150

SignaturePOSCardWeeklySpendLimitCount

Int32

Optional

Weekly allowed transaction count for Signature POS transaction Example: 5

SignaturePOSCardWeeklySpendLimitAmount

decimal

Optional

Weekly allowed transaction amount for Signature POS transaction Example: 150

SignaturePOSCardMonthlySpendLimitCount

Int32

Optional

Monthly allowed transaction count for Signature POS transaction Example: 5

SignaturePOSCardMonthlySpendLimitAmount

decimal

Optional

Monthly allowed transaction amount for Signature POS transaction Example: 150

ContactlessCardSingleTransactionLimit

decimal

Optional

Single Transaction Limit for contactless transaction Example: 120

ContactlessCardDailySpendLimitCount

Int32

Optional

Daily allowed transaction count for contactless transaction Example: 5

ContactlessCardDailySpendLimitAmount

decimal

Optional

Daily allowed transaction amount for contactless transaction Example: 150

ContactlessCardWeeklySpendLimitCount

Int32

Optional

Weekly allowed transaction count for contactless transaction Example: 5

ContactlessCardWeeklySpendLimitAmount

decimal

Optional

Weekly allowed transaction amount for contactless transaction Example: 150

ContactlessCardMonthlySpendLimitCount

Int32

Optional

Monthly allowed transaction count for contactless transaction Example: 5

ContactlessCardMonthlySpendLimitAmount

decimal

Optional

Monthly allowed transaction amount for contactless transaction Example: 150

ContactlessTransactionAllowed

string

Optional

Contactless Transaction allowed or not. Valid values: 0 = No, 1 = Yes Example: 1

Allowable Values:

1

CardNotPresentTransactionAllowed

string

Optional

Card not present Transaction allowed or not. Valid values: 0 = No, 1 = Yes Example: 1

Allowable Values:

1

Sample Request Body
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "AccountNumber": "",
  "ProxyNumber": "1314932",
  "InternationalUseAllowed": "0",
  "CashAccessAllowed": "1",
  "PINPurchaseAllowed": "0",
  "OnlineTransactionsAllowed": "1",
  "POSTransactionsAllowed": "1",
  "BypassCardMonetaryLimit": "1",
  "BypassCardMonetaryPeriod": "0",
  "BypassMerchantCategoryRestrictions": "0",
  "BypassMerchantCategoryPeriod": "0",
  "CardSingleTransactionLimit": 5500.0,
  "CardDailySpendLimitCount": 100,
  "CardDailySpendLimitAmount": 5500.0,
  "CardMonthlySpendLimitCount": 130,
  "CardMonthlySpendLimitAmount": 5700.0,
  "CardWeeklySpendLimitCount": 120,
  "CardWeeklySpendLimitAmount": 5600.0,
  "MerchantCategory": [
    {
      "MerchantCategoryCodePlan": "44",
      "MerchantCategoryCodePlanSelection": "0",
      "MCCDailyPlanLimitCount": 1,
      "MCCDailyPlanLimitAmount": 10.0,
      "MCCMonthlyPlanLimitCount": 3,
      "MCCMonthlyPlanLimitAmount": 30.0,
      "MCCWeeklyPlanLimitCount": 2,
      "MCCWeeklyPlanLimitAmount": 20.0,
      "MCCDescription": "5",
      "MCCPlanDescription": "Eating Places And Restaurants"
    }
  ],
  "RecurringTransactionAllowed": "0",
  "ReasonDescription": "",
  "NotesText": "",
  "RestrictedCounty": "|US|IN|AU|IO|",
  "CardNotPresentCardSingleTransactionLimit": 5500.0,
  "CardNotPresentCardDailySpendLimitCount": 10,
  "CardNotPresentCardDailySpendLimitAmount": 5500.0,
  "CardNotPresentCardWeeklySpendLimitCount": 11,
  "CardNotPresentCardWeeklySpendLimitAmount": 5600.0,
  "CardNotPresentCardMonthlySpendLimitCount": 12,
  "CardNotPresentCardMonthlySpendLimitAmount": 5600.0,
  "PINPOSCardSingleTransactionLimit": 100.0,
  "PINPOSCardDailySpendLimitCount": 1,
  "PINPOSCardDailySpendLimitAmount": 200.0,
  "PINPOSCardWeeklySpendLimitCount": 2,
  "PINPOSCardWeeklySpendLimitAmount": 400.0,
  "PINPOSCardMonthlySpendLimitCount": 5,
  "PINPOSCardMonthlySpendLimitAmount": 500.0,
  "SignaturePOSCardSingleTransactionLimit": 200.0,
  "SignaturePOSCardDailySpendLimitCount": 11,
  "SignaturePOSCardDailySpendLimitAmount": 200.0,
  "SignaturePOSCardWeeklySpendLimitCount": 12,
  "SignaturePOSCardWeeklySpendLimitAmount": 250.0,
  "SignaturePOSCardMonthlySpendLimitCount": 13,
  "SignaturePOSCardMonthlySpendLimitAmount": 350.0,
  "ContactlessCardSingleTransactionLimit": 200.0,
  "ContactlessCardDailySpendLimitCount": 11,
  "ContactlessCardDailySpendLimitAmount": 200.0,
  "ContactlessCardWeeklySpendLimitCount": 12,
  "ContactlessCardWeeklySpendLimitAmount": 250.0,
  "ContactlessCardMonthlySpendLimitCount": 13,
  "ContactlessCardMonthlySpendLimitAmount": 350.0,
  "ContactlessTransactionAllowed": "0",
  "CardNotPresentTransactionAllowed": "1"
}
Response Fields Detail
Fields Description

Sample Response Body

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

ViewDDA

Action: POST

Endpoint: /api/ViewDDA

POST /api/ViewDDA

Use this API to get DDA number stored against the card account.

Request Fields Detail
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

CardNumber

string

Conditional

Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

16

ProxyNumber

string

Conditional

Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition: At least one of Card Number/Proxy Number is required.

Allowable Values:

19

Sample Request Body
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316728"
}
Response Fields Detail
Fields Description

DDANumber

string

DDA (Direct Deposit Account) which can be used in ACH transactions. Valid values : 0-9 Example:1234567890

Allowable Values:

19

RoutingNumber

string

Bank Routing Number Valid Values:0-9 Example:0110000015

Allowable Values:

10

FirstName

string

Cardholder First Name Valid Values: A-Z, a-z Example: Andrew

LastName

string

Cardholder Last Name Valid values:A-Z, a-z Example: Hudson

City

string

Cardholder's City of residence Valid values: A-Z, a-z, 0-9 Example: Norcross

ZipCode

string

Cardholder Postal Code of Residence Valid Values:A-Z,a-z,0-9 Example: 30093

Country

string

Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values

NameofInstitution

string

Name of Financial Institution Valid Values:A-Z,a-z Example:FEDERAL RESERVE BANK

AddressLine1

string

Address Line 1 of the Cardholder Valid values are A-Z, a-z, 0-9 Example: 15 Penang Street Point

AddressLine2

string

Address Line 2 of the Cardholder Valid values: A-Z, a-z, 0-9 Example: 1 mecca way

Sample Response Body

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "DDANumber": "846953659",
    "RoutingNumber": "1316728",
    "FirstName": "mark",
    "LastName": "smith",
    "City": "Houston",
    "ZipCode": "45645",
    "Country": "US",
    "NameofInstitution": "xyz",
    "AddressLine1": "gateway",
    "AddressLine2": ""
  }
}