@codat/bank-feeds

Bank Feeds

Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms.

Summary

Bank Feeds API: Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting software.

A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting software.

Explore product | See OpenAPI spec

---

Endpoints

Endpoints	Description
Companies	Create and manage your SMB users' companies.
Connections	Create new and manage existing data connections for a company.
Source accounts	Provide and manage lists of source bank accounts.
Account mapping	Extra functionality for building an account management UI.
Company information	Get detailed information about a company from the underlying platform.
Transactions	Create new bank account transactions for a company's connections, and see previous operations.

Table of Contents

• Bank Feeds
  • Endpoints
  • SDK Installation
  • Example Usage
  • SDK Example Usage
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Requirements
  • Standalone functions
  • File uploads
  • Debugging
  • Support

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @codat/bank-feeds

PNPM

pnpm add @codat/bank-feeds

Bun

bun add @codat/bank-feeds

Yarn

yarn add @codat/bank-feeds zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Example Usage

SDK Example Usage

Example

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

const codatBankFeeds = new CodatBankFeeds();

async function run() {
  await codatBankFeeds.clientRateLimitReached({
    id: "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
    eventType: "client.rateLimit.reached",
    generatedDate: "2024-09-01T00:00:00Z",
    payload: {
      dailyQuota: 12000,
      quotaRemaining: 0,
      expiryDate: "2024-09-01T12:14:14Z",
    },
  });
}

run();

Available Resources and Operations

Available methods

accountMapping

• get - List bank feed accounts
• create - Create bank feed account mapping

bankAccounts

• list - List bank accounts
• getCreateModel - Get create/update bank account model
• create - Create bank account

companies

• create - Create company
• list - List companies
• get - Get company
• delete - Delete a company
• update - Update company
• getAccessToken - Get company access token

companyInformation

• get - Get company information

configuration

• get - Get configuration
• set - Set configuration

connections

• list - List connections
• create - Create connection
• get - Get connection
• delete - Delete connection
• unlink - Unlink connection

sourceAccounts

• createBatch - Create source accounts
• create - Create single source account
• list - List source accounts
• update - Update source account
• delete - Delete source account
• generateCredentials - Generate source account credentials
• deleteCredentials - Delete all source account credentials

sync

• getLastSuccessfulSync - Get last successful sync

transactions

• create - Create bank transactions
• getCreateModel - Get create bank transactions model
• getCreateOperation - Get create operation
• listCreateOperations - List create operations

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

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

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

async function run() {
  const result = await codatBankFeeds.companies.create({
    name: "Technicalium",
    description: "Requested early access to the new financing scheme.",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

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

const codatBankFeeds = new CodatBankFeeds({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatBankFeeds.companies.create({
    name: "Technicalium",
    description: "Requested early access to the new financing scheme.",
  });

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the sdk/models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the create method may throw the following errors:

Error Type	Status Code	Content Type
errors.ErrorMessage	400, 401, 402, 403, 429, 500, 503	application/json
errors.SDKError	4XX, 5XX	*/*

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { CodatBankFeeds } from "@codat/bank-feeds";
import {
  ErrorMessage,
  SDKValidationError,
} from "@codat/bank-feeds/sdk/models/errors";

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

async function run() {
  let result;
  try {
    result = await codatBankFeeds.companies.create({
      name: "Technicalium",
      description: "Requested early access to the new financing scheme.",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof ErrorMessage): {
        // Handle err.data$: ErrorMessageData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the sdk/models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

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

const codatBankFeeds = new CodatBankFeeds({
  serverURL: "https://api.codat.io",
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatBankFeeds.companies.create({
    name: "Technicalium",
    description: "Requested early access to the new financing scheme.",
  });

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

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

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CodatBankFeeds({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
authHeader	apiKey	API key

To authenticate with the API the authHeader parameter must be set when initializing the SDK client instance. For example:

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

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

async function run() {
  const result = await codatBankFeeds.companies.create({
    name: "Technicalium",
    description: "Requested early access to the new financing scheme.",
  });

  // Handle the result
  console.log(result);
}

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• accountMappingCreate - Create bank feed account mapping
• accountMappingGet - List bank feed accounts
• bankAccountsCreate - Create bank account
• bankAccountsGetCreateModel - Get create/update bank account model
• bankAccountsList - List bank accounts
• companiesCreate - Create company
• companiesDelete - Delete a company
• companiesGet - Get company
• companiesGetAccessToken - Get company access token
• companiesList - List companies
• companiesUpdate - Update company
• companyInformationGet - Get company information
• configurationGet - Get configuration
• configurationSet - Set configuration
• connectionsCreate - Create connection
• connectionsDelete - Delete connection
• connectionsGet - Get connection
• connectionsList - List connections
• connectionsUnlink - Unlink connection
• sourceAccountsCreate - Create single source account
• sourceAccountsCreateBatch - Create source accounts
• sourceAccountsDelete - Delete source account
• sourceAccountsDeleteCredentials - Delete all source account credentials
• sourceAccountsGenerateCredentials - Generate source account credentials
• sourceAccountsList - List source accounts
• sourceAccountsUpdate - Update source account
• syncGetLastSuccessfulSync - Get last successful sync
• transactionsCreate - Create bank transactions
• transactionsGetCreateModel - Get create bank transactions model
• transactionsGetCreateOperation - Get create operation
• transactionsListCreateOperations - List create operations

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { CodatBankFeeds } from "@codat/bank-feeds";
import { openAsBlob } from "node:fs";

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

async function run() {
  const result = await codatBankFeeds.sourceAccounts.generateCredentials({
    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    requestBody: await openAsBlob("example.file"),
  });

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

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

const sdk = new CodatBankFeeds({ debugLogger: console });

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy