Return lifecycle

Learn about the lifecycle of a return in Numeral

Events are created as returns are created or updated in Numeral. An update can be the update of any attribute, such as a status, a date, or any other data. Learn more about events and webhooks in Numeral.

Events

Event Description
pending_approvalReturn has been created and is pending approval.
approvedReturn has been approved.
auto_approvedReturn has been automatically approved.
canceledReturn has been canceled.
processingReturn is being processed and has been added to a file.
sentReturn has been sent to the bank.
executedReturn has been executed by the bank.
receivedReturn has been received from the bank.
rejectedReturn has been rejected.
pending_retryReturn file file has been rejected by the bank. The return will be sent in a new file.
retriedReturn has been sent in a new file.
reconciledReturn has been reconciled with a transaction.
partially_reconciledReturn has been partially reconciled with a transaction.
unreconciledReturn has been unreconciled.

Statuses

Status Description
pending_approvalReturn has been created and is pending approval.
approvedReturn has been approved.
auto_approvedReturn has been automatically approved.
canceledReturn has been canceled.
processingReturn is being processed and has been added to a file.
sentReturn has been sent to the bank.
executedReturn has been executed by the bank.
receivedReturn has been received from the bank. This is the initial status for a return linked to a payment order.
rejectedReturn has been rejected.

State machine