Node.js SDK

Installation

Install the SDK with your package manager, then read the API key from the environment rather than hard-coding it.

1npm install @paycux/node

Beta Versions

Beta Versions is handled by Node.js SDK rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Paycux Node.js Library

Official SDKs are published for Node.js, Python, Ruby, Go, PHP, Java and .NET. They share the same method names, so a snippet translates between languages with little more than syntax changes.

Each SDK reads PAYCUX_API_KEY from the environment by default and retries idempotent requests on transport errors.

Documentation

Documentation is handled by Node.js SDK rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Requirements

Before you start, make sure you have the following in place:

• A Paycux account with access to the project you are configuring.
• An API key for the environment you are working in. Staging keys start with sk_test_; production keys start with sk_live_.
• Admin access on the system you are connecting, so you can create the application and read its metadata.
• A redirect URI registered in the Paycux dashboard under Developer → Redirects.

Configuration

Configuration is handled by Node.js SDK rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Public Client Mode (Browser/Mobile/CLI)

The Paycux CLI wraps the same API the SDKs use. Authenticate once, then run commands against whichever environment you select.

1paycux login
2paycux env use staging
3paycux organizations list

SDK Versioning

SDK Versioning applies specifically to Node.js SDK. It behaves the same in both environments, and the values it depends on are visible in the dashboard for the environment you have selected.

If the behaviour you see does not match this description, check which environment your API key belongs to before anything else — a staging key against production data is the most common cause.