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 Accounts Representatives Capabilities Bank accounts Cards Payment methods Transfers Wallets Institutions Enrichment Avatars

Node SDK

Was this helpful?