Category links

API Links

Beneficiary Management

The CoreCard system provides various APIs to manage the transfer of funds from card to card and card to bank recipients. In card-to-card transfer, the funds are transferred between the internal accounts (accounts present in the CoreCard system). In a card to a bank transfer, the funds are transferred to an external account (account outside of the CoreCard system). Using these APIs, new beneficiaries can be added, deleted, existing beneficiary details can be searched, and updated as needed. 

AddNewRecipient

Action: POST

Endpoint: /api/AddNewRecipient

POST /api/AddNewRecipient

Use this API to add or Update a recipient for card to card 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

RecipientCardNumber

string

Conditional

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

Allowable Values:

16

RecipientProxyNumber

string

Conditional

Proxy Number of recipient card. Valid values are 0-9 Example: 1005 Condition: At least one of Recipient Card Number/Recipient Proxy Number is required.

Allowable Values:

19

RecipientName

string

Mandatory

First Name of Recipient. Valid Values:A-Z,a-z. Example: Andrick

Allowable Values:

50

RecipientNickName

string

Optional

Nick Name of Recipient. Valid Values:A-Z,a-z Example: Sem

Allowable Values:

50

RecipientPhoneNumber

string

Optional

Registered Phone Number of Recipient. Valid values: 0-9 Example:9632581470

Allowable Values:

19

RecipientEmailAddress

string

Optional

Registered E Mail Address of Recipient. Valid Values: A-Z,a-z,0-9 Example: mailto:sem_pp @gmail.com

Allowable Values:

100

DecisionFlag

string

Mandatory

Action to be performed on the basis of value selected. Valid values: 1 : Add Recipient 2 : Update Recipient Example: 1

Allowable Values:

2
Sample Request Body 
{
  "APIVersion": "1.4",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "CardNumber": "",
  "ProxyNumber": "1316605",
  "RecipientCardNumber": "",
  "RecipientProxyNumber": "1316610",
  "RecipientName": "Harshal",
  "RecipientNickName": "Harsh",
  "RecipientPhoneNumber": "",
  "RecipientEmailAddress": "",
  "DecisionFlag": "1"
}
Response Fields Detail
Fields Description

RecipientID

string

UniqueID of Recipient. Valid Values:0-9 Example:1234567890

Allowable Values:

10

Sample Response Body 

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

ManageRecipient

Action: POST

Endpoint: /api/ManageRecipient

POST /api/ManageRecipient

Use this API to either Retrieve list of Recipient or delete specific Recipient based on decision flag.

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

RecipientProxyNumber

string

Conditional

Proxy Number of recipient card. Valid values are 0-9 Example: 1005 Condition: At least one of Recipient Card Number/Recipient Proxy Number is required when DecisionFlag = 2 or 3

Allowable Values:

19

RecipientCardNumber

string

Conditional

Clear Card Number of Recipient. Valid values are 0-9 Example: 123456******0001 Condition: At least one of Recipient Card Number/Recipient Proxy Number is required when DecisionFlag = 2 or 3

Allowable Values:

16

DecisionFlag

string

Mandatory

DecisionFlag Valid values are 1 = Display Recipient 2 = Send Recipient CardNumber to transfer 3 = Delete Recipient Example : 1

Allowable Values:

2
Sample Request Body 
{
  "APIVersion": "1.3",
  "IPAddress": "10.206.2.197",
  "Source": "WEB",
  "CallerID": "",
  "CalledID": "",
  "SessionID": "",
  "ANI": "",
  "DNS": "",
  "Language": "en",
  "RequestDate": "",
  "ProxyNumber": "1316605",
  "CardNumber": "",
  "RecipientProxyNumber": "1316610",
  "RecipientCardNumber": "",
  "DecisionFlag": "1"
}
Response Fields Detail
Fields Description

RecipientDetail

array

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "RecipientDetail": [
      {
        "RecipientProxyNumber": "1316610",
        "RecipientCardNumber": "",
        "RecipientNickName": "Harsh",
        "RecipientId": "3668",
        "RecipientName": "Harshal"
      }
    ]
  }
}

SearchRecipient

Action: POST

Endpoint: /api/SearchRecipient

POST /api/SearchRecipient

Use this API to get list of Recipients or specific Recipient of Card to bank based on decision flag.

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

RecipientId

Int64

Conditional

UniqueID of Recipient. Valid Values:0-9 Example:1234567890 Condition:This tag is Mandatory when DecisionFlag = 2

DecisionFlag

string

Mandatory

Used for performing various operations when respective flag values defined below are passed. valid values : 1 = To get lists of Recipients. 2 = To get specific Recipient on the basis of Recipient ID.

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": "",
  "ProxyNumber": "1316605",
  "RecipientId": 3668,
  "DecisionFlag": "1"
}
Response Fields Detail
Fields Description

RecipientInfo

array

This property is used to Get OR Set RecipientInfo

Sample Response Body 

{
  "Message": "Successful.",
  "Status": true,
  "ErrorCode": "00000",
  "ResponseData": {
    "RecipientInfo": [
      {
        "RecipientID": 3668,
        "RecipientName": "Harshal",
        "FinancialInstitutionName": "",
        "BankAccountNumber": "",
        "RoutingNumber": "1316624",
        "DecisionFlag": "1",
        "AccountType": "",
        "ValidationTriesCount": "",
        "RecipientDeletedOn": "2017-02-21T00:00:00",
        "BankAccountStatus": "Active",
        "RecipientNickName": "Harsh",
        "FundAvailableDate": "2020-12-01T00:00:00"
      }
    ]
  }
}