Handle users coming back to your interface

When users are redirected to your predefined redirect URI after completing (or abandoning) the Open Banking (OB) journey, Algoan appends a query parameter to help you interpret the result.

Query parameterMeaningRecommended action
status=successThe user successfully completed the OB journey.Show a success UI. Wait for the analysis to complete before fetching transaction data (listen to analysis_completed webhook or poll analysis).
status=errorThe user reached an error during OB.Show an error UI and offer a retry (start a new session) or alternative.
status=session_expiredThe session expired before completion.Create a new session and redirect again for the user to retry.
status=user_cancelledThe user voluntarily left the OB journey.You can offer the user a retry or an alternative experience.
  • A success status does not guarantee analysis data is ready — the aggregation may be complete, but the analysis runs asynchronously. Use the webhook on the Fetch analysis page to know when data is ready. You may show a “Processing…” screen while waiting for analysis. When the analysis_completed webhook arrives, proceed to fetch results.

  • In case of error status, you can check the session to understand the error and decide whether or not you want to offer a retry to the user.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
  Last updated