camt.109.001.01 mapper

The camt.109.001.01 (camt.109) mappers are used to indicate what actions have been taken in attempting to cancel the presentment, stop the payment of the check, or both, as referred to in the message.

Overview

The camt.109 mappers are a pair of inbound and outbound mappers.

camt.109 inbound mapper: This mapper maps the ChequeCancellationOrStopReport messages to ISF messages. The default mapper name is Camt109ToISFMapper.
camt.109 outbound mapper: This mapper maps the ISF messages to ChequeCancellationOrStopReport messages. The default mapper name is ISFToCamt109Mapper.

The details of the mapping specification for these mappers are in separate documentation that is included in the documentation fix pack for High Value Payments. For more information about getting the documentation fix pack, see FTM support links for High Value Payments.

Inbound mapper

The CONFIG=entry channel parameter is required for the inbound mapper. The mapper uses this parameter to locate the <msgTypeCfg> entry with a <type> child element that contains camt.109.* in the value table. The <msgTypeCfg> entry contains the configuration parameters for the inbound mapper.

For example, the default Message From channel is configured with a CONFIG=HVP_MAP_CFG_REQ_FROM_CHAN parameter. When a camt.109.001.01 message is received, the mapper searches the value table to find the <msgTypeCfg> entry to use for the message. It searches for a value table entry that meets the following conditions.

The category is HVP_MAP_CFG_REQ_FROM_CHAN.
The <msgTypeCfg> entry has a <type> child element with the value of camt.109.*.

If the <msgTypeCfg> entry cannot be found, the mapper causes an exception to report a subType not found error.

The default <msgTypeCfg> entry for HVP_MAP_CFG_REQ_FROM_CHAN is shown in the following example.

<msgTypeCfg>
   <class>CAMT109</class>
   <subType>HVP_FROM_CHAN_STATUS_CHQ_REQ_STOP</subType>
   <extendedCfg>
      <name>MASTER_FLAG</name>
      <value>Y</value>
   </extendedCfg>
   <extendedCfg>
      <name>MAP_FOR_HVP</name>
      <value>Y</value>
   </extendedCfg>
   <pt>
      <class>CAMT109</class>
      <subType>HVP_FROM_CHAN_STATUS_CHQ_REQ_STOP</subType>
   </pt>
   <mapName>Camt109ToISFMapper</mapName>
   <type>camt.109.*</type>
</msgTypeCfg>

The following table shows the values from the <msgTypeCfg> entry that are used as configuration parameters by the inbound mapper.

Table 1. Values from `<msgTypeCfg>` that are used as configuration parameters by the inbound mapper
Element	Description
`<class>`	The value from this element is used as the value for TXN_PAYMENT_V.OBJ_CLASS.
`<subType>`	The value from this element is used as the value for TXN_PAYMENT_V.SUBTYPE and ISFMessage/Header/BusinessConcept.
`<extendedCfg>` element that has a `<name>` child element with the value MASTER_FLAG.	The value from the associated `<value>` child element is used as the value for MASTER_FLAG for TXN_PAYMENT_V and TRANSMISSION_V.
`<extendedCfg>` element that has a `<name>` child element with the value MAP_FOR_HVP.	The value from the associated `<value>` child element is used to indicate whether the map is for High Value Payments.
`<pt>`	The value from the `<class>` child element is used as the value for TRANSMISSION_V.OBJ_CLASS.
`<pt>`	The value from the `<subType>` child element is used as the value for TRANSMISSION_V.SUBTYPE.

The following table shows the default configuration parameters for channels that use the camt.109 inbound mapper.

Table 2. Default configuration parameters for channels that use the camt.109 inbound mapper
Category	Class	SubType	MASTER_FLAG	Pt.class	Pt.subType
`HVP_MAP_CFG_REQ_FROM_CHAN`	`CAMT109`	`HVP_FROM_CHAN_STATUS_CHQ_REQ_STOP`	`Y`	`CAMT109`	`HVP_FROM_CHAN_STATUS_CHQ_REQ_STOP`

The inbound mapper handles the datetime elements by using the following rules.

If a time zone offset is included in the datetime value, the datetime value is mapped to ISF with the UTC time zone.
If a time zone offset is not included in a datetime value, the following rules are used.
- If the time zone is configured in the Channel table, the input datetime value is recognized in the format of the channel time zone. It is mapped to ISF with the UTC time zone.
- If the time zone is not configured in the Channel table, the input datetime value is recognized in the format of the local time zone where the mapper is running. The input datetime is mapped to ISF with the UTC time zone.

Outbound mapper

The CONFIG=entry channel parameter is required for the outbound mapper. The mapper uses this parameter to locate the <msgTypeCfg> entry with a <subType> child element that contains the same value as the ISF business concept. The <msgTypeCfg> entry contains the configuration parameters for the outbound mapper.

For example, the default Message To channel is configured with a CONFIG=HVP_MAP_CFG_MSG_TO_CHANNEL parameter. When an ISF message is received, the mapper searches the value table to find the <msgTypeCfg> entry to use for the message. It searches for a value table entry that meets the following conditions.

The category is HVP_MAP_CFG_MSG_TO_CHANNEL.
The <msgTypeCfg> entry has a <subType> child element with a value that is the same as the ISF business concept.

If the <msgTypeCfg> entry cannot be found, the mapper causes an exception to report a subType not found error.

The default <msgTypeCfg> entry for HVP_MAP_CFG_MSG_TO_CHANNEL is shown in the following example.

<msgTypeCfg>
   <class>CAMT109</class>
   <subType>HVP_TO_CHNL_STATUS_CHQ_REQ_STOP</subType>
   <extendedCfg>
      <name>MASTER_FLAG</</name>
      <value>N</value>
   </extendedCfg>
   <extendedCfg>
      <name>MAP_FOR_HVP</name>
      <value>Y</value>
   </extendedCfg>
   <pt>
      <class>CAMT109</class>
      <subType>HVP_TO_CHNL_STATUS_CHQ_REQ_STOP</subType>
   </pt>
   <mapName>ISFToCamt109Mapper</mapName>
   <type>camt.109.001.01</type>
</msgTypeCfg>

The following table shows the values from the <msgTypeCfg> entry that are used as configuration parameters by the outbound mapper.

Table 3. Values from `<msgTypeCfg>` that are used as configuration parameters by the outbound mapper
Element	Description
`<extendedCfg>` element that has a `<name>` child element with the value MAP_FOR_HVP.	The value from the associated `<value>` child element indicates whether the map is for High Value Payments.
`<type>`	The value from this element is used as the namespace of the output camt.109 message. For Message From, the value must be camt.109.001.01.

The following table shows the default configuration parameters for the channels that use the camt.109 outbound mapper.

Table 4. Default configuration parameters for channels that use the camt.109 outbound mapper
Category	Class	SubType	Type
`HVP_MAP_CFG_MSG_TO_CHANNEL`	`CAMT109`	`HVP_TO_CHNL_STATUS_CHQ_REQ_STOP`	`camt.109.001.01`

The outbound mapper handles the datetime elements by using the following rules.

If the time zone is configured in the Channel table, the input datetime value is mapped from the UTC time zone to the format of the channel time zone.
If the time zone is not configured in the Channel table, the local time zone where the mapper is running is used. The input datetime value is mapped from the UTC time zone to the format of the local time zone.

The outbound mapper uses the TS_INCLUDE_OFFSET channel parameter to control whether the time zone offset is included in the output datetime values.

If TS_INCLUDE_OFFSET is set to Y, the time zone offset is included in the output datetime values.
If TS_INCLUDE_OFFSET is set to N or not configured, the time zone offset is not included in the output datetime values.