Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Mock Bank API Specification

Background: The mock bank let’s you test the import workflow by using bank slug MockBank. It does however not create any data.

Introduction

The Mock Bank API provides simulations of some bank-communications issues for development and testing purposes. This specification document outlines the API endpoints, authentication process, bank connection process, error handling, and other important information that developers need to interact with the Mock Bank API.

...

  • AUTHENTICATED: Successful authentication with the username "tester" and password "success".

  • AUTHENTICATION_FAILED: Failed authentication with the username "tester" and any password not defined in the other use cases.

  • CHALLENGE_RESPONSE_REQUIRED: Successful authentication with challenge required for username "tester" and password "challengeRequired".

  • DECOUPLED_AUTH_REQUIRED: Successful authentication with decoupled auth required for username "tester" and password "decoupledAuthRequired".

  • REDIRECT_REQUIRED: Successful authentication with decoupled auth required for username "tester" and password "redirectRequired".

  • AUTHENTICATED: Successful authentication that will trigger a bank connection import error for "tester" and password "bankConnectionError".

Resolving DECOUPLED_AUTH_REQUIRED status

You can provide additional password for resolving DECOUPLED_AUTH_REQUIRED status

  • decoupledAuthRequiredSuccess will resolve in AUTHENTICATED status in 2 seconds

  • decoupledAuthRequiredError will resolve in AUTHENTICATION_FAILED status in 2 seconds

Bank Connection

To create a bank connection using the Mock Bank API, follow these steps:

...