JavaScript is a powerful and flexible programming language. It can execute on a web browser that allows us to make interactive webpages such as popup menus, animations, form validation, etc.

You can easily integrate crypto payments into your own website or app with our UniPayment Node SDK, after installation you can start accepting crypto-payments.

UniPayment NodeJS Client

GitHub license

A NodeJS client for the UniPayment Client API.

This SDK provides a convenient abstraction of UniPayment's Gateway API and allows developers to focus on payment flow/e-commerce integration rather than on the specific details of client-server interaction using the raw API.

Getting Started

Before using the UniPayment API, sign up for your API key.

If you want to use the Sandbox, sign up here.

Installation

Manual

  1. Download the package and extract it into a local directory or clone the repo.
  2. copy unipayment_client

Using npm

npm install unipayment-client

Initializing UniPayment client

configuration.json

{
  "apiHost": "https://sandbox.unipayment.io",
  "appId": "cee1b9e2-d90c-4b63-9824-d621edb38012",
  "apiKey": "9G62Fd7fCQGyznVvatk4SAfGsHDEt819E",
  "apiVersion": "1.0"
}
const UniPaymentClient = require('../src/unipayment_client').uni_payment_client;
const configuration = require('./configuration.json');
const client = new UniPaymentClient(configuration);

Sandbox is used in the same way with is_sandbox as true.

{
  "apiHost": "https://sandbox-api.unipayment.io",
  "appId": "cee1b9e2-d90c-4b63-9824-d621edb38012",
  "apiKey": "9G62Fd7fCQGyznVvatk4SAfGsHDEt819E",
  "apiVersion": "1.0"
}

Create an invoice

Reference:https://unipayment.readme.io/reference/create_invoice

const client = new UniPaymentClient(configuration);

const parameters = {
        "title": "Test Invoice",
        "description": "Test Desc",
        "lang": "en-US",
        "price_amount": 100.0,
        "price_currency": "USD",
        "notify_url": "https://example.com/notify",
        "redirect_url": "https://example.com/redirect",
        "order_id": "#123456"
    }
client.createInvoice(parameters).then(response => {
    console.log(response);
    done();
}).catch(error => {
    console.log(error);
})

CreateInvoiceResponse

{
  "code": "OK",
  "msg": "",
  "data": {
    "app_id": "cee1b9e2-d90c-4b63-9824-d621edb38012",
    "invoice_id": "Dj2mNCXXWCGKT89kcU8NJn",
    "order_id": "ORDER_123456",
    "price_amount": 2.0,
    "price_currency": "USD",
    "network": null,
    "address": null,
    "pay_amount": 0.0,
    "pay_currency": null,
    "exchange_rate": 0.0,
    "paid_amount": 0.0,
    "create_time": "2022-09-14T06:31:57",
    "expiration_time": "2022-09-14T06:36:57",
    "confirm_speed": 2,
    "status": 1,
    "error_status": 0,
    "invoice_url": "https://sandbox-app.unipayment.io/i/Dj2mNCXXWCGKT89kcU8NJn"
  }
}

Handle IPN

Reference:https://unipayment.readme.io/reference/ipn-check

Invoice Status: https://unipayment.readme.io/reference/invoice-status

IPNs (Instant Payment Notifications) are sent to the notify_url when order status is changed to paid, confirmed and complete.

var notify = 'notify from unipayment'

const client = new UniPaymentClient(configuration);
client.checkIpn(notify).then(response => {
        console.log(response);
        if(response.data.code === 'OK')
        {
            //handle business log
            return "SUCCESS";
        }
        done();
    }).catch(error => {
        console.log(error);
        done();
    })

IPN notify

{
    "ipn_type": "invoice",
    "event": "invoice_expired",
    "app_id": "cee1b9e2-d90c-4b63-9824-d621edb38012",
    "invoice_id": "3Q7fyLnB2YNhUDW1fFNyEz",
    "order_id": "20",
    "price_amount": 6.0,
    "price_currency": "SGD",
    "network": null,
    "address": null,
    "pay_currency": null,
    "pay_amount": 0.0,
    "exchange_rate": 0.0,
    "paid_amount": 0.0,
    "confirmed_amount": 0.0,
    "refunded_price_amount": 0.0,
    "create_time": "2022-09-12T03:36:03",
    "expiration_time": "2022-09-12T03:41:03",
    "status": "Expired",
    "error_status": "None",
    "ext_args": null,
    "transactions": null,
    "notify_id": "8ccd2b61-226b-48e5-99b8-acb1f350313e",
    "notify_time": "2022-09-12T03:56:10.5852752Z"
}

Run Example

1.Get source code form GitHub

git clone https://github.com/UniCryptoLab/UniPaymentClient.Node.git

3.Run test

npm test

Resource