Get started with Bank Feeds API

Understand the basics of using Bank Feeds API and learn how to perform the initial setup for the product

Journey overview

The diagram below represents the overall activity flow when using Bank Feeds API, including your SMB customer and their accounting software. It assumes you are using Codat's mapping interface to let the user select the accounts used for writing bank statements.

If you are using one of the other mapping UI options, you can visualize the flow by simply changing the actor of the mapping operation from Codat to Your application or Accounting software.

Once you decide to build this flow with Bank Feeds API, you need to configure Codat accordingly. Let's go through these requirements in detail.

Enable Bank Feeds API

Reach out to your Codat account manager to enable Bank Feeds API for your client.

Manage data sources

In the Codat Portal, navigate to Settings > Integrations and click Manage integrations. Next, click Manage next to the specific integration you want to enable and set it up to serve as a data source for the product.

QuickBooks Online bank feeds

US

Canada

Oracle NetSuite bank feeds

Sage bank feeds

Xero bank feeds

FreeAgent bank feeds

Exact Online (NL) bank feeds

Some of these integrations require additional setup specific to bank feeds. We walk you through these in our integration-specific instructions in the Manage integrations section of our Bank Feeds API documentation.

Authorization flow

As part of using Bank Feeds API, you will need your customers to authorize your access to their data. To do so, use Link - our pre-built, embeddable, conversion-optimized, and white-labeled authorization flow.

The solution lets you tailor the authorization journey to your business needs. You can:

• Customize Link settings.
• Set up company branding.
• Set up redirects.

Webhooks

Codat supports a range of webhook events to help you manage your data pipelines. In the Codat Portal, navigate to Settings > Webhooks > Configure consumer and click Add endpoint to set up an endpoint to listen to the following event type and get the most out of Bank Feeds API:

• PushOperationStatusChanged

  Use this webhook to track the completion of the operation to create bank transactions in the target platform. When you receive a notification from this webhook, check the status value in the body. A Success status means the transactions array has been successfully written to the accounting software. In case of errors, resolve the issue and resend the payload.

Client libraries

Frontend

Our low-code Bank Feeds SDK lets you build a seamless, high-converting user experience, embedded right within your front-end application.

NPM

npm add @codat/sdk-bank-feeds-types

Yarn

yarn add @codat/sdk-bank-feeds-types

Read more...

Backend

For your bankend services, use our comprehensive Bank Feeds API library to kick-start and simplify your build. Simply install the library in one of the supported languages and pass your base64-encoded API key to the constructor.

TypeScript

Install

NPM

npm add @codat/bank-feeds

Yarn

yarn add @codat/bank-feeds

Initialize

import { CodatBankFeeds } from "@codat/bank-feeds";

const bankFeedsClient = new CodatBankFeeds({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

Python

Install

pip install codat-bankfeeds

Initialize

import codatbankfeeds
from codatbankfeeds.models import shared

bank_feeds_client = codatbankfeeds.CodatBankFeeds(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
)

C#

Install

dotnet add package Codat.BankFeeds

Initialize

using Codat.BankFeeds;
using Codat.BankFeeds.Models.Shared;

var bankFeedsClient = new CodatBankFeeds(
    security: new Security() {
        AuthHeader = "Basic BASE_64_ENCODED(API_KEY)",
    }
);

Go

Install

go get github.com/codatio/client-sdk-go/bank-feeds

Initialize

import (
	"context"
	bankfeeds "github.com/codatio/client-sdk-go/bank-feeds/v4"
	"github.com/codatio/client-sdk-go/bank-feeds/v4/pkg/models/shared"
	"log"
)

func main() {
  bankfeedsClient := bankfeeds.New(
      bankfeeds.WithSecurity(shared.Security{
        AuthHeader: "Basic BASE_64_ENCODED(API_KEY)",
      }),
    )
}

Recap

You have enabled Bank Feeds API, set up the relevant integrations, configured auth flow parameters, and noted the recommended webhook. This completes the initial setup of the product.

Next, you will create a Codat company, its connection, and a source bank account to build out the core infrastructure required to establish a bank feed.

---

Read next

• Create the key elements of the Codat infrastructure required to establish a bank feed.