Event parameters

This event handler uses the general Messaging API event handler parameters and parameters that are specific to the event. Event parameters are specified in the Scheduler.xml file.

The following table shows the values that are used to reference a transaction exception type in the Scheduler.xml file.

Table 1. PaymentExceptionEventHandler payment exception types
Exception type	Value to use in the scheduler XML	Description
Exception	EXCEPTION XCP	The exception flag indicates that the transaction is a suspect, a duplicate, a potential duplicate, or contains a validation error.
Unhandled Exception	UNHANDLEDEXCEPTION UNHANDLEDXCP UNHANDLED UXCP	The unhandled exception flag indicates that the transaction has one of the exceptions that is described for the exception flag. It is still being processed and its exception status might change.
Reviewable	REVIEWABLE	The reviewable flag indicates that the transaction is still being reviewed regarding its suspect status. After the suspect status of the transaction is confirmed, the reviewable indicator is turned off.
Repairable	REPAIRABLE	The repairable flag indicates that the content of the transaction is still being validated. After the content of the transaction is analyzed for validation failures, the repairable indicator is turned off.

The following table shows the additional event parameters for the transaction exception event handler.

Table 2. PaymentExceptionEventHandler parameters
Parameter name	Trigger	Type	Value	Description
trigger	Yes	String	Table 1 shows the valid values for this parameter.	A comma-delimited list of exception types that indicates a single transaction exception situation that causes the event to occur. Refer to Specifying exception triggers for a complete description.
trigger1 ... triggerN	Yes	String	Table 1 shows the valid values for these parameters.	A comma-delimited list of exception types that indicates a single transaction exception situation that causes the event to occur. Refer to Specifying exception triggers for a complete description. If multiple triggers are needed, use this parameter specification instead of trigger. For more information about using multiple triggers, see Specifying Triggers. Note: Do not use both specifications.
minPresStates	No	String	One or more of the batch (ICL) states that can be used for triggers.	A comma-delimited set of batch (ICL) states that must be in effect for the message to be sent. The batch (ICL) to which the transaction is attached is tested for these states.
inPaymentStandard	No	Short	N/A	Specify a single inbound payment standard value that causes the message to be sent for a payment. Use the not indicator to cause the message to be sent when the payment does not have this inbound payment standard value. For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
inPaymentMsgType	No	Short	N/A	Specify a single inbound payment message type that causes the message to be sent for a payment. Use the not indicator to cause the message to be sent when the payment does not have this inbound payment message type. For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
inPaymentSchemeId	No	String	Example values are shown in the following list: CPA 005	A comma-delimited list of inbound payment scheme IDs. The values to use for this parameter are found in the Name column of the PAYMENT_SCHEME_TYPE table.
outPaymentStandard	No	Short	N/A	Specify a single outbound payment standard value that causes the message to be sent for a payment. Use the not indicator to cause the message to be sent when the payment does not have this outbound payment standard value. For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
outPaymentMsgType	No	Short	N/A	Specify a single outbound payment message type that causes the message to be sent for a payment. Use the not indicator to cause the message to be sent when the payment does not have this outbound payment message type. For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
outPaymentSchemeId	No	String		A comma-delimited list of outbound payment scheme IDs. The outbound payment scheme for a payment is the same as the payment scheme of the business day associated with the processing batch. The values to use for this parameter are found in the Name column of the PAYMENT_SCHEME_TYPE table.
paymentStates	No	String	A comma separated list of payment states. Valid payment states are shown in the following list. PRECHECKDONE PREFUNDED PRESUBMITCOMPLETE ZELLERECONCILED	A comma-delimited list of payment states that must be in effect for the message to be sent.
updateBy	No	String	The value specified when `PaymentAction` is processed. Internally, the values PFS and FTM Base are used.	Identifies the application that caused the exception status to change. This parameter is primarily used to maintain the correct payment status and to prevent duplicate message generation.
Note: The following list describes what the value in the trigger column means: Yes When the value in this column in the database changes to one of the values that are allowed by the event stanza, the handler places a message on the specified queue. No When the value in this column in the database changes, it does not cause a message to be placed on a queue. This parameter can be added to provide more criteria that must be met to send a Messaging API message. N/A The parameter is not considered when it is being determined whether a message is sent.

Specifying exception triggers

Each trigger can have up to two exception types, Exception and Unhandled Exception. The exception types must be comma-delimited and the not indicator can be used. For example, XCP,~UNHANDLED runs the event handler when an exception (XCP) occurs and it is not an UNHANDLED exception. For more information about using the not indicator, see Specifying Value Modifiers and Special Values.

Note: If a trigger is accidentally supplied more than once, the event message is only sent one time.