Monitoring the Default Import status
1. Initiate Command
Initiate the Default Import command /v1/default-import.xml, which will begin the import process.
It’s important to call this command immediately after receiving the sessionId and sessionIdSignature. You can call this command only once per session - if the command fails at any point, you have to create a new session (ask the user to log in again).
2. Polling for Status
Once the command is initiated, you need to monitor its status. You can do this by periodically querying the Get Import Result endpoint - /v1/command/{id}.xml endpoint, where {id} is the identifier of the command you received when starting the import.
We recommend polling every 2-5 seconds until a final state is received. This ensures that you get timely updates without overwhelming the system.
In the response you will receive one of the command states: setup, in_progress, successful, error or fatal.
If the state was setup or in_progress, continue with the polling loop, otherwise, please see the next section.
3. Handle the Final Status
Once the command reaches a final state, act accordingly:
- successful: The import was successful, and the result is available for further processing. This is the time when you may ask for additional calculations like:
- error: The command failed due to a known issue. Handle the error based on its description in the “Error Handling” section of our technical documentation.
- fatal: The command failed due to an unexpected issue. This may require logging the error and notifying the support team.
Default Import command. After the Default Import command is completed, the user is automatically signed out of the bank’s transaction system. This means that you cannot make any additional imports in the same session.Score, wait for status successful before proceeding, and ensure the workflow stops if an error or fatal status occurs.
