Skip to content
Paycux

Documentation availability

Paycux is in private beta. Most pages describe roadmap or reference material. The implemented boundary is published at docs/API_CONTRACTS.md in the release source and under What exists today in this documentation.

SDKs

Sign-in UI React Router SDK

Install and configure the Sign-in UI React Router SDK client, and make your first authenticated call.

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

Usage

Usage is handled by Sign-in UI React Router 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.

Beta Versions

Beta Versions is handled by Sign-in UI React Router 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.

Sign-in UI React Router 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.

Configuration

Configuration is handled by Sign-in UI React Router 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.

Setup

Setup is handled by Sign-in UI React Router 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.

Customizing Session Storage

Paycux issues a sealed session cookie alongside the access token. The cookie carries no user data of its own — it is an encrypted pointer that the SDK unseals on each request using your cookie password.

Access tokens are short-lived by design. Refresh them on the server, never in the browser, and treat a failed refresh as a signal to send the user back through sign-in.

Troubleshooting

If something does not work, check these first — they cover the large majority of failed setups:

  • The values were pasted into the wrong environment. Staging and production hold separate configuration.
  • A trailing slash or stray whitespace in the ACS URL or redirect URI. Both are matched exactly.
  • The connection is saved but not activated. An inactive connection returns connection_inactive.
  • Attribute names differ from what the mapping expects, so the user is created without an email address.

Every failed authentication is recorded with a reason on the connection's page in the dashboard. Start there before reading application logs.