Category links

API Links

AddNotes

Action: POST

Endpoint: /api/AddNotes

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

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

ExpcatValueOne

string

Optional

Expense Category Value 1 The expense category value1.

Allowable Values:

8

ExpcatValueTwo

string

Optional

Expense Category Value 2

Allowable Values:

8

ExpcatValueThree

string

Optional

Expense Category Value 3.

Allowable Values:

8

FirstName

string

Optional

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

Allowable Values:

50

LastName

string

Optional

Cardholder Last Name Field is Unicode supported

Allowable Values:

50

InstantCard

string

Optional

Card Number of the instant card

Allowable Values:

16

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 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": {}
}