Node SDK

Learn how to download and install Moov’s server-side Node SDK.

Installation

You can download and install the Node SDK from npm.

1
npm i @moovio/node

Then import it into your project.

1
import { Moov } from "@moovio/node";

Moov

Initializes a new instance of the Moov API client.

1
new Moov(credentials, gotOptionsOrInstance)

Parameters

Name Type Description
credentials object API key credentials
credentials.accountID string Facilitator account ID
credentials.publicKey string Public key value from API key
credentials.secretKey string Secret key value from API key
credentials.domain string One of the domains from API key
gotOptionsOrInstance object Customized Got options or instance. See docs.

Get the information for the credentials parameter from the Moov Dashboard.

Moov uses the Got HTTP client library. If you need to access or customize the request-response pipeline, then provide customized options or an instance in the gotOptionsOrInstance parameter.

Examples

1
2
3
4
5
6
const moov = new Moov({
  accountID: "...",
  publicKey: "...",
  secretKey: "...",
  domain: "...",
});

Accounts

1
moov.accounts

Read more on accounts in the Moov Node SDK.

Gets the Accounts API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.accounts.create(...);
} catch (err) {
  // ...
}

Avatars

1
moov.avatars

Read more on avatars in the Moov Node SDK.

Gets the Avatars API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.avatars.get(...);
} catch (err) {
  // ...
}

BankAccounts

1
moov.bankAccounts

Read more on bankAccounts in the Moov Node SDK.

Gets the Bank Accounts API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.bankAccounts.link(...);
} catch (err) {
  // ...
}

Capabilities

1
moov.capabilities

Read more on capabilities in the Moov Node SDK.

Gets the Capabilities API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.capabilities.requestCapabilities(...);
} catch (err) {
  // ...
}

Cards

1
moov.cards

Read more on cards in the Moov Node SDK.

Gets the Cards API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.cards.list(...);
} catch (err) {
  // ...
}

EnrichedAddresses

1
moov.enrichedAddresses

Read more on enrichedAddresses in the Moov Node SDK.

Gets the Enriched Address API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.enrichedAddresses.get(...);
} catch (err) {
  // ...
}

EnrichedProfiles

1
moov.enrichedProfiles

Read more on enrichedProfiles in the Moov Node SDK.

Gets the Enriched Profile API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.enrichedProfiles.get(...);
} catch (err) {
  // ...
}

PaymentMethods

1
moov.paymentMethods

Read more on paymentMethods in the Moov Node SDK.

Gets the Payment Methods API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.paymentMethods.get(...);
} catch (err) {
  // ...
}

Institutions

1
moov.institutions

Read more on institutions in the Moov Node SDK.

Gets the Institutions API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.institutions.getACHInstitution(...);
} catch (err) {
  // ...
}

Representatives

1
moov.representatives

Read more on representatives in the Moov Node SDK.

Gets the Representatives API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.representatives.create(...);
} catch (err) {
  // ...
}

Transfers

1
moov.transfers

Read more on transfers in the Moov Node SDK.

Gets the Transfers API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.transfers.create(...);
} catch (err) {
  // ...
}

Wallets

1
moov.wallets

Read more on wallets in the Moov Node SDK.

Gets the Wallets API.

Examples

1
2
3
4
5
6
const moov = new Moov(...);
try {
  await moov.wallets.get(...);
} catch (err) {
  // ...
}

Articles in this section

Authentication

Every Moov API request requires a valid OAuth token. Our authentication flow follows the OAuth 2.0 standard. When making requests from the browser, you’ll also need to request scope enums when generating a token.

Accounts

Accounts represent a legal entity (either a business or an individual) in Moov. You can create an account for yourself or set up accounts for others.

Representatives

We require all business accounts to have valid information for at least one representative. Moov accounts must have verified business representatives before a business account can send funds, collect money from other accounts, or store funds in a wallet.

Capabilities

Capabilities determine what a Moov account can do. Each capability has specific information requirements, depending on risk and compliance standards associated with different account activities.

Bank accounts

To transfer money with Moov, you’ll need to link a bank account to your Moov account, then verify that account. You can link a bank account to a Moov account by adding the bank account number and routing number to the account object.

Cards

You can link credit or debit cards to Moov accounts. You can use a card as a source for making transfers, which charges the card.

Payment methods

Payments methods represent all of the ways an account can move funds to another Moov account. Payment methods are generated programmatically when a card or bank account is added or the status is updated.

Transfers

A transfer is the movement of money between Moov accounts, from source to destination. Provided you have linked a bank account which has been verified, you can initiate a transfer to another Moov account.

Wallets

Every Moov account automatically comes with a Moov wallet, which serves as a funding source as you accumulate funds. At this time, wallets can’t be manually created, deleted or modified.

Institutions

Lookup ACH and wire participating financial institutions. We recommend using this endpoint when an end-user enters a routing number to confirm their bank or credit union.

Enrichment

Access different enrichment data such as address suggestions or profile data. Our profile enrichment service is offered in collaboration with Clearbit.

Avatars

You can retrieve an account’s profile image. This is especially useful if you’d like to use the profile image for a corresponding account in your own product.

Summary Beta