There are two variants of the Creditor FI outgoing Return good case, depending on whether the creditor
and creditor accounts belong to the same financial institution. This special case is called an On Us
return, and the return does not need to be sent to the CSM for further processing. Such a return is
recognised if the bank code for the creditor FI matches a configured value. Both variants are also handled by the
Outgoing Payment Transaction Finite State Machine.
The creditor FI outgoing return good case consists of the following processing steps:
Not On Us return
FTM for Immediate Payments receives an immediate payment Payment Return from the
Channels interface on behalf of a (creditor) client.
The return is validated and checked for duplicate.
Next, the set of services that are configured for the Pre-Check Not On Us set are invoked. This set should
just perform validation checks to determine whether the return can be accepted for submission.
On successful completion of the Pre-Check Not On Us services, the set of services (if any) that are
configured for the Pre-Submit set are invoked.
On successful completion of the Pre-Submit services, the payment is accepted for submission, and a return
request is created to submit to the CSM.
The return request is sent to the CSM, and once sending is confirmed, the set of services that are configured
for the Post-Submit set are invoked.
On successful completion of the Post-Submit services, FTM for Immediate Payments sends an acknowledgment to
the Channels interface, which in turn may provide a notification to the (creditor) client.
On Us return
FTM for Immediate Payments receives an immediate payment Payment Return from the
Channels interface on behalf of a (creditor) client.
The return is validated and checked for duplicate.
Next, the set of services that are configured for the Pre-Check On Us set are invoked. This set should
just perform validation checks to determine whether the return can be accepted for submission.
On successful completion of the Pre-Check On Us services, the Accounting DebitCredit request is invoked to
charge the creditor's account and book funds to the creditor's account. The Accounting service replies with a
successful response.
FTM for Immediate Payments then sends an acknowledgment to the Channels interface, which in turn may provide
a notification to the (creditor) client.
Use Case High-Level Sequence Diagram
The high-level sequence diagram for both variants of the creditor FI outgoing return good case follows the
same High-Level Sequence Diagram as the debtor FI outgoing credit transfer good use case - with the exception
that a response message isn't expected back from the CSM after sending the return.
Note: The diagram illustrates
sets of optional services within parallel groups for each of the service sets Pre-Check On Us, Pre-Check Not On Us,
Pre-Submit, Post-Submit Accept. The services shown depict services that may typically be included in the set. The
actual services to be invoked, and whether they are invoked in parallel or serially is determined by configuration.
Use Case Detailed Sequence Diagram
The detailed sequence diagram is split into three parts.Figure 1. Valid Outgoing Return: Part 1 of 3
