Category links

API Links

Manage Memo

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/ManageMemo

Use this API to either delete or update an existing memo present on the card account based on the decision flag.

Request fields details
Fields Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Mandatory

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

MemoUniqueID

string

Mandatory

A unique ID for the added memo. Format: A-Z, 0-9 Example: 2345

Allowable Values:

25

DecisionFlag

integer

Mandatory

Flag to decide if memo need to be delete or edit. Valid Values: 1 is to update memo 2 is to delete memo

MemoReason

integer

Optional

ID of added Memo Reason. Valid Values: Its value will be pulled by GetMemoReason API. Example: Account related notes. Condition: 'MemoReason' is required only when 'Decision Flag' value would be '1' (Update memo)

MemoPriority

integer

Optional

It defines if the note is urgent. If priority is set as 'YES' then it will show on top of Memo list. Its default value would be '0'(NO). Valid Values: 0 = No and 1 = Yes Condition: 'MemoPriority' is required only when 'Decision Flag' value would be '1' (Update memo).

MemoText

string

Optional

Text of the Memo. Valid Values: 0-9,a-z,special characters Example: New Transaction posted. Condition: 'MemoText' is required only when 'Decision Flag' value would be '1' (Update memo)

Allowable Values:

1800

Sample request body
{
  "Source": "WEB",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "MemoUniqueID": "50211",
  "DecisionFlag": 1,
  "MemoReason": 12,
  "MemoPriority": 0,
  "MemoText": "This is text memo"
}
Response fields details
Fields Description

Sample response body

{
  "Message": "Memo updated successfully.",
  "Status": true,
  "ErrorCode": "ERR01628",
  "ResponseData": null
}