TCR insert transaction
This web service inserts a transaction into the unit of work specified.
The following table shows the parameters for this web service.
| Parameter | Parent element | Required | Description |
|---|---|---|---|
| ActiveWorkId | None | Yes | The ID of the active unit of work into which this transaction is inserted. The ID is an integer value. |
| TargetPaymentId | None | Yes | The ID of the transaction where this transaction is to be inserted. The ID is an integer value. |
| InsertDirection | None | Yes | Defines where, relative to the transaction specified in
TargetPaymentId, this transaction is to be inserted. Valid values for this parameter are
shown in the following list.
|
| UserID | User | Yes | The user ID with the permissions that are needed to do this action. |
| HostName | User | No | The hostname where the EJB application is deployed. |
| AdjustmentCode | None | Yes | The adjustment code identifies the reason for the current adjustment. |
| ErrorCode | None | Yes | The error reason for the adjustment. The category for this error code must be
TCR. |
| Comment1 | None | No | Any additional user comment about the adjustment. |
| Comment2 | None | No | Any additional user comment about the adjustment. |
| Comment3 | None | No | Any additional user comment about the adjustment. |
| Comment4 | None | No | Any additional user comment about the adjustment. |
| Comment5 | None | No | Any additional user comment about the adjustment. |
| TransactionType | TcrPendingChanges | No | The type of transaction that is being inserted. Valid values for this parameter are
shown in the following list.
None for this parameter. |
| Currency | TcrPendingChanges | No | The currency type of the transaction. The default value is USD. |
| Amount | TcrPendingChanges | No | The amount of the transaction. |
| ProcessControl | TcrPendingChanges | No | The process control information for the transaction. |
| AccountNumber | TcrPendingChanges | No | The account number for the transaction. |
| Field4 | TcrPendingChanges | No | The value of check field 4 for the transaction. |
| BankCode | TcrPendingChanges | No | The routing transit number for the transaction. |
| Epc | TcrPendingChanges | No | MICR field 6 for the transaction. |
| Identification | TcrPendingChanges | No | MICR field 7 for the transaction. |
| Endpoint | TcrPendingChanges | No | The ID of the receiving point endpoint for the transaction. It is required if Business Rules validation is not used. |
| AccumId | TcrPendingChanges | No | The settlement accumulator ID of the transaction. |
| AccumId2 | TcrPendingChanges | No | The secondary settlement accumulator ID of the transaction. |
| AccumOffsetSettleId | TcrPendingChanges | No | The settlement accumulator ID for offset settlement. |
| OnUs | TcrPendingChanges | No | The on-us indicator. Valid values are shown in the following list.
|
| AdviceAttribute | AdviceAttributes | The customer advice information. This parameter contains name and value pairs that you can specify for each customer advice attribute that you want to send. |
The body of the SOAP message is shown in the following example. Not all of the parameters are required.
<ftm:TcrInsertTransactionRequest>
<ActiveWorkId>184</ActiveWorkId>
<TargetPaymentId>2161</TargetPaymentId>
<InsertDirection>Before</InsertDirection>
<User>
<UserID>fxhadmin</UserID>
<HostName>?</HostName>
</User>
<AdjustmentCode>SC</AdjustmentCode>
<ErrorCode>TCR001</ErrorCode>
<Comment1>Comment Tested</Comment1>
<Comment2>?</Comment2>
<Comment3>?</Comment3>
<Comment4>?</Comment4>
<Comment5>?</Comment5>
<TcrPendingChanges>
<TransactionType>Credit</TransactionType>
<Currency>USD</Currency>
<Amount>1007715</Amount>
<ProcessControl>02</ProcessControl>
<AccountNumber>98765432109876</AccountNumber>
<Field4>?</Field4>
<Epc></Epc>
<OnUs></OnUs>
<AccumId></AccumId>
<AccumId2></AccumId2>
<AccumOffsetSettleId></AccumOffsetSettleId>
<Identification></Identification>
<Endpoint></Endpoint>
<BankCode>123456780</BankCode>
</TcrPendingChanges>
<AdviceAttributes>
<!--Zero or more repetitions of AdviceAttribute-->
<AdviceAttribute>
<Name>Branch Number</Name>
<Value>12</Value>
</AdviceAttribute>
<AdviceAttribute>
<Name>Teller Number</Name>
<Value>123</Value>
</AdviceAttribute>
<AdviceAttribute>
<Name>Transaction Number</Name>
<Value>1234</Value>
</AdviceAttribute>
</AdviceAttributes>
</ftm:TcrInsertTransactionRequest>