Solidgate API

Node.js SDK provides API options for integrating Solidgate’s payment orchestrator into your Node.js applications.

Check our

• Payment guide to understand business value better
• API Reference to find more examples of usage

Structure

Requirements

• Node.js: 12 or later
• npm: Node.js package manager
• Solidgate account: Public and secret key (request via [email protected])

Installation

To install the Node.js SDK:

1. Ensure you have your public and secret key.
2. Run:

   npm install @solidgate/node-sdk

3. Import the SDK into your Node.js application:

   const solidGate = require('@solidgate/node-sdk');

4. Use test credentials to validate your integration before deploying to production.

Usage

Charge a payment

Returns a Promise.

const solidGate = require('@solidgate/node-sdk');

let api = new solidGate.Api("merchant", "private_key", "base_solidgate_url");

let promise = api.charge({
    'amount': 10000,
    'currency': 'USD',
    'customer_email': '[email protected]',
    'order_description': 'Premium package',
    'order_id': "213",
    'platform': 'WEB',
    'geo_country': 'ESP',
    'form_design_name': 'form-design',
});

promise.then((res) => {
//do smth
})

Payment form URL

Returns a FormInitDTO class.

const solidGate = require('@solidgate/node-sdk');

let api = new solidGate.Api("merchant", "private_key");

let merchantData = api.formMerchantData({
  'amount': 10000,
  'currency': 'USD',
  'customer_email': '[email protected]',
  'order_description': 'Premium package',
  'order_id': "213",
  'platform': 'WEB',
  'geo_country': 'ESP',
  'form_design_name': 'form-design',
});

const dataToFront = merchantData.toObject()

Payment form DTO

Return FormInitDTO class.

const solidGate = require('@solidgate/node-sdk');

let api = new solidGate.Api("merchant", "private_key");

let dto = api.formMerchantData({
  'amount': 10000,
  'currency': 'USD',
  'customer_email': '[email protected]',
  'order_description': 'Premium package',
  'order_id': "213",
  'platform': 'WEB',
  'geo_country': 'ESP',
});

const dataToFront = dto.toObject()

These values should be applied on the FrontEnd in the following way.

const form = PaymentFormSdk.init({
    merchantData: dataToFront // from backend
})

Payment form update

Return FormUpdateDTO class

const solidGate = require('@solidgate/node-sdk');

let api = new solidGate.Api("merchant", "private_key");

let dto = api.formUpdate({
  'amount': 10000,
  'currency': 'USD',
  'customer_email': '[email protected]',
  'order_description': 'Premium package',
  'platform': 'WEB',
  'geo_country': 'ESP',
});

const dataToFront = dto.toObject()

These values should be applied on the FrontEnd in the following way.

const form.update(dataToFront)

Payment form resign

Return FormResignDTO class.

const solidGate = require('@solidgate/node-sdk');

let api = new solidGate.Api("merchant", "private_key");

let dto = api.formResign({
  'amount': 10000,
  'currency': 'USD',
  'customer_email': '[email protected]',
  'order_description': 'Premium package',
  'order_id': "213",
  'platform': 'WEB',
  'geo_country': 'ESP',
  'recurring_token': 'some_token',
});

const dataToFront = dto.toObject();

These values should be applied on the FrontEnd in the following way.

const form = PaymentFormSdk.resign(dataToFront);

Errors

Handle errors.

api.charge({...}).catch((error) => console.error(error));