Users & Roles
API ReferenceUsersList Invitable Roles
List Invitable Roles
Returns the roles your API key can assign when inviting a new user.
GET /user/role/list/invite
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type | string | Yes | Pick merchant when inviting a user scoped to a single merchant; |
Request Example
curl 'https://api.rpayz.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 |
|---|---|
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. |