Add Transaction to Case

HTTP Link

http:// <Application URL>/rest-api/ECMService/CaseManagementService/addTransaction

Service Type

The service type is POST.

Request Parameters

The following table describes the details of the parameters.

Table 4-29 Request Parameter Details

First Level	Second Level	Details
caseId	-	This accepts the case internal identifier.
transactions	transactionReferenceId	This accepts the transaction internal identifier.
transactions	businessAdd	This identifies whether transaction addition needs to be done from business or not. Y states transaction needs to be added from business. N states transaction needs to be manually added.
transactions	transactionTypeCode	This accepts the transaction type code value. B stands for back office transaction, C stands for cash transaction, M sands for monetary instrument, W stands for funds transfer.
transactions	accountId	This accepts the transaction account identifier. This attribute is only applicable for back office and cash transaction.
transactions	offsetAccountId	This accepts the transaction offset account identifier. This attribute is only applicable for back office transaction.
transactions	securityId	This accepts the transaction security identifier. This attribute is only applicable for back office transaction.
transactions	quantity	This accepts the quantity of the transaction. This attribute is only applicable for back office transaction.
transactions	transactionDateTime	This accepts the transaction date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. This attribute is applicable for back office, cash, and fund transfer transactions.
transactions	debitOrCreditCode	This accepts the Debit/Credit code value for the transaction. This attribute is only applicable for back office and cash transaction.
transactions	baseAmount	This accepts the transaction base amount value.
transactions	transactionType1	This accepts the transaction type1 value.
transactions	transactionType2	This accepts the transaction type2 value.
transactions	transactionType3	This accepts the transaction type3 value.
transactions	transactionType4	This accepts the transaction type4 value.
transactions	description	This accepts the description of the back office transaction.
transactions	accountRisk	This accepts the transaction account risk value. This attribute is only applicable for back office and cash transaction.
transactions	offsetAccountRisk	This accepts the transaction offset account risk value. This attribute is only applicable for back office transaction.
transactions	overallRisk	This accepts the transaction overall risk value. This attribute is only applicable for back office transaction.
transactions	locationId	This accepts the transaction location identifier. This attribute is only applicable for cash transaction.
transactions	locationName	This accepts the transaction location name. This attribute is only applicable for cash transaction.
transactions	issueDateTime	This accepts the transaction issue date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. This attribute is only applicable for monetary instrument transaction.
transactions	depositDateTime	This accepts the transaction deposit date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. This attribute is only applicable for monetary instrument transaction.
transactions	clearingDateTime	This accepts the transaction clearing date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. This attribute is only applicable for monetary instrument transaction.
transactions	postDateTime	This accepts the transaction post date time. This needs to be specified in ISO format YYYY-MM-DD HH24:MM:SS. This attribute is only applicable for monetary instrument transaction.
transactions	thirdPartyFlag	This accepts the transaction third party flag value. Y states that it is a third party transaction. This attribute is only applicable for monetary instrument and fund transfer transaction.
transactions	serialCheckNo	This accepts serial check number of monetary instrument transaction.
transactions	remitterName	This accepts the transaction remitter name. This attribute is only applicable for monetary instrument transaction.
transactions	remitterAccountId	This accepts the transaction remitter account identifier. This attribute is only applicable for monetary instrument transaction.
transactions	beneficiaryName	This accepts the transaction beneficiary name. This attribute is only applicable for monetary instrument and fund transfer transaction.
transactions	beneficiaryAccountId	This accepts the transaction beneficiary account identifier. This attribute is only applicable for monetary instrument and fund transfer transaction.
transactions	bodescription midescription wiredescription cashdescription	Displays description entered for each of the of transaction types - Back Office, Monetary Instrument, Wire, Cash.
transactions	issuingFIId	This accepts the transaction issuing financial institution identifier. This attribute is only applicable for monetary instrument transaction.
transactions	instrument	This accepts the name of the specific instrument used in this transaction. This attribute is only applicable for monetary instrument transaction.
transactions	clearingFI	This accepts the transaction clearing financial institution name. This attribute is only applicable for monetary instrument transaction.
transactions	clearingFIId	This accepts the transaction clearing financial institution identifier. This attribute is only applicable for monetary instrument transaction.
transactions	depositingFI	This accepts the transaction depositing financial institution name. This attribute is only applicable for monetary instrument transaction.
transactions	depositingFIId	This accepts the transaction depositing financial institution identifier. This attribute is only applicable for monetary instrument transaction.
transactions	remitterRisk	This accepts the transaction remitter risk value.This attribute is only applicable for monetary instrument transaction.
transactions	beneficiaryRisk	This accepts the transaction beneficiary risk value. This attribute is only applicable for monetary instrument and fund transfer transactions.
transactions	originatorName	This accepts the transaction originator name. This attribute is only applicable for fund transfer transaction.
transactions	originatorAccountId	This accepts the transaction originator account identifier. This attribute is only applicable for fund transfer transaction.
transactions	sendFI	This accepts the transaction send financial institution name. This attribute is only applicable for fund transfer transaction.
transactions	sendFIId	This accepts the transaction send financial institution identifier. This attribute is only applicable for fund transfer transaction.
transactions	receivingFI	This accepts the transaction receiving financial institution name. This attribute is only applicable for fund transfer transaction.
transactions	receivingFIId	This accepts the transaction receiving financial institution identifier.This attribute is only applicable for fund transfer transaction.
transactions	originatorRisk	This accepts the transaction originator risk value. This attribute is only applicable for fund transfer transaction.
transactions	genericInformation	This accepts generic information about the transaction.

Request JSON Sample

This section contains a request JSON sample to add transactions to an existing case. It will accept multiple caseids and transactions information to be added to the case. The entries in this sample are only for reference purposes.

[
{
"caseId": "CA101",
"transactions": [
{
"transactionReferenceId": "TX4",
"businessAdd": "N",
"transactionTypeCode": "C",
"transactionDateTime": "1990-12-01 10:30:00",
"transactionType1": "ABC",
"transactionType2": "XYZ",
"transactionType3": "TRY",
"transactionType4": "CET",
"debitOrCreditCode": "D",
"baseAmount": 1000000,
"accountId": "A123",
"accountRisk": 1,
"locationId": "B123",
"locationName": "XYZ123"
},
{
"transactionReferenceId": "TX3",
"transactionTypeCode": "C",
"businessAdd": "Y"
}
]
}
]

Sample JSON for Adding Transaction Description for Manually Added Transactions

Thie following are the sample JOSNs for adding Transaction Description to the manually added transactions:

Note:

The Comments attribute has been renamed as MI Description for Monetary Transactions.

Sample JSON (MI):

[
{
"caseId": "CA386",
"transactions": [
{
"transactionReferenceId": "MITRXNID",
"businessAdd": "N",
"transactionTypeCode": "M",
"issueDateTime": "2022-08-23 00:00:00",
"depositDateTime": "2022-08-24 00:00:00",
"clearingDateTime": "2022-08-26 00:00:00",
"thirdPartyFlag": "Y",
"postDateTime": "2022-08-25 00:00:00",
"transactionType1": "ABC",
"transactionType2": "XYZ",
"transactionType3": "TRY",
"transactionType4": "CET",
"serialCheckNo": "CHECK",
"baseAmount": 500,
"remitterName": "remiB123",
"remitterAccountId": "remit IdXYZ123",
"beneficiaryName": " BENISILUVAMMAI PROPERTY MAINTENANCE",
"beneficiaryAccountId": "BENI IDACTRUSTEDPAIR-025X",
"midescription": "This is manual add-Wire Transaction",
"issuingFIId": "issueABNAMR",
"instrument": "instABN AMRO NYC",
"clearingFI": "clear ST BK",
"clearingFIId": "Clearing FI identifier",
"depositingFI": "deposite BRYANT ST BK",
"depositingFIId": "deposit ID BRYANT",
"remitterRisk": 8,
"beneficiaryRisk": 9,
"genericInformation": {
"Customer Details": {
"Victim Name": "Rahul Dravid",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234"
},
"Enterprise Customer Complaint": {
"Was a complaint filed?": "No"
},
"Incident Details": {
"Incident Type": "Fraudulent Transaction",
"Account Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
},

Sample JSON (BO):

[
{
"caseId": "CA386",
"transactions": [
{
"transactionReferenceId": "BOTRXNID",
"businessAdd": "N",
"transactionTypeCode": "B",
"transactionDateTime": "1990-12-01 10:30:00",
"accountId": "A123",
"offsetAccountId": "B123",
"securityId": "XYZ123",
"quantity": 10,
"debitOrCreditCode": "D",
"baseAmount": 1000000,
"transactionType1": "ABC",
"transactionType2": "XYZ",
"transactionType3": "TRY",
"transactionType4": "CET",
"bodescription": "This is manual add-BO Transaction",
"accountRisk": 1,
"offsetAccountRisk": 2,
"overallRisk": 3,
"genericInformation": {
"Customer Details": {
"Victim Name": "Rahul Dravid",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234"
},
"Enterprise Customer Complaint": {
"Was a complaint filed?": "No"
},
"Incident Details": {
"Incident Type": "Fraudulent Transaction",
"Account Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
}
]
}
]

Sample JSON (Cash):

[
{
"caseId": "CA386",
"transactions": [
{
"transactionReferenceId": "FOTRXNESCLTAC0001",
"businessAdd": "N",
"transactionTypeCode": "C",
"transactionDateTime": "1990-12-01 10:30:00",
"transactionType1": "ABC",
"transactionType2": "XYZ",
"transactionType3": "TRY",
"transactionType4": "CET",
"cashdescription": "This is manual add-Cash Transaction",
"debitOrCreditCode": "D",
"baseAmount": 1000000,
"accountId": "A123",
"accountRisk": 1,
"locationId": "B123",
"locationName": "XYZ123"
}
]
}
]

Sample JSON (Wire):

[
{
"caseId": "CA386",
"transactions": [
{
"transactionReferenceId": "FTTRXNID",
"businessAdd": "N",
"transactionTypeCode": "W",
"transactionDateTime": "2022-08-25 00:00:00",
"transactionType1": "EFT-FEDWIRE",
"transactionType2": "XYZ",
"transactionType3": "TRY",
"transactionType4": "CET",
"wiredescription": "This is manual add-Wire Transaction",
"baseAmount": 500,
"thirdPartyFlag": "Y",
"originatorName": "B123",
"originatorAccountId": "XYZ123",
"beneficiaryName": "SILUVAMMAI PROPERTY MAINTENANCE",
"beneficiaryAccountId": "ACTRUSTEDPAIR-025X",
"sendFI": "CHASE MANHATTAN BANK",
"sendFIId": "SNC50",
"receivingFI": "BRYANT ST BK",
"receivingFIId": "BRYANT",
"originatorRisk": 8,
"beneficiaryRisk": 9,
"genericInformation": {
"Customer Details": {
"Victim Name": "Rahul Dravid",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234"
},
"Enterprise Customer Complaint": {
"Was a complaint filed?": "No"
},
"Incident Details": {
"Incident Type": "Fraudulent Transaction",
"Account Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
}
]
}
]

Adding Labels to Transactions

While adding labels to the existing transactions on a case the “transactionlabels” attribute can be added to the existing Add Transaction API JSon. You can add multiple labels to a transaction. This is applicable for Business Add API.

[
{
"caseId": "CA282",
"transactions": [
{
"transactionReferenceId": "FOCIBPAACB-CB-07",
"businessAdd": "Y",
"transactionTypeCode": "C",
"transactionLabels":["SURROUNDING","SUSPICIOUSs","FRAUD","EVENTED"],
}
}
]

Deleting Labels to Transactions

You can delete the labels from the transactions using the following JSon:

[
{
"caseId": "CA282",
"transactions": [
{
"transactionReferenceId": "FOCIBPAACB-CB-07",
"transactionTypeCode": "C"
}
}
]

Response Parameters

The following table describes the details of the response parameters.

Table 4-30 Parameter Details

First Level	Second Level	Third Level	Details
MESSAGE	-	-	Displays the overall response message from the API.
STATUS	-	-	Displays the overall status of the API call whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED and in case of partial success it will be represented by PARTIALSUCCESS.
RESULTARRAY	MESSAGE	-	Displays the response message from the API for the respective case.
RESULTARRAY	STATUS	-	Displays the status of the API call for the respective case whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED and in case of partial success it will be represented by PARTIALSUCCESS.
RESULTARRAY	caseId	-	Displays the case internal identifier on which the API was called.
RESULTARRAY	transactions	MESSAGE	Displays the response message from the API for the respective transaction under the respective case.
RESULTARRAY	transactions	STATUS	Displays the status of the API call for the respective transaction under the respective case whether it was successful or failed. In case of success, it will be represented by SUCCESS and in case of failure it will be represented by FAILED.
RESULTARRAY	transactions	transactionReferenceId	Displays the transaction internal identifier under the respective case on which the API was called.

Response JSON Sample

This section contains a response JSON sample for when transaction addition to an existing case is successful. The entries in this sample are only for reference purposes. Refer to Improvements in Real Time Event Creation APIs for additional Response JSON samples.

{
"MESSAGE": "Transactions addition was successful.",
"STATUS": "SUCCESS",
"RESULTARRAY": [
{
"MESSAGE": "Transactions addition was successful.",
"STATUS": "SUCCESS",
"caseId": "CA100",
"transactions": [
{
"MESSAGE": "Transaction added successfully.",
"STATUS": "SUCCESS",
"transactionReferenceId": "ACCIDIOSRMAC-5"
},
{
"MESSAGE": "Transaction added successfully.",
"STATUS": "SUCCESS",
"transactionReferenceId": "ACCIDIOSRMAC-6"
}
]
}
]
}

4.15 Add Transaction to Case