Batch (ICL) status update request XML format

When an external application needs to update the status of a batch (ICL), it sends an apply updates request message to the Transaction Server.

The following table describes the XML elements that are available for a batch (ICL) status update request that is sent to the Transaction Server. It also shows whether the XML element is required or not.

Table 1. Batch (ICL) status update request XML format
Element name	Parent element	Value	Required element
ibmPaymentsDirectorBridge	None, this element is the root element.	None, this element is an XML parent element.	Yes
header	ibmPaymentsDirectorBridge	None, this element is an XML parent element.	Yes
msgDesc	header	Service_Request	Yes
msgType	header	applyUpdates	Yes
version	header	1.1.0	Yes
messageTime	header	The timestamp when the XML message was created. It is in Coordinated Universal Time (UTC).	Yes
sourceId	header	A string that identifies where the message came from. This value is defined by the user.	Yes
destinationId	header	A string that identifies where the message is to be sent. For request messages, set the value to: Transaction Server.	Yes
unitOfWork	header	Specify the batch (ICL) that is to be updated. This element must have the `type="PRESENTMENT_ID"` attribute and have its value set to the ID of the batch (ICL) to be updated.	Yes
responseRequired	header	Indicate whether the Transaction Server is to send a response to the apply updates request. Set this element to true to receive a response and false if no response is needed.	Yes
contents	ibmPaymentsDirectorBridge	This element is an XML parent element that contains a `<batch>` element.	Yes
batch	contents	This element is an XML parent element that contains the elements that pertain to the batch (ICL).	Yes
condition	batch	The state to update for the batch (ICL). It is one of the following values: ACCEPTED REJECTED	No
overrideable	batch	Indicate whether the batch (ICL) status can be overridden. It is either true or false.	No
overriddenBy	batch	The user ID of the user or the name of the application that updated the state of the batch (ICL).	No
pending	batch	Indicate whether the batch (ICL) is pending. It is either true or false.	No
riskReviewedBy	batch	The name of the user or the application that reviewed the batch (ICL). Provide a value for this element only when the RISK_REVIEWED state is specified in the `<states>` element for the message. This column cannot be overwritten. The value must either be already null or being set to null.	No
states	batch	This element is an XML parent element that contains one or more `<state>` elements.	No
state	states	The name of the state that is to be set or reset for the batch (ICL). Each `<state>` element must include the `direction="on"` or `direction="off"` attribute.	No
validation	batch	This element is an XML parent element that contains one or more `<error>` elements. When the `<validation>` element is included in the XML for the message, the validation version number is automatically incremented for this batch (ICL). The validation version is incremented even when no error information is provided in the message.	No
error	validation	This element is an XML parent element that contains information about a single error code. It includes the `<errorCode>` and `<errorDetailMessage>` elements.	No
errorCode	error	The error code for the error. It must be an error code that is defined in the error_codes database table. The reject level of this error code is not used to automatically update the condition or the overrideable flag for the batch (ICL). If the batch (ICL) needs to be rejected, the `<condition>` element in the message needs to be set to rejected and the `<overrideable>` element must also be updated if necessary. If the batch (ICL) is rejected and the error code that is specified in this element has a reject level of batch (ICL) or higher, the reject_error_code database column is set with this error code.	No
errorDetailMessage	error	The detailed error message text for this error code. Substitution parameters cannot be specified in this element, so the detailed error text needs to be in its final format when it is added to the message. This element is not required, even when the message contains the `<errorCode>` element.	No

The following XML is an example of a request message that is sent to the Transaction Server to reject a batch (ICL).

<?xml version="1.0" encoding="UTF-8"?>
<ibmPaymentsDirectorBridge>
   <header>
      <msgDesc>Service_Request</msgDesc>
      <msgType>applyUpdates</msgType>
      <version>1.0.0</version>
      <messageTime>2017-01-11T21:52:46.372Z</messageTime>
      <sourceId>My App</sourceId>
      <destinationId>Transaction Server</destinationId>
      <unitOfWork type="PRESENTMENT_ID">62</unitOfWork>
      <responseRequired>true</responseRequired>
   </header>
   <contents>
      <batch>
         <condition>REJECTED</condition>
         <overrideable>false</overrideable>
         <overriddenBy></overriddenBy>
         <pending>false</pending>
         <riskReviewedBy>Joe Smith</riskReviewedBy>
         <states>
            <state direction="on">ACTIVITY_MONITORED</state>
            <state direction="on">RISK_REVIEWED</state>
         </states>
         <validation>
            <error>
               <errorCode>RSK0003</errorCode>
               <errorDetailMessage>Credit of 50000.00 exceeds allowed limit</errorDetailMessage>
            </error>
         </validation>
      </batch>
   </contents>
</ibmPaymentsDirectorBridge>