Quick Start

Before getting started

Quick Start 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.

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.

API resource definitions

API resource definitions is handled by Quick Start 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.

Create roles

Roles are defined once per project and assigned per organization membership, so the same person can be an admin in one organization and a viewer in another.

Check permissions on the server, in the request path, using the permission slug rather than the role name. Role names change; slugs are stable.

Create permissions

Create permissions controls what the credential is allowed to do. Grant the narrowest set that lets the integration work, and widen it deliberately.

Scopes are evaluated at the API boundary, so an over-broad token is a real risk even if your own code never uses the extra capability.

Summary

Summary is handled by Quick Start 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.