Camt.056.001.01 Mapper

Overview

The Camt.056.001.01 mappers are used by SEPA Instant Credit Transfer(SCT Inst) Scheme for sending and receiving Payment Cancellation Request(FIToFIPmtCxlReq) messages between Clearing and Settlement Mechanisms(CSM) and FTM for Immediate Payments.

The Camt.056.001.01 mappers are a pair of Inbound/Outbound mappers.
  • Camt.056.001.01 Inbound Mapper: Map the SCT Inst Payment Cancellation Request messages to ISF messages. The default mapper name is Camt056ToISFMapper.
  • Camt.056.001.01 Outbound Mapper: Map the ISF messages to SCT Inst Payment Cancellation Request messages. The default mapper name is ISFToCamt056Mapper.

The details of the mapping specification for the inbound and outbound mappers are included in a separate document. Refer to Detailed camt.056.001.01 mapping specification for more information about obtaining the documentation for the mapping specifications.

The inbound and outbound camt.056.001.01 mappers can also be used in conjunction with the Wrapper mapper. Refer to SCT Inst Wrapper Mapper for more information.

Inbound Mapper

The CONFIG=entry in Channel parameter is required for inbound mapper. The mapper uses the setting to locate <msgTypeCfg> entry in Value table with child element <Type> containing camt.056.001.01. The <msgTypeCfg> contains the configuration parameters for the inbound mapper.

For example, the default Message From CSM channel is configured with a CONFIG=IP_MAP_CFG_FROM_CSM parameter. When a camt.056.001.01 message is received , the mapper looks for the <msgTypeCfg> entry in the Value table with the following conditions:
  • In Value table, the value of Category is IP_MAP_CFG_FROM_CSM.
  • In msgTypeCfg entry, the value of Type is camt.056.001.01.
The default <msgTypeCfg> for IP_MAP_CFG_FROM_CSM is as follows.
<msgTypeCfg>
	<class>CAMT056</class>
	<subType>IP_FROM_CSM_RCL</subType>
	<extendedCfg>
		<name>MASTER_FLAG</name>
		<value>N</value>
	</extendedCfg>
	<pt>
		<class>CAMT056</class>
		<subType>IP_FROM_CSM_RCL</subType>
	</pt>
	<mapName>Camt056ToISFMapper</mapName>
	<type>camt.056.001.01</type>
</msgTypeCfg>
The inbound mapper uses the <msgTypeCfg> entry as follows:
  • <class> - value for TXN_PAYMENT_V.OBJ_CLASS
  • <subType> - value for TXN_PAYMENT_V.SUBTYPE and ISFMessage/Header/BusinessConcept
  • <extendedCfg>.<value> with <name>=MASTER_FLAG - value for MASTER_FLAG (for TXN_PAYMENT_V and TRANSMISSION_V)
  • <pt>.<class> - value for TRANSMISSION_V.OBJ_CLASS
  • <pt>.<subType> - value for TRANSMISSION_V.SUBTYPE

If the <msgTypeCfg> entry cannot be located, the mapper throws an exception with error 'subType not found'.

Table 1 shows the default configuration parameters for the channels using camt.056.001.01 inbound mapper.
Table 1. Default configuration parameters for channels using camt.056.001.01 inbound mapper
Channel Category Class SubType MASTER_FLAG Pt.class Pt.subType
Message From CSM IP_MAP_CFG_FROM_CSM CAMT056 IP_FROM_CSM_RCL N CAMT056 IP_FROM_CSM_RCL
Request From Channel IP_MAP_CFG_REQ_FROM_CHAN CAMT056 IP_FROM_DBTR_RCL N CAMT056 IP_FROM_DBTR_RCL
The inbound mapper handles the Datetime elements with the rules as follows.
  • If a timezone offset is included in the datetime value, the datetime value is mapped to ISF with UTC timezone.
  • If a timezone off set is not included in a datetime value,
    • if the Timezone is configured in the Channel table, the input datetime is recognized as the value in the format of the channel timezone, and is mapped to ISF with UTC timezone.
    • if the Timezone is not configured in the Channel table, the input datetime is recognized as the value in the format of the local timezone in which the mapper is executing, and the input datetime is mapped to ISF with UTC timezone.

Outbound Mapper

The CONFIG=entry in Channel parameter is required for outbound mapper. The mapper uses the setting to locate <msgTypeCfg> entry in Value table with child element <subType> containing the same value as the ISF Business Concept. The <msgTypeCfg> contains the configuration parameters for the outbound mapper.

For example, the default Message To CSM channel is configured with a CONFIG=IP_MAP_CFG_TO_CSM parameter. When an ISF message is received, the mapper looks for the <msgTypeCfg> entry in the Value table with the following conditions:
  • In Value table, the value of Category is IP_MAP_CFG_TO_CSM.
  • In msgTypeCfg entry, the value of subType is the same as the ISF Business Concept.
The default <msgTypeCfg> for IP_MAP_CFG_TO_CSM is as follows.
<msgTypeCfg>
	<class>CAMT056</class>
	<subType>IP_TO_CSM_RCL</subType>
	<extendedCfg>
		<name>MASTER_FLAG</name>
		<value>N</value>
	</extendedCfg>
	<pt>
		<class>CAMT056</class>
		<subType>IP_TO_CSM_RCL</subType>
	</pt>
	<mapName>ISFToCamt056Mapper</mapName>
	<type>camt.056.001.01</type>
</msgTypeCfg>
The outbound mapper uses the configuration parameter of the <msgTypeCfg> entry as follows:
  • <type> - value for the namespace of the output camt.056.001.01 message
Note: Since the ISFToCamt056Mapper is a common mapper which supports both camt.056.001.05 for TCH and camt.056.001.01 for SCT Inst, the <type> value is used to specify the version of camt.056 that the mapper is supporting.

If the <msgTypeCfg> entry cannot be located, the mapper throws an exception with error 'subType not found'.

Table 2 shows the default configuration parameters for the channels using camt.056.001.01 outbound mapper.
Table 2. Default configuration parameters for channels using camt.056.001.01 outbound mapper
Channel Category Class SubType Type
Message To CSM IP_MAP_CFG_TO_CSM CAMT056 IP_TO_CSM_RCL camt.056.001.01
The outbound mapper handles the Datetime elements with the rules as follows.
  • If the Timezone is configured in the Channel table, the input datetime is mapped from the value with UTC timezone to the value in the format of the channel Timezone.
  • If the Timezone is not configured in the Channel table, the input datetime is mapped from the value with UTC timezone to the value in the format of the local timezone in which the mapper is executing.
The outbound mapper uses the channel parameter TS_INCLUDE_OFFSET to control whether the timezone offset is included in the output datetime values.
  • If TS_INCLUDE_OFFSET is set to Y, then the timezone offset is included in the output datetime values.
  • If TS_INCLUDE_OFFSET is set to N or not configured, then the timezone offset is not included in the output datetime values.