Financial Message Integration Point

A notification message is sent to an external system once all the financial messages for a financial transaction set are written to the data file.

Notification Message

The system provides the following common notification to an endpoint. The property to set the endpoint to send out the notification is ohi.financialmessage.datafile.notification.endpoint. If the financial message endpoint requires Authentication, please use Authentication Use Case: FinancialMessageNotificationClient to set authentication. Please see section Outbound RESTful Service Invocations in Integration Guide for the process and more properties.

<notification correlationId="" workId="{activityId}" status="Success/Failure">
   <links>
     <link rel='file' uri='http://host:port/api/datafilesets/{datafilesetcode}/datafile/{datafilecode}/data'/>
     <link rel='file' uri='http://host:port/api/datafilesets/{datafilesetcode}/datafile/{datafilecode}/data'/>
     ...
    </links>
</notification>

The financial message data file can be downloaded by using the "Get details of a data file" request from the data file set integration point described in the cross area guide.

File Contents

The financial message file will have the following structure:

<financialMessages>
  <financialMessage/>
  <financialMessage/>
  ...
</financialMessages>

The <financialMessage/> element is described in the Generate Financial Message section of the financial guide.