Business Process Status

Business Process can have one of the following status.

scheduled: The Business Process is scheduled and will be executed at its scheduled time.
in-progress: The Business Process is active, and some or all of its associated actions have a status of "in-progress".
resolved: The Business Process has been successfully completed, indicating that the status of all associated actions is also marked as "resolved".
failed: The Business Process has not been successfully completed, which means that the status of some or all of its associated actions is marked as "failed".

When the status of a Business Process is mutated using the update Business Process endpoint, status of all "in-progress" actions will be marked as "failed".

⌛️
Scheduled

We can schedule a Business Process for a specific date and time using the scheduled field when creating a Business Process.

Note that, in some cases, it may take an additional 15 to 20 minutes for the Business Process to execute after the proposed scheduled time.

A scheduled Business Process does not initialize until the defined time. Therefore, Customer information required for the Business Process can be provided to the system while the Business Process is scheduled and will be utilized when it starts.

⌛️
Expiration

We can set an expiration date for a Business Process using the expiration field when creating a Business Process. The expiration period is calculated from the Business Process's creation time, with a default value of 45 days (45d).

In the case of a scheduled Business Process, the expiration time is calculated from the Business Process's scheduled time.

Note that, in some cases, it may take an additional 15 to 20 minutes for the Business Process to expire the Business Process after the proposed expiration time.

When the expiration occurs, the status of the Business Process is set to "failed" and the statusReason is updated to "expired".

statusReason

A Business Process can have one of the following statusReason.

by-Merchant: If a Business Process status is mutated using the update Business Process endpoint.
by-user: If a Business Process is executed using the natural/conventional flow by the user or Customer.
expired: If expiration is set on the Business Process and expiration occurs.