Statuses description
Statuses are a key component of the API. A request will either have one of three statuses: Accepted
, InProgress
, Finished
. Within a request, each task will have a status and status code. Therefore, a request has a status and each task has its own status.
Request
Below are the status descriptions specifically for the request’s status. A request is the main item of workflow and understanding the status flow is important. In a simple view all requests always have this flow: Accepted -> InProgress -> Finished
.
Accepted
This status assigned to request if the request is successful and passed all incoming checks such as partner checks, signature checks, security checks, finance checks etc. After all checks, the system accepts the request for processing and assigns the status Accepted
to the request. At this stage, we understand which processing block will initially process the request and apply all required internal tasks for successful processing resources.
InProgress
As soon as the request is accepted on the previous stage, the processing block starts processing the request and the internal system assigns status InProgress
to the request. This status means that the processing block is now working on the request. Remember, that each request can contain a task list, and processing flow can be complex with multiple tasks.
Finished
This status assigned to the request when the request is complete and there are no more tasks which require processing.
Important to note, that status Finished
don’t mean that all task was successfully finished. This status means only all work finished. For understanding success or fail of each task, please see the task status section.
Task
As outlined previously, each request contains a list of tasks To simplify, each task status flow can be one of the below:
Accepted -> InProgress -> Success
Accepted -> InProgress -> Error
Accepted -> Error
Accepted
All tasks are instantly assigned this status as soon as the request is assigned the Accepted
status.
After this status is assigned, the processing block starts step-by-step request processing from layer 0 to the end of each tree.
InProgress
When the processing block starts processing a task the InProgress
status is assigned to the task and the processing procedures for this task begins.
Success
This status indicates that the task aim was achieved and all required processing actions were successful.
Error
This status indicates that task didn't achieve its aim and the processing mechanism incurred an error during the processing of the task. Error code and message will be additionally specified in the result object for this task.
List of error codes can be found here: Processing error codes
Task result codes
Code | Description |
---|---|
0 | Task is in Accepted status. |
1 | Task is in InProgress status. |
2 | Task is in Success status. |
3 | Task is in Error status. List of error codes can be found here: Processing error codes |
5 | Task is waiting manual actions but is in Error status. |
A manual action is required to clarify information or to continue to process the requested task. For example, if the system identifies a potential match against a sanctions list check the Error status with code 5 with be applied. The transaction is not declined but the task is processed manually. The result of manual action can be received as a result of task.statusGet
function.