Skip to content

Latest commit

 

History

History

README.md

Banking

Use Codat's API to connect to your SMB customer's banks and pull up-to-date standardized account and transaction data from their bank accounts via our partner providers.

SDK Installation

NPM

npm add @codat/banking

Yarn

yarn add @codat/banking

Example Usage

import { CodatBanking } from "@codat/banking";

(async () => {
    const sdk = new CodatBanking({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.accountBalances.list({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
        orderBy: "-modifiedDate",
        page: 1,
        pageSize: 100,
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

Available Resources and Operations

  • list - List account balances
  • get - Get account
  • list - List accounts
  • get - Get transaction category
  • list - List transaction categories
  • get - Get bank transaction
  • list - List transactions
  • listBankTransactions - List banking transactions ⚠️ Deprecated Use list instead.

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