README.md

Accounts.MassPayments

Overview

Available Operations

• list - List account mass payments

list

Returns a paginated list of mass payments created by your Main Dwolla account. Results are sorted by creation date in descending order (newest first) and can be filtered by correlation ID.

Example Usage

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.accounts.massPayments.list({
    id: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DwollaCore } from "dwolla/core.js";
import { accountsMassPaymentsList } from "dwolla/funcs/accountsMassPaymentsList.js";

// Use `DwollaCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const dwolla = new DwollaCore({
  security: {
    clientID: process.env["DWOLLA_CLIENT_ID"] ?? "",
    clientSecret: process.env["DWOLLA_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const res = await accountsMassPaymentsList(dwolla, {
    id: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("accountsMassPaymentsList failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.ListMassPaymentsRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.MassPayments>

Errors

Error Type	Status Code	Content Type
errors.ListMassPaymentsForbiddenDwollaV1HalJSONError	403	application/vnd.dwolla.v1.hal+json
errors.ListMassPaymentsNotFoundDwollaV1HalJSONError	404	application/vnd.dwolla.v1.hal+json
errors.APIError	4XX, 5XX	*/*