API Guide
Log In
API Guide

Connect

Calling Connect with a valid organisation ID will return a response containing a url for you to redirect the user to the UI to allow them to connect their bank accounts.

You must provide a returnUrl query parameter which will be used to redirect the user back to your system on completion of the checkout process. The returnUrl will have:

  • The user's ID appended using the user-id query parameter.
  • The bank accounts' IDs appended using the bank-account-ids parameter.
    • The bank account IDs returned are limited to 10 so that that we minimise any risk of exceeding query string limits.

Calling Connect with a valid organisation ID will return a response containing a url for you to redirect the user to the UI to allow them to connect their bank accounts.

You must provide a returnUrl query parameter which will be used to redirect the user back to your system on completion of the checkout process

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!