Users & Roles
API ReferenceUsersRoles
List Invitable Roles
Returns the roles your API key can assign when inviting a new user. The set depends on the entity type (organisation vs merchant) and on your own role.
GET /user/role/list/invite
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type | string | Yes | One of organization or merchant. Pick merchant when inviting a user scoped to a single merchant; organization when granting access across all merchants in the org. |
Request Example
curl 'https://api.v2.paychtec.com/user/role/list/invite?entity_type=merchant' \ -H "api-key: snd_YOUR_API_KEY"Response
[
{ "role_id": "merchant_admin", "role_name": "merchant_admin", "scope": "merchant" },
{ "role_id": "merchant_viewer", "role_name": "merchant_viewer", "scope": "merchant" }
]Common roles
role_name | What the user can do |
|---|---|
org_admin | Full org-wide access. Can invite other users, manage all merchants. |
merchant_admin | Full access within one merchant. Can invite/edit users for that merchant. |
merchant_viewer | Read-only access to payments, refunds, disputes for one merchant. |
payfac_merchant_admin | Sub-merchant admin: same as merchant_admin but restricted further (no connectors, routing, recon). |
payfac_merchant_viewer | Sub-merchant viewer: read-only equivalent of payfac_merchant_admin. |
tenant_admin | Platform/tenant-wide. Reserved for the platform operator. |