ReturnPayment web service

When the creditor receives the payment (pacs.008) and request for return of funds (camt.056) messages, this web service starts the pacs.008 message creation process. It begins by creating the physical transmission and notifying FTM The Clearing House Real Time Payments to follow up with the actual pacs.008 message that is to be mapped.

Unlike the other web services, this one supports only a single ID as an input. The ID must reference the original pacs.008 payment message because the original message is needed to return the amount. The return for the pacs.008 messages works whether the camt.056 message is received or not. If the payment is to be returned without the camt.056 message, the web service expects the pacs.008 transaction ID as input.

This web service supports both asynchronous and synchronous modes. In asynchronous mode, the web service initiates the corresponding message and does not wait for The Clearing House Real Time Payments to complete. In synchronous mode, the web service submits the corresponding message and waits until The Clearing House Real Time Payments finishes its processing. If the processing takes longer than the configured timeout value, an HTTP 408 error is returned. Otherwise, the web service returns the most recent status.

The following figure shows the sequence diagram for this web service.

This diagram shows the sequence of events that occur when the return payment web service is called. — Figure 1. Return payment sequence diagram

The input and response information for the inbound transaction web services is provided in the API reference of the Web Service Browser. Expand the InboundTransaction Services section of the reference to see the services in this group.