Skip to content

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.

Single Sign-On

Single Sign-On

How Single Sign-On works in Paycux, what it is for, and the smallest setup that gets it running.

Choose your integration approach

App Connections move records between your application and the tools your customers already run, without you writing a connector per tool. You publish a schema; Paycux handles the transport, retries and mapping.

Each pipe is scoped to one organization and one direction. Model a two-way sync as two pipes so failures on one side cannot stall the other.

AWith the standalone SSO API

AWith the standalone SSO API is handled by Single Sign-On 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.

BUsing Paycux Sign-in UI

BUsing Paycux Sign-in UI is handled by Single Sign-On 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.

How Single Sign-On works

How Single Sign-On works is handled by Single Sign-On 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.

What you’ll build

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.

Before getting started

Single Sign-On is part of the Paycux platform. This page explains what it does, when to reach for it, and the smallest working setup you can ship.

Everything below applies to both environments. Build and test in staging, then promote the same configuration to production without changing your code — only the API key and client ID differ.

API object definitions

API object definitions is handled by Single Sign-On 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.

Add SSO to your app

Add SSO to your app is handled by Single Sign-On 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.