Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

hyperwallet-sdk

hyperwallet7kMIT2.1.2

A library to manage users, transfer methods and payments through the Hyperwallet API

hyperwallet, sdk, rest, bankaccount, payout, creditcard, ach

readme

Build Status Coverage Status Document NPM version

Hyperwallet REST SDK

A library to manage users, transfer methods and payments through the Hyperwallet Rest V4 API To access Rest V3 APIs please use SDK v1.5

Prerequisites

Hyperwallet's NodeJS server SDK requires at minimum NodeJS 6.15.1 and above.

Installation

$ npm install hyperwallet-sdk

Documentation

Documentation is available at http://hyperwallet.github.io/node-sdk.

API Overview

To write an app using the SDK

  • Register for a sandbox account and get your username, password and program token at the Hyperwallet Program Portal.
  • Add dependency hyperwallet-sdk to your package.json.
  • Require hyperwallet-sdk in your file

    var Hyperwallet = require("hyperwallet-sdk");
  • Create a instance of the Hyperwallet Client (with username, password and program token)

    var client = new Hyperwallet({
      username: "restapiuser@4917301618",
      password: "mySecurePassword!",
      programToken: "prg-645fc30d-83ed-476c-a412-32c82738a20e",
    });
  • Start making API calls (e.g. create a user)

    var userData = {
       clientUserId: "test-client-id-1",
       profileType: "INDIVIDUAL",
       firstName: "Daffyd",
       lastName: "y Goliath",
       email: "testmail-1@hyperwallet.com",
       addressLine1: "123 Main Street",
       city: "Austin",
       stateProvince: "TX",
       country: "US",
       postalCode: "78701",
    };
    
    client.createUser(userData, function(errors, body, res) {
       if (errors) {
          console.log("Create User Failed");
          console.log(errors);
       } else {
          console.log("Create User Response");
          console.log(body);
       }
    });

    The displayed callback format is valid for all SDK methods. For more information see the Callback Documentation.

Development

Run the tests using npm:

$ npm install
$ npm test

Reference

REST API Reference

License

MIT

changelog

Changelog

2.1.2

  • Bump up node-jose from 2.1.0 to 2.2.0
  • Bump up gh-pages from 3.1.0 to 6.1.1

2.1.1

  • Added field 'accountId' to PayPal.
  • PayPal account creation allowed using field 'accountId' which accepts Email, Phone Number, PayPal PayerID.
  • Venmo account creation allowed using field 'accountId' which accepts Email, Phone Number, Venmo Handle, Venmo External ID.

2.1.0

  • Updated parameter filters for GET List Endpoints
  • Added taxVerificationStatus to Users
  • Added Document and RejectionReason Models for document upload and parse

2.0.3

  • Filters added to list Webhook events

2.0.2

  • Added header data to requests (user-agent, sdk-version etc)

2.0.1

  • Accesses V4 Rest APIs
  • Added Business Stakeholders
  • Added updatePaypalAccount, getPayPalAccountStatusTransition, listPayPalAccountStatusTransitions
  • Added listTransferMethods
  • Added getTransferStatusTransition, listTransferStatusTransition
  • Added filters

1.5.0

  • Added Venmo accounts
  • Added Multipart upload documents feature for User
  • Added Transfer refunds
  • Added User status transitions (activate, deactivate, preactivate, freeze, lock)

1.4.1

  • Add Venmo Accounts endpoints
  • Add Transfer Refunds endpoint
  • Add Multipart Form data upload to User

1.4.0

  • Add PayPal account status transitions
  • Remove VersionEye from Node

1.3.1 (2019-04-09)

  • FIX: TypeError thrown when response status is 204 No Content

1.3.0 (2019-01-25)

  • Added field "VerificationStatus" to User
  • Client-token endpoint renamed to authentication-token

1.0.1 (2019-01-22)

  • FIX: Resolved issue with restricted "Accept" & "Content-Type" headers to support only "application/json" or "application/jose+json"

1.0.0 (2018-12-21)

  • Added PayPal account endpoint
  • Added transfer endpoint
  • Added client token endpoint
  • Added Layer 7 encryption
  • Added payment status transition endpoint
  • Added paper check endpoint
  • Added bank card endpoint
  • Added list program account receipt endpoint
  • Added list user receipt endpoint
  • Added list prepaid card receipt endpoint
  • Added list program account balance endpoint
  • Changed default server from https://sandbox.hyperwallet.com to https://api.sandbox.hyperwallet.com

0.1.1 (2016-06-30)

  • Fixed package.json reference issue

0.1.0 (2016-06-30)

  • Initial release