npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@oatfi/oatfi-sdk-ts

v0.11.55

Published

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *oat-fi-sdk* API.

Downloads

840

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

john_oatfijohn_oatfiandres.mataandres.mataaloaiza-oatfialoaiza-oatfi

Keywords

Readme

oat-fi-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage oat-fi-sdk API.

Summary

Oatfi API: Working Capital Infrastructure for B2B Payments

Table of Contents

SDK Installation

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

NPM

npm add @oatfi/oatfi-sdk-ts

PNPM

pnpm add @oatfi/oatfi-sdk-ts

Bun

bun add @oatfi/oatfi-sdk-ts

Yarn

yarn add @oatfi/oatfi-sdk-ts

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = await OatFiSDK.initialize({
  apiKey: config.apiKey
});

async function run() {
  const result = await oatFiSDK.businesses.list({ limit: 20 });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ---- | ----------- | -------------------- | | bearer | http | HTTP Bearer | OATFISDK_BEARER |

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

import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = await OatFiSDK.initialize({
  apiKey: config.apiKey
});

async function run() {
  const result = await oatFiSDK.applications.create({
    idempotencyKey: "<value>",
    createApplicationDto: {
      platform: "<value>",
      businessInformation: {
        name: "Acme Corp",
        externalId: "biz_123abc",
        dbaName: "Acme Innovations",
        taxId: "123456789",
        businessEntityType: "corporation",
        stateOfIncorporation: "CA",
        dateEstablished: "2020-01-15",
        physicalAddress: {
          line1: "123 Main St",
          line2: "Apt 4B",
          city: "San Francisco",
          state: "CA",
          postalCode: "94107",
        },
        contactPhone: "555-123-4567",
        contactEmail: "[email protected]",
        industryType: "541511",
        businessDescription: "Software development services",
        websiteUrl: "https://acme.com",
        mailingAddress: {
          line1: "123 Main St",
          line2: "Apt 4B",
          city: "San Francisco",
          state: "CA",
          postalCode: "94107",
        },
      },
      personsInformation: [
        {
          externalId: "person_ext_123",
          firstName: "John",
          lastName: "Doe",
          title: "CEO",
          email: "[email protected]",
          phone: "555-0101",
          dateOfBirth: "1985-07-22",
          address: {
            line1: "123 Main St",
            line2: "Apt 4B",
            city: "San Francisco",
            state: "CA",
            postalCode: "94107",
          },
          relationshipToBusiness: "Owner",
          isControlPerson: false,
          ownershipPercentage: 25,
          kycStatus: "NOT_STARTED",
          ssn: "123-45-6789",
        },
      ],
      expectedUsage: {
        expectedMonthlyPaymentsVolumeRange: "100,001-500,000",
        operationalCountries: [
          "US",
          "CA",
        ],
        customerTypes: [
          "B2C",
          "B2B",
        ],
        fundsTransferCountries: [
          "US",
          "MX",
        ],
        restrictedActivities: {},
      },
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

AcceptanceTerms

  • create - Create a new underwriting terms acceptance record
  • getAll - Get underwriting terms acceptance records

ApplicationFiles

  • upload - Upload files for a specific application
  • list - List files for a specific application
  • get - Get a file by ID for a specific application
  • update - Update a file for a specific application
  • delete - Delete a file for a specific application
  • download - Download a file for a specific application

Applications

  • create - Create a new application
  • list - List all applications
  • get - Retrieve an application by ID
  • update - Update an application by ID
  • submit - Submit application for processing
  • approve - Approve application directly
  • getTransactionsReportUrl - Get transactions report URL for an application

Authentication

Businesses

BusinessFiles

  • upload - Upload files for a specific business
  • list - List files for a specific business
  • get - Get a file by ID for a specific business
  • update - Update a file for a specific business
  • delete - Delete a file for a specific business
  • download - Download a file for a specific business

BusinessFinancialAccounts

  • create - Create a new financial account for a business
  • list - List all financial accounts for a business
  • get - Get a financial account by ID for a business
  • update - Update a financial account for a business
  • delete - Delete a financial account by ID for a business

BusinessHolds

  • create - Create a hold for a business
  • list - List holds for a business
  • get - Get a hold by ID for a business
  • update - Update a hold for a business
  • release - Release a hold by ID for a business

BusinessPersons

  • create - Create a new person for a business
  • list - List all persons for a business
  • get - Get a person by ID for a business
  • update - Update a person for a business
  • delete - Delete a person by ID for a business

BusinessPlaidTokens

  • create - Create a new Plaid token for a business
  • list - List all Plaid tokens for a business
  • getLinkToken - Get Plaid link token for a business
  • exchangeToken - Exchange Plaid public token for access token
  • get - Get a Plaid token by ID for a business
  • update - Update a Plaid token for a business
  • delete - Delete a Plaid token by ID for a business

Embed

Files

FinancialAccounts

  • list - List all financial accounts
  • get - Get a financial account by ID
  • update - Update a financial account
  • delete - Delete a financial account by ID

Holds

IncreaseTransactions

  • list - List increase transactions

Originations

PaymentIntents

  • create - Create a new Payment Intent
  • getAll - List all Payment Intents
  • createBulk - Create multiple Payment Intents in bulk
  • search - Search for Payment Intents
  • get - Retrieve a Payment Intent by ID
  • update - Update a Payment Intent by ID
  • delete - Delete a Payment Intent by ID
  • getBalance - Get Payment Intent Balance
  • getBalanceByProgram - Get Payment Intent Balance by Program

Payments

  • create - Create a new payment
  • get - Get a payment by ID
  • update - Update a payment by ID

Persons

PlaidTokens

  • getById - Get a Plaid token by ID
  • update - Update a Plaid token
  • delete - Delete a Plaid token by ID

PlatformApiKeys

  • create - Create API keys for a platform
  • list - Get API keys by platform ID
  • get - Get API key by ID for a platform
  • delete - Delete API key
  • getByEnvironment - Get API keys for specific environment
  • rotate - Rotate API keys for specific environment
  • regenerate - Regenerate API keys for specific environment
  • updateViewDate - Update API key view date for specific environment

PlatformComponents

  • get - Get platform components

PlatformFinancialAccounts

  • create - Create a new financial account for a platform
  • list - List all financial accounts for a platform
  • get - Get a financial account by ID for a platform
  • update - Update a financial account for a platform
  • delete - Delete a financial account by ID for a platform

Platforms

  • create - Create a new platform
  • list - List all platforms
  • search - Search platforms
  • get - Get a platform by ID
  • getScopes - Get a platform's assigned scopes
  • updateScopes - Update a platform's assigned scopes

PlatformSettings

  • create - Create platform settings
  • getOne - Get platform settings
  • update - Update platform settings

Programs

  • create - Create a new program
  • list - List all programs
  • get - Get a program by ID
  • update - Update a program
  • delete - Delete a program

ProgramSettings

  • create - Create a new program setting
  • list - List all settings for a program
  • get - Get a specific program setting
  • update - Update a program setting
  • delete - Delete a program setting
  • activate - Activate a program setting
  • deactivate - Deactivate a program setting

UnderwritingTerms

  • getHtml - Get underwriting terms HTML

Users

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.

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = new OatFiSDK({
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  const result = await oatFiSDK.businesses.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

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 { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = new OatFiSDK({
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  const result = await oatFiSDK.files.upload({
    idempotencyKey: "<value>",
    uploadFilesDto: {
      files: [],
      resourceType: "business",
      resourceId: "507f1f77bcf86cd799439012",
      fileType: "bank_statement",
      description: "January 2024 bank statement for business account",
      metadata: {
        "uploaded_by": "user123",
        "verification_status": "pending",
      },
    },
  });

  console.log(result);
}

run();

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 { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = new OatFiSDK({
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  const result = await oatFiSDK.businesses.create({
    idempotencyKey: "<value>",
    createBusinessDto: {
      externalId: "ext_123456",
      name: "Acme Corporation",
      dbaName: "Acme",
      taxId: "123456789",
      address: {
        line1: "123 Main St",
        line2: "Suite 100",
        city: "San Francisco",
        state: "CA",
        postalCode: "94105",
      },
      contactFirstName: "John",
      contactLastName: "Doe",
      contactEmail: "[email protected]",
      contactPhone: "+14155552671",
      businessStartDateYear: "2020",
      application: "507f1f77bcf86cd799439011",
      users: [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012",
      ],
      primaryUser: "507f1f77bcf86cd799439011",
      achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
      webhookUrl: "https://my.webhook.com/post",
      plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
      plaidTokens: [
        {
          alias: "Default Token",
          token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
        },
      ],
      heronId: "heron_123456",
      paymentSettings: [
        {
          partner: "62eaf2133147bd1b70da07d2",
          business: "62eaf2133147bd1b70da07d2",
          data: {
            accountId: "acct_1J876rQjaww8b42s",
            customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
            paymentMethodId: "pm_ssej45jawghghw8b42s",
            accountNumber: "21565234545",
            routingNumber: "1572515454",
            directDebitAuthorization:
              "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
            fundingSourceId:
              "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
            moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
            unitAccountId: "21565234545",
            swiftCode: "1572515454",
            remittanceInformation: "Payment for {year}-{month}-{day}",
            businessId: "biz_456",
            lockboxAddress: "123 Main St",
            accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
            oatfiAccountNumber: "21565234545",
            oatfiRoutingNumber: "21565234545",
          },
          scheduledRepayment: false,
          isDefault: true,
          type: "UNIT",
        },
      ],
      codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
      consumerInvoices: false,
      requestedCreditLimit: 10000,
      metadata: {
        mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
        avgMonthlySpend: "10000",
        orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
        requestedCreditLimit: 10000,
        plaidData: "{\"accounts\":[...],\"institution\":{...}}",
      },
    },
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  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 { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = new OatFiSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  const result = await oatFiSDK.businesses.create({
    idempotencyKey: "<value>",
    createBusinessDto: {
      externalId: "ext_123456",
      name: "Acme Corporation",
      dbaName: "Acme",
      taxId: "123456789",
      address: {
        line1: "123 Main St",
        line2: "Suite 100",
        city: "San Francisco",
        state: "CA",
        postalCode: "94105",
      },
      contactFirstName: "John",
      contactLastName: "Doe",
      contactEmail: "[email protected]",
      contactPhone: "+14155552671",
      businessStartDateYear: "2020",
      application: "507f1f77bcf86cd799439011",
      users: [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012",
      ],
      primaryUser: "507f1f77bcf86cd799439011",
      achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
      webhookUrl: "https://my.webhook.com/post",
      plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
      plaidTokens: [
        {
          alias: "Default Token",
          token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
        },
      ],
      heronId: "heron_123456",
      paymentSettings: [
        {
          partner: "62eaf2133147bd1b70da07d2",
          business: "62eaf2133147bd1b70da07d2",
          data: {
            accountId: "acct_1J876rQjaww8b42s",
            customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
            paymentMethodId: "pm_ssej45jawghghw8b42s",
            accountNumber: "21565234545",
            routingNumber: "1572515454",
            directDebitAuthorization:
              "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
            fundingSourceId:
              "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
            moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
            unitAccountId: "21565234545",
            swiftCode: "1572515454",
            remittanceInformation: "Payment for {year}-{month}-{day}",
            businessId: "biz_456",
            lockboxAddress: "123 Main St",
            accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
            oatfiAccountNumber: "21565234545",
            oatfiRoutingNumber: "21565234545",
          },
          scheduledRepayment: false,
          isDefault: true,
          type: "UNIT",
        },
      ],
      codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
      consumerInvoices: false,
      requestedCreditLimit: 10000,
      metadata: {
        mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
        avgMonthlySpend: "10000",
        orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
        requestedCreditLimit: 10000,
        plaidData: "{\"accounts\":[...],\"institution\":{...}}",
      },
    },
  });

  console.log(result);
}

run();

Error Handling

OatFiSDKError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";
import * as errors from "@oatfi/oatfi-sdk-ts/models/errors";

const oatFiSDK = new OatFiSDK({
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  try {
    const result = await oatFiSDK.businesses.create({
      idempotencyKey: "<value>",
      createBusinessDto: {
        externalId: "ext_123456",
        name: "Acme Corporation",
        dbaName: "Acme",
        taxId: "123456789",
        address: {
          line1: "123 Main St",
          line2: "Suite 100",
          city: "San Francisco",
          state: "CA",
          postalCode: "94105",
        },
        contactFirstName: "John",
        contactLastName: "Doe",
        contactEmail: "[email protected]",
        contactPhone: "+14155552671",
        businessStartDateYear: "2020",
        application: "507f1f77bcf86cd799439011",
        users: [
          "507f1f77bcf86cd799439011",
          "507f1f77bcf86cd799439012",
        ],
        primaryUser: "507f1f77bcf86cd799439011",
        achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
        webhookUrl: "https://my.webhook.com/post",
        plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
        plaidTokens: [
          {
            alias: "Default Token",
            token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
          },
        ],
        heronId: "heron_123456",
        paymentSettings: [
          {
            partner: "62eaf2133147bd1b70da07d2",
            business: "62eaf2133147bd1b70da07d2",
            data: {
              accountId: "acct_1J876rQjaww8b42s",
              customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
              paymentMethodId: "pm_ssej45jawghghw8b42s",
              accountNumber: "21565234545",
              routingNumber: "1572515454",
              directDebitAuthorization:
                "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
              fundingSourceId:
                "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
              moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
              unitAccountId: "21565234545",
              swiftCode: "1572515454",
              remittanceInformation: "Payment for {year}-{month}-{day}",
              businessId: "biz_456",
              lockboxAddress: "123 Main St",
              accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
              oatfiAccountNumber: "21565234545",
              oatfiRoutingNumber: "21565234545",
            },
            scheduledRepayment: false,
            isDefault: true,
            type: "UNIT",
          },
        ],
        codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
        consumerInvoices: false,
        requestedCreditLimit: 10000,
        metadata: {
          mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
          avgMonthlySpend: "10000",
          orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
          requestedCreditLimit: 10000,
          plaidData: "{\"accounts\":[...],\"institution\":{...}}",
        },
      },
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.OatFiSDKError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

Network errors:

Inherit from OatFiSDKError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

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 | Description | | --- | --------------------------- | ----------- | | 0 | https://dev.api.oatfi.com | Development | | 1 | https://api.oatfi.com | Production | | 2 | https://stg.api.oatfi.com | Staging |

Example

import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = new OatFiSDK({
  serverIdx: 0,
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  const result = await oatFiSDK.businesses.create({
    idempotencyKey: "<value>",
    createBusinessDto: {
      externalId: "ext_123456",
      name: "Acme Corporation",
      dbaName: "Acme",
      taxId: "123456789",
      address: {
        line1: "123 Main St",
        line2: "Suite 100",
        city: "San Francisco",
        state: "CA",
        postalCode: "94105",
      },
      contactFirstName: "John",
      contactLastName: "Doe",
      contactEmail: "[email protected]",
      contactPhone: "+14155552671",
      businessStartDateYear: "2020",
      application: "507f1f77bcf86cd799439011",
      users: [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012",
      ],
      primaryUser: "507f1f77bcf86cd799439011",
      achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
      webhookUrl: "https://my.webhook.com/post",
      plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
      plaidTokens: [
        {
          alias: "Default Token",
          token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
        },
      ],
      heronId: "heron_123456",
      paymentSettings: [
        {
          partner: "62eaf2133147bd1b70da07d2",
          business: "62eaf2133147bd1b70da07d2",
          data: {
            accountId: "acct_1J876rQjaww8b42s",
            customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
            paymentMethodId: "pm_ssej45jawghghw8b42s",
            accountNumber: "21565234545",
            routingNumber: "1572515454",
            directDebitAuthorization:
              "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
            fundingSourceId:
              "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
            moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
            unitAccountId: "21565234545",
            swiftCode: "1572515454",
            remittanceInformation: "Payment for {year}-{month}-{day}",
            businessId: "biz_456",
            lockboxAddress: "123 Main St",
            accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
            oatfiAccountNumber: "21565234545",
            oatfiRoutingNumber: "21565234545",
          },
          scheduledRepayment: false,
          isDefault: true,
          type: "UNIT",
        },
      ],
      codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
      consumerInvoices: false,
      requestedCreditLimit: 10000,
      metadata: {
        mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
        avgMonthlySpend: "10000",
        orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
        requestedCreditLimit: 10000,
        plaidData: "{\"accounts\":[...],\"institution\":{...}}",
      },
    },
  });

  console.log(result);
}

run();

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 { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

const oatFiSDK = new OatFiSDK({
  serverURL: "https://stg.api.oatfi.com",
  bearer: process.env["OATFISDK_BEARER"] ?? "",
});

async function run() {
  const result = await oatFiSDK.businesses.create({
    idempotencyKey: "<value>",
    createBusinessDto: {
      externalId: "ext_123456",
      name: "Acme Corporation",
      dbaName: "Acme",
      taxId: "123456789",
      address: {
        line1: "123 Main St",
        line2: "Suite 100",
        city: "San Francisco",
        state: "CA",
        postalCode: "94105",
      },
      contactFirstName: "John",
      contactLastName: "Doe",
      contactEmail: "[email protected]",
      contactPhone: "+14155552671",
      businessStartDateYear: "2020",
      application: "507f1f77bcf86cd799439011",
      users: [
        "507f1f77bcf86cd799439011",
        "507f1f77bcf86cd799439012",
      ],
      primaryUser: "507f1f77bcf86cd799439011",
      achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
      webhookUrl: "https://my.webhook.com/post",
      plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
      plaidTokens: [
        {
          alias: "Default Token",
          token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
        },
      ],
      heronId: "heron_123456",
      paymentSettings: [
        {
          partner: "62eaf2133147bd1b70da07d2",
          business: "62eaf2133147bd1b70da07d2",
          data: {
            accountId: "acct_1J876rQjaww8b42s",
            customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
            paymentMethodId: "pm_ssej45jawghghw8b42s",
            accountNumber: "21565234545",
            routingNumber: "1572515454",
            directDebitAuthorization:
              "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
            fundingSourceId:
              "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
            moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
            unitAccountId: "21565234545",
            swiftCode: "1572515454",
            remittanceInformation: "Payment for {year}-{month}-{day}",
            businessId: "biz_456",
            lockboxAddress: "123 Main St",
            accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
            oatfiAccountNumber: "21565234545",
            oatfiRoutingNumber: "21565234545",
          },
          scheduledRepayment: false,
          isDefault: true,
          type: "UNIT",
        },
      ],
      codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
      consumerInvoices: false,
      requestedCreditLimit: 10000,
      metadata: {
        mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
        avgMonthlySpend: "10000",
        orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
        requestedCreditLimit: 10000,
        plaidData: "{\"accounts\":[...],\"institution\":{...}}",
      },
    },
  });

  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:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@oatfi/oatfi-sdk-ts/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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 OatFiSDK({ httpClient: httpClient });

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 { OatFiSDK } from "@oatfi/oatfi-sdk-ts";

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

You can also enable a default debug logger by setting an environment variable OATFISDK_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

License

This SDK is proprietary software owned by OatFi. Please see the LICENSE file for complete terms and conditions.

Contributions

While we value feedback and suggestions for this SDK, this library is auto-generated from our OpenAPI specification. Any manual changes added to internal files will be overwritten on the next generation cycle.

For feature requests, bug reports, or licensing inquiries, please contact us at [email protected] or open an issue with your request.

SDK Created by Speakeasy