Skip to content
Node.js Client Library for SynapseFI REST V3.1 API |
Branch: master
Clone or download
Latest commit 3e88a11 Apr 19, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
src minor clean up Apr 18, 2019
test Add samples for card subnets Jan 26, 2019
.gitignore Add in axios for dependencies Feb 27, 2019
LICENSE Fix readme Mar 12, 2019
index.js Initialize repo from local Nov 21, 2018
package-lock.json 1.2.2 Apr 19, 2019
package.json 1.2.2 Apr 19, 2019 minor clean up Apr 19, 2019


npm status
Node.js Client Library for SynapseFI REST V3.1 API

Code Examples

Please refer to and our API documentation for examples.


npm install synapsenode


Require and configure dotenv:


Create a .env file at the root directory and add the following variables to it:


Initialize new Client:

const Synapse = require('synapsenode');
const Client = Synapse.Client;

const client = new Client({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  fingerprint: process.env.FINGERPRINT,
  ip_address: '<ip_address>',
  // isProduction boolean determines if production (true) or sandbox (false) endpoint is used
  isProduction: false


Run the following command from the root package directory after the .env file is set up and '<OBJ_ID>' values are replaced in the test files:

npm test


MIT License

You can’t perform that action at this time.