Practical overview
When it fits
Use it when a server-side JavaScript application needs library methods for OpenNode API calls, particularly charge requests and webhook signature checks.
Who it is for
- Developers integrating OpenNode charge creation into a server-side JavaScript checkout.
- Teams processing OpenNode webhook events and checking their signatures.
Documented uses
- Request a payment charge through the OpenNode API.
- Receive charge event notifications through an application callback.
- Check whether an incoming webhook signature is valid.
Requirements & limits
The README says API access requires an account secret key available from the OpenNode Dashboard. It documents npm and Yarn installation.
- The package targets server-side JavaScript and its repository identifies TypeScript as the primary language.
- Library methods return chainable promises as an alternative to callbacks.
- The application must provide its own checkout, webhook event handling and response logic.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up the library and configure OpenNode credentials
Add the package to a server-side JavaScript project and configure it to access the OpenNode API.
Before you start
- A server-side JavaScript application
- An OpenNode account secret key available from the OpenNode Dashboard
Steps
Install the package with npm install opennode --save or yarn add opennode.
Load the opennode package in the application.
Configure it with setCredentials, supplying the account key and, if needed, the dev environment parameter.
Expected outcome
The library is installed and configured for OpenNode API calls; the documented default environment is live when no environment parameter is given.
Guide limitations
- This setup sequence does not demonstrate a complete application deployment or checkout flow.
Create a charge and verify an incoming webhook signature
Use the library to request an OpenNode charge and check the signature of a webhook event.
Before you start
- The library configured with a valid OpenNode account secret key
- Application-side webhook handling
Steps
Call createCharge with charge details such as amount, currency and callback_url.
Handle the returned charge or catch the error; the library methods support chainable promises.
When a webhook arrives, pass its event body to signatureIsValid.
Handle the event in application code only when the signature check is valid.
Expected outcome
The application can request a charge and check whether an incoming webhook event was sent by OpenNode.
Guide limitations
- The application must implement webhook handling and response logic.
- The example does not describe the full checkout or event-processing workflow.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 17 October 2026
- Original website title
- opennodedev/opennode-node · Official homepage title · retained in its source language