Installation

Install the package with:

npm install @juspay-tech/hyperswitch-node

Hyperswitch Node.js Library

The Hyperswitch Node library provides convenient access to the Hyperswitch API from applications written in server-side JavaScript.

To take a look at Hyperswitch's Api References head to :- Hyperswitch API References

Documentation

See the hyperswitch-node API docs for Node.js.

Requirements

Node 16 or lower.

Usage

The package needs to be configured with your account's api key, which is available in the Hyperswitch Dashboard. Require it with the key's value:

const hyperswitch = require('@juspay-tech/hyperswitch-node')('<hyperswitch_api_key>');

hyperswitch.customers.create({
  email: '[email protected]',
})
  .then(customer => console.log(customer.customer_id))
  .catch(error => console.error(error));

Or using ES modules and async/await:

import Hyperswitch from '@juspay-tech/hyperswitch-node';
const hyperswitch = new Hyperswitch('<hyperswitch_api_key>');

(async () => {
  const customer = await hyperswitch.customers.create({
    email: '[email protected]',
  });

  console.log(customer.customer_id);
})();

Usage with TypeScript

Import Hyperswitch as a default import (not * as Hyperswitch, unlike the DefinitelyTyped version) and instantiate it as new Hyperswitch() with the latest API version.

import Hyperswitch from '@juspay-tech/hyperswitch-node';
const hyperswitch = new Hyperswitch('<hyperswitch_api_key>');

const createCustomer = async () => {
  const params: Hyperswitch.CustomerCreateParams = {
    description: 'test customer',
  };

  const customer: Hyperswitch.Customer = await stripe.customers.create(params);

  console.log(customer.customer_id);
};
createCustomer();

You can find a full TS server example in Hyperswitch-Samples

Testing

While testing on Sandbox environment make sure to use the Api Key from Hyperswitch Sandbox Dashboard. When switching on Production environment, make sure to use Api Key's from Hyperswitch Live Dashboard.

Development

To test this package locally:

$ mkdir hyperswitch-test-sample
$ cd hyperswitch-test-sample
$ npm init -y
$ npm install --save-dev typescript
$ npx tsc --init
$ mkdir src
$ touch index.ts

Now import Hyperswitch package and then try to call the Customers - Create api in sandbox environment.

import Hyperswitch from '@juspay-tech/hyperswitch-node';
const hyperswitch = new Hyperswitch('<hyperswitch_api_key>');

const createCustomer = async () => {
  const params: Hyperswitch.CustomerCreateParams = {
    description: 'test customer',
  };

  const customer: Hyperswitch.Customer = await hyperswitch.customers.create(params);

  console.log(customer.customer_id);
};
createCustomer();

Now, to run the typescript file:

$ npx tsc
$ node src/index.js