File lifecycle events

Below are the files state machine and a description of the related events and statuses.

Events

EventDescription
processedThe file has been processed, either by the bank in case of an outgoing file or by Numeral in case of an incoming file.
receivedThe incoming file has been received from the bank and its format is not supported by Numeral.
createdThe outgoing file has been created by Numeral.
approvedThe outgoing file has been approved.
canceledThe outgoing file has been canceled.
sentThe outgoing file has been sent to the bank.
rejectedThe file has been rejected, either by the bank in case of an outgoing file or by Numeral in case of an incoming file. The rejection reason is indicated in the status_details attribute.
retriedThe incoming file has been retried.

Statuses

StatusDescription
processedThe file has been processed, either by the bank in case of an outgoing file or by Numeral in case of an incoming file.
receivedThe incoming file has been received from the bank and its format is not supported by Numeral.
createdThe outgoing file has been created.
approvedThe outgoing file has been approved.
canceledThe outgoing file has been canceled.
sentThe outgoing file has been sent to the bank.
rejectedThe file has been rejected, either by the bank in case of an outgoing file or by Numeral in case of an incoming file. The rejection reason is indicated in the status_details attribute.

State machine