Bank Feeds
Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms.
SDK Installation
NPM
npm add @codat/bank-feedsYarn
yarn add @codat/bank-feedsExample Usage
SDK Example Usage
Example
import { CodatBankFeeds } from "@codat/bank-feeds";
async function run() {
const sdk = new CodatBankFeeds({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companies.create({
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
});
if (res.statusCode == 200) {
// handle response
}
}
run();Available Resources and Operations
companies
- create - Create company
- delete - Delete a company
- get - Get company
- list - List companies
- update - Update company
connections
- create - Create connection
- delete - Delete connection
- get - Get connection
- list - List connections
- unlink - Unlink connection
accountMapping
sourceAccounts
- create - Create source account
- delete - Delete source account
- deleteCredentials - Delete all source account credentials
- generateCredentials - Generate source account credentials
- list - List source accounts
- update - Update source account
bankAccounts
- create - Create bank account
- getCreateModel - Get create/update bank account model
- list - List bank accounts
transactions
- create - Create bank transactions
- getCreateOperation - Get create operation
- listCreateOperations - List create operations
configuration
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";
async function run() {
const sdk = new CodatBankFeeds({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companies.create(
{
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
},
{
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
}
);
if (res.statusCode == 200) {
// handle response
}
}
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";
async function run() {
const sdk = new CodatBankFeeds({
retry_config: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companies.create({
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
});
if (res.statusCode == 200) {
// handle response
}
}
run();Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.SDKError | 4xx-5xx | / |
Example
import { CodatBankFeeds } from "@codat/bank-feeds";
async function run() {
const sdk = new CodatBankFeeds({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
let res;
try {
res = await sdk.companies.create({
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
});
} catch (err) {
if (err instanceof errors.SDKError) {
console.error(err); // handle exception
throw err;
}
}
if (res.statusCode == 200) {
// handle response
}
}
run();Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://api.codat.io |
None |
Example
import { CodatBankFeeds } from "@codat/bank-feeds";
async function run() {
const sdk = new CodatBankFeeds({
serverIdx: 0,
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companies.create({
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
});
if (res.statusCode == 200) {
// handle response
}
}
run();Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:
import { CodatBankFeeds } from "@codat/bank-feeds";
async function run() {
const sdk = new CodatBankFeeds({
serverURL: "https://api.codat.io",
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companies.create({
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
});
if (res.statusCode == 200) {
// handle response
}
}
run();Custom HTTP Client
The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.
For example, you could specify a header for every request that your sdk makes as follows:
import { @codat/bank-feeds } from "CodatBankFeeds";
import axios from "axios";
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new CodatBankFeeds({defaultClient: httpClient});Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
authHeader |
apiKey | API key |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:
import { CodatBankFeeds } from "@codat/bank-feeds";
async function run() {
const sdk = new CodatBankFeeds({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.companies.create({
description: "Requested early access to the new financing scheme.",
groups: [
{
id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
},
],
name: "Bank of Dave",
});
if (res.statusCode == 200) {
// handle response
}
}
run();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.