Roles and Permissions
How Roles and Permissions works in Paycux, what it is for, and the smallest setup that gets it running.
Introduction
Roles and Permissions 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.
Understanding permissions
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.
Understanding roles
Understanding roles applies specifically to Roles and Permissions. 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.
Permission inheritance
Permission inheritance 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.
Seeing inheritance in action
Seeing inheritance in action is handled by Roles and Permissions 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 access is evaluated
How access is evaluated is handled by Roles and Permissions 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.
Managing roles in the Dashboard
Managing roles in the Dashboard applies specifically to Roles and Permissions. 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.
Custom resource-scoped roles
Custom resource-scoped roles 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.