Skip to content

README.md

Latest commit

 

History

History
90 lines (66 loc) · 6.64 KB

README.md

File metadata and controls

90 lines (66 loc) · 6.64 KB

Exchanges

Overview

Operations related to Exchanges

Available Operations

  • get - Retrieve exchange resource

get

Returns details for a specific exchange connection between Dwolla and an open banking partner for a customer's bank account. Includes exchange status, creation date, and links to the associated customer and exchange partner.

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.exchanges.get({
    id: "e5e9f2d3-a96c-4abd-a097-8ec7ae28aa8a",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { DwollaCore } from "dwolla/core.js";
import { exchangesGet } from "dwolla/funcs/exchangesGet.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 exchangesGet(dwolla, {
    id: "e5e9f2d3-a96c-4abd-a097-8ec7ae28aa8a",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("exchangesGet failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.GetExchangeRequest ✔️ 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.Exchange>

Errors

Error Type Status Code Content Type
errors.GetExchangeUnauthorizedDwollaV1HalJSONError 401 application/vnd.dwolla.v1.hal+json
errors.GetExchangeNotFoundDwollaV1HalJSONError 404 application/vnd.dwolla.v1.hal+json
errors.APIError 4XX, 5XX */*