Close Financial Transaction Set Integration Point

This integration point enables you to close a transaction set. The application provides an option to keep financial transactions set open after creating financial messages. Leaving the transaction set open provides for the following possibilities:

  • Review, approve, or confirm multiple transactions within a transaction set.

  • Perform these steps at different time for each transaction or a small group of transactions. Each transaction progresses at its own pace through each step.

  • Payout individual transactions as soon as they confirm, rather than waiting for the confirmation of all transactions in a set.

  • Create a transaction set in which individual transactions enter and are paid out over a predetermined period, such as a week or two.

However, the transaction set must close after a particular period, like a week, moving any not-ready transactions to a subsequent week’s set.

Request

POST https://<host>:<port>/<context-root>/financialtransactionsets/<id>/close

Response

The financial transaction set is updated to Closed. The application returns the status code 200 OK. All financial transactions in the financial transaction set and not handled by the generate financial message activity are removed from the set.

See the "Response Messages" section in the HTTP API Integration Points part of the Developer Guide for more information.

Error Messages

A financial transaction set closes only when there is no financial transaction set level activity for the designated financial transaction set. There must be no financial transaction set activity for the financial transaction set in context to the status integration point (in progress).

When such an activity is running, the application returns the following error message and keeps the transaction set as open:

Table 1. Error Message
Code Text

GEN-HTTP-TBD

Cannot close the financial transaction set because a {activity type code} activity is currently running

Authorization

A user authorization configuration protects access to this integration point. The relevant access restriction is financialtransactionset.close IP.