Category links

API Links

GetMemoDetails

Action: POST

Endpoint: /api/GetMemoDetails

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

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

To set search boundary "From Date". Format : MMDDYYYY Example : 03102015

Allowable Values:

8

ToDate

string

Optional

To set search boundary "To Date" Format: MMDDYYYY Valid Values:0-9 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 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.

VIEWCOMMENT

array

List of view comment detail.

NoteId

Int32

Unique ID of Notes Valid Values:0-9 Example1:1346660

AccountNumber

string

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

Allowable Values:

19

CreationDate

datetime

Note Creation Date Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

CreationTime

string

Note Creation Time Format: hh:mm:ss Example:00:00:00

Allowable Values:

8

NoteText

string

Notes entered by the user Valid Values : A-Z,0-9 Example : Card found

Allowable Values:

50

UserID

string

UserId of Logged in user who created Memo. Example:CardOne

Allowable Values:

40

NoteReason

string

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

Allowable Values:

5

NoteType

string

Type of Note Valid values : Account Level Transaction Level Status Manual Transaction Card Replacement on Legitimate Address Card Replacement on Fraudulent Address Example: Account Level

Allowable Values:

2

Source

string

Source Valid Values: a-z,A-Z Example: ccadmin

Allowable Values:

20

UpdateDateTime

datetime

Last Update DateTime. Format: yyyy-mm-ddThh:mm:ss Example:2017-09-26T00:00:00

LastUpdatedBy

string

Id of User who last updated Notes. Valid values : a-z, 0-9 Example : headofficer

Allowable Values:

50

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"
      }
    ]
  }
}