Skip to content

Dwolla/dwolla-typescript

BranchesTags

Repository files navigation

dwolla-typescript

Developer-friendly & type-safe Typescript SDK specifically catered to leverage dwolla-typescript API.



Important

Beta Release - This SDK is currently in beta. Core operations including customer creation, funding sources, transfers, and beneficial ownership have been tested and are functional. We are conducting thorough internal testing of all operations before general availability. Please note that breaking changes may occur as we continue to make improvements. While suitable for development and testing, please use with appropriate caution in production environments.

Summary

Dwolla API: Dwolla API Documentation

Table of Contents

SDK Installation

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

NPM

npm add dwolla

PNPM

pnpm add dwolla

Bun

bun add dwolla

Yarn

yarn add dwolla

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 { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.tokens.create({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
clientID
clientSecret		 oauth2 OAuth2 Client Credentials Flow DWOLLA_CLIENT_ID
DWOLLA_CLIENT_SECRET
DWOLLA_TOKEN_URL

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.tokens.create({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

accounts

  • get - Retrieve account details

accounts.exchanges

  • list - List exchanges for an account
  • create - Create an exchange for an account

accounts.fundingSources

  • create - Create a funding source for an account
  • list - List funding sources for an account

accounts.massPayments

  • list - List account mass payments

accounts.transfers

  • list - List and search account transfers

beneficialOwners

  • get - Retrieve beneficial owner
  • update - Update beneficial owner
  • delete - Remove beneficial owner

beneficialOwners.documents

  • list - List documents for beneficial owner
  • create - Create a document for beneficial owner

businessClassifications

  • list - List business classifications
  • get - Retrieve a business classification

clientTokens

  • create - Create a client token

customers

customers.beneficialOwners

  • list - List customer beneficial owners
  • create - Create customer beneficial owner

customers.beneficialOwnership

  • get - Retrieve beneficial ownership status
  • certify - Certify beneficial ownership

customers.documents

  • list - List documents for customer
  • create - Create a document for customer

customers.exchanges

  • list - List exchanges for a customer
  • create - Create an exchange for a customer

customers.exchangeSessions

  • create - Create customer exchange session

customers.fundingSources

  • list - List customer funding sources
  • create - Create customer funding source

customers.kba

customers.labels

  • list - List labels for a customer
  • create - Create a label for a customer

customers.massPayments

  • list - List mass payments for customer

customers.transfers

  • list - List and search transfers for a customer

documents

  • get - Retrieve a document

events

  • list - List events
  • get - Retrieve event

exchangePartners

  • list - List exchange partners
  • get - Retrieve exchange partner

exchanges

  • get - Retrieve exchange resource

exchanges.exchangeSessions

exchangeSessions

  • get - Retrieve exchange session

fundingSources

fundingSources.balance

  • get - Retrieve funding source balance

fundingSources.microDeposits

  • get - Retrieve micro-deposits details
  • initiate - Initiate micro-deposits
  • verify - Verify micro-deposits

fundingSources.onDemandTransferAuthorizations

  • create - Create an on-demand transfer authorization

kba

labels

  • get - Retrieve a label
  • remove - Remove a label

labels.ledgerEntries

  • list - List label ledger entries
  • create - Create a label ledger entry
  • get - Retrieve a label ledger entry

labels.reallocations

  • create - Create a label reallocation
  • get - Retrieve a label reallocation

massPayments

  • create - Initiate a mass payment
  • get - Retrieve a mass payment
  • update - Update a mass payment

massPayments.items

  • list - List items for a mass payment
  • get - Retrieve mass payment item

root

tokens

  • create - Create an application access token

transfers

  • create - Initiate a transfer
  • get - Retrieve a transfer
  • cancel - Cancel a transfer

transfers.failure

  • get - Retrieve a transfer failure reason

transfers.fees

  • list - List fees for a transfer

webhooks

  • get - Retrieve a webhook
  • retry - Retry a webhook

webhooks.retries

  • list - List retries for a webhook

webhookSubscriptions

  • list - List webhook subscriptions
  • create - Create a webhook subscription
  • get - Retrieve a webhook subscription
  • update - Update a webhook subscription
  • delete - Delete a webhook subscription

webhookSubscriptions.webhooks

  • list - List webhooks for a webhook subscription

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

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 { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.customers.documents.create({
    id: "<id>",
    requestBody: {},
  });

  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 { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.tokens.create({
    grantType: "client_credentials",
  }, {
    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 { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.tokens.create({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Error Handling

DwollaError 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
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Dwolla } from "dwolla";
import * as errors from "dwolla/models/errors";

const dwolla = new Dwolla({
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  try {
    const result = await dwolla.tokens.create({
      grantType: "client_credentials",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.DwollaError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.UnauthorizedError) {
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary error:

  • DwollaError: The base class for HTTP error responses.
Less common errors (176)

Network errors:

Inherit from DwollaError:

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList 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 names associated with the available servers:

Name Server Description
prod https://api.dwolla.com Production server
sandbox https://api-sandbox.dwolla.com Sandbox server

Example

import { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  server: "sandbox",
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.tokens.create({
    grantType: "client_credentials",
  });

  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 { Dwolla } from "dwolla";

const dwolla = new Dwolla({
  serverURL: "https://api.dwolla.com",
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await dwolla.tokens.create({
    grantType: "client_credentials",
  });

  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 { Dwolla } from "dwolla";
import { HTTPClient } from "dwolla/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 Dwolla({ 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 { Dwolla } from "dwolla";

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

You can also enable a default debug logger by setting an environment variable DWOLLA_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.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

About

No description, website, or topics provided.

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

10 watching

Forks

1 fork
Report repository

Releases

7 tags

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages