Batch (ICL) status update response XML format

The Transaction Server sends a response to a status update request when the application indicates that it wants a response.

The Transaction Server returns a nonzero value in the <errorCode> element in the response message when any of the following problems occur.
  • The Transaction Server could not parse the message that it received.
  • Required information was missing from the message that it received.
  • An exception occurred when the Transaction Server was processing the message that it received.
When an invalid error code or batch (ICL) ID is in the request message, a database exception occurs during processing and the corresponding error information is returned in the response message.
The following table describes the XML elements that are available for a batch (ICL) status update response from the Transaction Server.
Table 1. Batch (ICL) status update response XML format
Element name Parent element Value
ibmPaymentsDirectorBridge None, this element is the root element None, this element is the root element.
header ibmPaymentsDirectorBridge None, this element is an XML parent element.
msgDesc header Service_Response
msgType header applyUpdates
version header 1.1.0
messageTime header The time stamp when the XML message was created. It is in UTC time.
sourceId header A string that identifies where the message came from. For response messages, it is Transaction Server.
destinationId header A string that identifies where the message is to be sent. For response messages, it is the value that was received in the <sourceId> element of the request message.
unitOfWork header The batch (ICL) that was requested to be updated. This element has a type="PRESENTMENT_ID" attribute and the ID of the batch (ICL) as its value.
ibmPaymentsDirectorContext header None, this element is an XML parent element.
msgIdStack ibmPaymentsDirectorContext None, this element is an XML parent element.
msgId msgIdStack The correlation ID for the message.
errorCode header Indicates whether an error occurred when the Transaction Server updated the status of the batch (ICL). The error code is one of the following values:
  • 0 – The update was successful.
  • 4 – An unsupported value was received for the <msgDesc> element.
  • 5 – An unsupported value was received for the <msgType> element.
  • 9 – A runtime exception occurred.
  • 10 – An error occurred getting the value of JMSType.
  • 11 – An XML encoding error occurred.
  • 15 – A database exception occurred.
  • 115 – Duplicate error code.
errorMessage header The text of the error message. If an exception occurred updating the status of the batch (ICL), this element contains the message that corresponds to the exception
The following XML is an example of a response message that is received from the Transaction Server when an invalid error code is specified.
<?xml version="1.0" encoding="UTF-8"?>
<ibmPaymentsDirectorBridge>
   <header>
      <msgDesc>Service_Response</msgDesc>
      <msgType>applyUpdates</msgType>
      <version>1.0.0</version>
      <messageTime>2017-01-26T09:30:46.385-05:00</messageTime>
      <sourceId>Transaction Server</sourceId>
      <destinationId>My App</destinationId>
      <unitOfWork type="PRESENTMENT_ID">62</unitOfWork>
      <ibmPaymentsDirectorContext>
         <msgIdStack>
         <msgId>ID:414d512046544d2e514d414e4147455277158058200a9502</msgId>
         </msgIdStack>
      </ibmPaymentsDirectorContext>
      <errorCode>15</errorCode>
      <errorMessage>Failure updating PRESENTMENT: Database Accessor
Exception; Accessor – Validation Results Accessor; Message – Failure creating
failed validation result for CASH_LETTER_VAL: ERROR_CODE= RSK0007; DB2 SQL
Error: SQLCODE=-530, SQLSTATE=23503, SQLERRMC=0, DRIVER=3.61.75; State - 23503;
SQL – INSERT INTO CASH_LETTER_VAL ( PRESENTMENT_ID, CASHLTR_ID, RECORD_SEQ_NUM,
ERROR_CODE, COUNT, ACTUAL_VAL, REJECT, OVERRIDE, VERSION_NUM ) VALUES ( ?, ?,
?, ?, ?, ?, ?, ?, ? )
      </errorMessage>
   </header>
</ibmPaymentsDirectorBridge>