Transaction actions

Transaction actions are used to apply updates to a specific transaction or group of transactions in the Transaction Server. The transactions are identified by their individual payment ID values.

The types of transaction actions that are supported by the Transaction Server are shown in the following table.
Table 1. Transaction actions
Transaction action bean Class name of the bean Description
Transaction update bean PaymentUpdateBean Used to update specific fields in a single transaction. The transaction must already exist for the transaction update bean to work.
Transaction insert bean PaymentInsertBean Used to insert a new transaction into an existing batch (ICL). The transaction is inserted at the end of the balance order of the batch (ICL). A new transaction identifier is generated for the inserted transaction.
Transaction delete bean PaymentDeleteBean Used to mark a single transaction as deleted or undeleted. The transaction must exist for the transaction delete bean to work.
Image update bean ImageUpdateBean Used to update the images for a single transaction. The transaction must exist for the image update bean to work.
Modify transactions bean ModifyPaymentsBean Used to update multiple transactions in a single request. The bean is a collection of many transaction actions.
Block move bean BlockMoveBean Used to move a collection of one or more transactions within the balance order of a batch (ICL). The transaction, or transactions, must exist for the block move bean to work.
Block insert bean BlockInsertBean Used to collect a block of transaction insert beans for insertion into an existing batch (ICL). A new transaction identifier is generated for all of the inserted transactions.

The Transaction Server receives the information for the requested update in the applyUpdates message. It turns on an action code that determines how to handle the update that it received. The unit of work contains the batch (ICL) ID for the batch (ICL) that the transaction belongs to. Updates can be done only to transactions that belong to a single batch (ICL).

The following table shows the message content for the applyUpdates request for a transaction action.
Table 2. applyUpdates Request
Field Description
Message Type The message type text for this message. The strings that can be used for the message type are shown in the following list:
  • AppBridgeConstants.MSGTYPE_APPLY_UPDATES
  • applyUpdates
Using the string that is defined in the AppBridgeConstants interface is the preferred method for setting the message type.
Unit of Work Batch (ICL) identifier. It is a long value and must be able to be parsed as a long.
Payload Any transaction action bean with a type that is shown in the following list.
  • PaymentUpdateBean
  • PaymentInsertBean
  • PaymentDeleteBean
  • ImageUpdateBean
  • ModifyPaymentsBean
  • BlockMoveBean
  • BlockInsertBean
Each transaction action bean contains a payment ID and a set of name and value pairs that describe the item or transaction fields to modify.
Contents If you don't want to use the payload field to send the information that is needed for this applyUpdates request, you can send it in this field instead. Use a <contents> element to contain the XML with the information that is needed for the request.
Note: The name and value pairs in a bean are not meant for general use by an external application. Each transaction action bean provides individual setters to specify the item or transaction parameters that can be modified. Do not try to directly reference the name and value pair maps in a transaction action bean.
After the updates are applied, they can affect the item counts and values for that batch (ICL). The Transaction Server applies the changes to the following batch (ICL) totals. Changing these totals allows the totals from the initial batch (ICL) load to remain intact and the updated results to be shown in the database.
  • ITEM_CREDITS
  • ITEM_DEBITS
  • ITEM_CREDIT_AMT
  • ITEM_DEBIT_AMT
Each transaction action returns an action code when it is queried. The code indicates the type of action to be done. The Transaction Server supports the following action codes.
  • public static final short ACTION_UPDATE = 1;
  • public static final short ACTION_INSERT = 2;
  • public static final short ACTION_DELETE = 3;
  • public static final short ACTION_IMAGE_UPDATE = 4;
  • public static final short ACTION_MODIFY_LIST = 5;
  • public static final short ACTION_BLOCK_MOVE = 6;
  • public static final short ACTION_BLOCK_INSERT = 7;

The following sections describe the transaction action beans that do the actions that are associated with these action codes.