API Guide
Log In
API Guide

Bank account basics

Learn how to securely link and manage bank accounts for your organisations using Crezco's API.

πŸ”— What is a bank connection?

A bank connection links a specific bank account to an organisation via secure Open Banking. This enables your platform to request the authorisation of payments from that account and fetch account information. Organisations can add multiple connections - ideal for managing a range of accounts.

πŸ–₯️ Hosted bank connection flow

To make integrating with Crezco’s API easier, we provide a hosted bank connection flow, accessible via the GET /organisations/{organisationId}/connect endpoint. This endpoint returns a URL which users can access to connect a bank account. This account can then be used as a source of funds for making payments.

You can provide users with the option to repeatedly access this flow if they wish to add more bank accounts in the future. We publish webhooks notifying your system of changes in the connected banks.

We recommend calling this endpoint each time you initiate a connect flow for the user.

Within this flow, users can:

  • Select a bank to connect
  • Authorise the connection with their bank

Why use it?

  • Speed of integration: instant set‑up without the need to build flows and open banking integrations
  • Robust security & compliance: handled by Crezco with full PSD2 compliance
  • Scalable experience: supports multiple bank connections and asynchronous flows

πŸ“¨ Fetching connected bank details

Once a bank account has been connected you're able to fetch the details of the connected account by calling the GET /organisations/{organisationId}/bank-accounts endpoint

This returns the details and IDs of each connected bank account which can be used to display back information to the user in your own UI and to specify the source of the payments when creating a pay run

πŸ§ͺ Connecting test bank accounts

We appreciate you might not want to connect a real bank account when building and testing your integration which is why Crezco offer test bank accounts.