User Management

Manage who on your team can access the TransFi Checkout dashboard and what they can do.

📘

Where to find it: Dashboard → Settings → Teams

Only Admin users can invite, edit roles, or remove team members

Roles & Team Management

There are 4 roles available in the TransFi Dashboard.

Each role has a fixed set of permissions : custom roles are not supported.

Available Roles

RoleWhat they can do
AdminFull view and edit access to all dashboard features including user management
DeveloperCreate/edit Checkout Widget, create/update support tickets, view API keys, view transactions, view settlements
OperationsView and download transactions and settlements, view settlement account details
View onlyRead-only access to transactions, settlements, and settings. Intended for TransFi support team to debug issues

Permission Breakdown

PermissionAdminDeveloperOperationsView only
Widget Create / Update
Support Ticket Create / Update
API Key Read
Transaction Read
Transaction Download
Settlement Read
Settlement Download
Settings Read
User Management (full)

How to Invite a Team Member

From Dashboard

  1. Go to Settings → Teams
  2. Click + Invite User
  3. Enter the user's email address
  4. Select a role
  5. Click Send Invite

The user will receive an email invitation.

The invite appears as pending in the Teams table until accepted.

Via API

POST /checkout/user-management/invite
{
  "email": "[email protected]",
  "roleId": "developer"
}

[!TIP] Only Admin users can call this endpoint. Requests from non-admin roles will be rejected.

How to Edit a Team Member's Role

From Dashboard

  1. Go to Settings → Teams
  2. Click the edit (pencil) icon next to the user
  3. Select the new role from the dropdown
  4. Click Update Role

Via API

PUT /checkout/user-management/users/{cxId}/role
{
  "roleId": "operations"
}

[!NOTE] Admin users cannot have their role changed or be removed. The edit and delete actions are disabled for Admin accounts.

How to Remove a Team Member

From Dashboard

  1. Go to Settings → Teams
  2. Click the delete (trash) icon next to the user
  3. Confirm the removal

Via API

DELETE /checkout/user-management/users/{cxId}

Managing Pending Invites

Invites that haven't been accepted yet can be revoked.

List Pending Invites

GET /checkout/user-management/invites

Revoke an Invite

DELETE /checkout/user-management/invites/{inviteId}

In the dashboard, pending invites appear in the Teams table.

Clicking the delete icon on a pending invite revokes the invite rather than removing a user.

Accepting an Invite

When a user receives an invite email, they click the invite link which calls:

POST /checkout/user-management/accept-invite

This completes onboarding and grants dashboard access with the assigned role.

Other Endpoints

MethodEndpointPurpose
GET/checkout/user-management/rolesList all available roles
GET/checkout/user-management/meGet current authenticated user's details and role


Did this page help you?