Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
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
| SDK for Node.js contains | Table of contents |
|---|---|
|
src/solidgate/ – main library source code for development package.json – script for managing dependencies and library imports index.js – entry point for the SDK |
Requirements Installation Usage Errors |
- Node.js: 12 or later
- npm: Node.js package manager
- Solidgate account: Public and secret key (request via sales@solidgate.com)
To install the Node.js SDK:
- Ensure you have your public and secret key.
- Run:
npm install @solidgate/node-sdk
- Import the SDK into your Node.js application:
const solidGate = require('@solidgate/node-sdk');
- Use test credentials to validate your integration before deploying to production.
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': 'test@testmail.com',
'order_description': 'Premium package',
'order_id': "213",
'platform': 'WEB',
'geo_country': 'ESP',
'form_design_name': 'form-design',
});
promise.then((res) => {
//do smth
})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': 'test@testmail.com',
'order_description': 'Premium package',
'order_id': "213",
'platform': 'WEB',
'geo_country': 'ESP',
'form_design_name': 'form-design',
});
const dataToFront = merchantData.toObject()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': 'test@testmail.com',
'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
})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': 'test@testmail.com',
'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)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': 'test@testmail.com',
'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);Handle errors.
api.charge({...}).catch((error) => console.error(error));Looking for help? Contact us
Want to contribute? Submit a pull request