Activity Log
Various activities may be performed for a card account, such as transaction and payment processing and posting, non-monetary activity logs or notes, and balance transfer histories, for a specific day, period, or cycle.
Get Memo Reason
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetMemoReason
Use this API to retrieve the list of memo reasons for any memo reason type.
Request fields detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 |
MemoReasonType integer |
It describes type of reason for which we need Memo. Valid Values: 1 = Account Level 2 = Transaction Level 3 = Status 4 = Manual Transaction 5 = Merchant Level |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "MemoReasonType": 1 }
Response fields detail
Fields | Description |
---|---|
MemoReasonList array |
Array of Memo reason |
Sample response body
{ "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "MemoReasonList": [ { "MemoReasonID": 1001, "MemoReasonDescription": "Account level Note" } ] } } }
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 detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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: 800 |
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 detail
Fields | Description |
---|
Sample response body
{ "application/json": { "Message": "Memo updated successfully.", "Status": true, "ErrorCode": "ERR01628", "ResponseData": null } }
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 detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 |
Description- 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: 800 |
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 detail
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
{ "application/json": { "Message": "Memo has been added successfully.", "Status": true, "ErrorCode": "ERR01027", "ResponseData": { "MemoUniqueID": "50198", "MemoCreationDateTime": "12/13/2016 23:03:15" } } }
Get Memo History
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetMemoHistory
Use this API to get the memo or list of memos on the account. Bases on decision flag account, merchant or transaction level memo can be retrieved.
Request fields detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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. Example: 1 |
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXXXX Example:123654789654 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 obtain by admin number (Embossing Acct-id) Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 1236547896325874 Condition: 1. At least one of AdminNumber/AccountNumber is required when 'Decision Flag' tag would be '1'(Account level Memo) |
MerchantNumber string 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:1236544 Condition: 'TransactionID' is mandatory when 'Decision Flag' value would be '3' (Transaction Level memo). |
MemoUniqueID integer Optional |
A unique ID for the added memo. Valid Values: 0-9 Example:1236544 |
MemoCreationDateFrom datetime Optional |
Starting date of Memo search. Used as a criteria to get memo. Format: MM/DD/YYYY Example: 01/01/2020 |
MemoCreationDateTo datetime Optional |
End date of Memo search. Used as a criteria to get memo. Format: MM/DD/YYYY Example: 01/01/2020 |
UserID string Optional |
User ID of user who created the memo. Valid Values : 0-9,A-Z Example:User123 Allowable Values: 50 |
MemoReason string Optional |
ID of added Memo Reason. Valid Values : Its value will be pulled by GetMemoReason API Example:1001 Allowable Values: 50 |
BatchSize integer Optional |
Number of records which can be view in one Batch. Valid Values : 0-9 Example:50 Condition: Default value is 50 |
PageIndex integer Optional |
Number of page. Valid Values : 0-9 Example:1 Condition: Default value is 1 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "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": null, "AdminNumber": 164785, "MerchantNumber": null, "TransactionID": null, "MemoUniqueID": null, "MemoCreationDateFrom": null, "MemoCreationDateTo": null, "UserID": null, "MemoReason": null, "BatchSize": 50, "PageIndex": 1 }
Response fields detail
Fields | Description |
---|---|
TotalRecordCount integer |
Total number of records in an Array. Valid Values: 0-9 Example:150 |
MemoList array |
Array of Memo list. |
Sample response body
{ "application/json": { "Message": "Request Accepted: Comments are found.", "Status": true, "ErrorCode": "ERR01521", "ResponseData": { "TotalRecordCount": 10, "MemoList": [ { "MemoUniqueID": 50170, "MemoReason": 10, "MemoText": "abc", "UserID": "user1", "MemoSource": "Web", "MemoCreationDateTime": null, "MemoPriority": 0 } ] } } }
Get Memo Reason Category
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetMemoReasonCategory
This API to search the reason category.
Request fields detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 |
ReasonType integer Conditional |
It describes type of reason for which we need Memo. Valid Values : 0-9 Example : 1 = Account Level 2 = Transaction Level 3 = Status 4 = Manual Transaction 5 = Merchant Level |
ReasonDescription string Conditional |
Description of reason for which we need Memo. Valid Values : :0-9,A-Z Example :ccount level Note,Transaction Level Note,Manual Transaction Note Allowable Values: 100 |
ReasonStatus string Optional |
Status of the reason. Valid Values: 0-9 Example: 2 = Active, 5 = Close |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "ReasonType": 1, "ReasonDescription": null, "ReasonStatus": null }
Response fields detail
Fields | Description |
---|---|
SearchReasonCategory array |
SearchReasonCategory |
Sample response body
{ "application/json": { "Message": "Memo reason category retrieved successfully.", "Status": true, "ErrorCode": "ERR01028", "ResponseData": { "SearchReasonCategory": [ { "UniqueID": 1478296, "ReasonType": "Account Level", "ReasonStatus": "Active", "ReasonDescription": "Account Label Notes" } ] } } }
Get Non-monetary Activity
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetNonMonetaryActivity
Use this API to retrieve the log of non-monetary activities performed on a card account. The API fetches details such as a description of the change, activity date and time, user ID, and the source from which the activity was performed.
Request fields detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 |
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition:At least one Account identifier input parameter should be passed |
BatchSize integer Optional |
Number of records which can be view in one Batch. Valid Values:0-9 Format:XX Example:20 Condition: If no value is pass in this tag then it will take by default value as 50. |
PageIndex integer Optional |
Number of page Valid Values:0-9 Format:XX Example:10 Condition: If no value is pass in this tag then it will take by default as 0. |
Sample request body
[ { "in": "header", "name": "Authorization", "description": "access token", "required": true, "type": "string", "default": "Bearer " }, { "in": "body", "name": "body", "description": "GetNonMonetaryActivityRequestModel RequestModel.", "schema": { "$ref": "#/definitions/GetNonMonetaryActivityRequestModel" } } ]
Response fields detail
Fields | Description |
---|
Sample response body
{ "200": { "description": "Success", "schema": { "$ref": "#/definitions/GetNonMonetaryActivityResponseModelApiResult" }, "examples": { "application/json": { "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "NonMonetaryActivities": [ { "ActivityDateTime": null, "UserID": "portalsuperuser", "Source": "Web", "Details": "svcAccountCreationBC", "RequestOutCome": "Successful", "AdminNumber": 167483, "ResponseMessage": "Account Created Successfully" } ] } } } }, "Err00016": { "description": "System could not process your request at this time. Please try again." }, "Err00017": { "description": "Success." }, "Err00018": { "description": "Record Not Found." }, "Err100001": { "description": "AccountID can not be blank." }, "Err100024": { "description": "Please enter valid number." }, "ERR03043": { "description": "Invalid Account identifier input parameter(s)." } }