Add New Memo
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/AddNewMemo
Use this API to add an account, merchant or transaction level memo for a specific card account based on 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 |
DecisionFlag integer Mandatory |
Decide if Memo is account level,transaction level or merchant level. Valid Values: '1' is for Account level memo '2' is for Merchant level memo. '3' is for Transaction level. |
AccountNumber string Conditional |
Account number of cardholder. Valid Values: 0-9 Example: 7314145404 Condition: 1 At least one of AdminNumber/AccountNumber is required when Decision Flag tag would be 1 - Account level Memo. 2 Client who support duplicate Account number, they need to provide Merchant number as well. Allowable Values: 19 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format: XXXXX Example: 12345 Condition: 1 At least one of AdminNumber/AccountNumber is required when Decision Flag tag would be 1 -Account level Memo. |
MerchantNumber integer Conditional |
Merchant Number which is assigned to a Merchant. Valid Values:0-9 Example: 205136549 Condition: 'MerchantNumber' is mandatory when 'Decision Flag' value would be '2' (Merchant Level memo) |
TransactionID int64 Conditional |
Transaction Number for transaction being posted. Valid Values:0-9 Example:23654789 Condition: 'TransactionID' is mandatory when 'Decision Flag' value would be '3' (Transaction Level memo) |
MemoReasonID integer Optional |
ID of added Memo Reason. Valid Values: Its value will be pulled by GetMemoReason API Example: Account related notes. Allowable Values: 50 |
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 |
MemoText string Mandatory |
Text of the Memo. Valid Values: 0-9,a-z,special characters Example: New Transaction posted. 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, "DecisionFlag": 1, "AccountNumber": "8000000000000250", "AdminNumber": null, "MerchantNumber": null, "TransactionID": null, "MemoReasonID": null, "MemoPriority": 1, "MemoText": "New Transaction posted." }
Response fields details
Fields | Description |
---|---|
MemoUniqueID string |
A unique ID for the added memo. Format: XXXXXXX Example: 2345 Allowable Values: 50 |
MemoCreationDateTime datetime |
Date and Time of Memo creation Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 10:05:05 |
Sample response body
{ "Message": "Note has been added successfully.", "Status": true, "ErrorCode": "ERR01027", "ResponseData": { "MemoUniqueID": "50198", "MemoCreationDateTime": "12/13/2016 23:03:15" } }