Roles and scopes
Roles and scopes define the actions a user or application can perform within the Vitesse platform.
Roles control access for platform users and grant permissions to features such as payments, reporting, administration, and approvals, ensuring users can perform only the tasks required for their responsibilities.
Scopes control access for API integrations and define the actions an application can perform, such as creating payments, viewing transactions, or managing recipients.
Roles and scopes enforce separation of duties and secure access control. For example, one user can create payments while another approves them, and an API integration can have view-only access to payments without permission to make them.
User roles
The following roles are available within the platform:
All users require the MerchantUser role, which grants login access to Vitesse online, MAS and the APIs.
| User Role | Role key | Description |
|---|---|---|
| Admin | MerchantAdmin | Full administrative access to accounts, configuration, and system settings. |
| Batch Approver | MerchantMerchantBatchApprover | Use if the merchant batch approval process is configured. Approve, reject, or cancel uploaded batch payments. Use in conjunction with UploadBatches role. |
| Create Account Movements | AccountMovementEditor | MAS only. Create, view, edit, and submit account movements for approval. |
| Create Payment Limit Requests | CreatePaymentLimitRequests | Request and revoke payment limit increases, and access the Payment Limits page. Use in conjunction with PaymentLimitRequestApprover role where approvals are required. |
| Create Single Payments | CreatePayment | Not for card payments (see CreateUrgentPayments role for card-only payments). Create, edit, submit for approval, and cancel single payments. Use in conjunction with MerchantSinglePaymentApprover role where approvals are required. |
| Create Void Requests | MerchantCreateVoidRequest | For cheque payments only. Submit requests to void cheque payments. Use in conjunction with MerchantVoidRequestApprover role where approvals are required. |
| Manage Account Movements | AccountMovementAdmin | Create, edit, approve, or cancel account movements. |
| Manage Branding Configuration | MerchantManageBranding | Configure account and payment branding. |
| Manage Deferred Transaction Groups | MerchantManageDeferredTransactionGroups | Create and manage deferred transaction groups. |
| Manage Identity Clients | MerchantManageIdentityClients | Create and manage API identity clients. |
| Manage Payment Requests | MerchantManagePaymentRequests | Create, edit, and manage payment requests. Use in conjunction with MerchantPaymentRequestApprover role where approvals are required. |
| Manage Report Destinations | MerchantManageReportDestinations | Configure email and SFTP destinations for reports. |
| Manage Report Schedules | MerchantManageReportSchedules | Create and manage report schedules. |
| Manage Report Subscriptions | MerchantManageReportSubscriptions | Manage report subscriptions and execution. |
| Manage Report Templates | MerchantManageReportTemplates | Create, edit, and run report templates. |
| Manage Stored Recipients | ManageStoredRecipients | Create, edit, and manage stored recipients. |
| Payment Limit Request Approver | PaymentLimitRequestApprover | Approve or reject payment limit requests. Use in conjunction with CreatePaymentLimitRequests role. |
| Receive New User Notifications | MerchantReceiveNewUserNotifications | For users without an Admin role. Receive notifications when new users are created. |
| Single Payment Approver | MerchantSinglePaymentApprover | Approve or reject single payments. Use in conjunction with CreatePayment role. |
| Upload Batches | UploadBatches | Upload, cancel, and submit batch payments for approval. Use in conjunction with BatchApprover role where approvals are required. |
| User | MerchantUser | Read-only access with no administrative permissions.
|
| View Payment Requests | MerchantViewPaymentRequests | View payment request activity. |
| View Recipient Account Details | MerchantViewRecipientAccountDetails | View recipient account information. |
| View Reports | MerchantViewReports | Read-only access to reporting. |
| View User Sessions | ViewUserSessions | View user session activity. |
| View and Approve FCP Account Applications | MerchantFcpAccountApplicationApprover | View and approve FCP account applications. |
| View and Create FCP Account Applications | MerchantCreateFcpAccountApplication | View and create FCP account applications. |
| Void Request Approver | MerchantVoidRequestApprover | Approve or reject void requests. Use in conjunction with MerchantCreateVoidRequests role. |
For information about configuring user roles, see Manage users.
API scopes
All API calls require an identity token based on the assigned permissions:
| API Permission | Permission key | Description |
|---|---|---|
| Create Account Movements | AccountMovements.Create | Create and approve account movements. |
| View Account Movements | AccountMovements.Lookup | View account movements. |
| View Accounts | Accounts.Lookup | View account details and balances. |
| Create Cheque Voids | ChequeVoid.Create | Create and approve cheque void requests. |
| View Cheque Voids | ChequeVoid.Lookup | View cheque void requests and statuses. |
| Create Deferred Transaction Groups | DeferredTransactionGroups.Create | Create and approve deferred transaction groups. |
| View Deferred Transaction Groups | DeferredTransactionGroups.Lookup | View deferred transaction groups and statuses. |
| Create Deferred Transaction Requests | DeferredTransactionRequests.Create | Create and approve deferred transaction requests. |
| View Deferred Transaction Requests | DeferredTransactionRequests.Lookup | View deferred transaction requests and statuses. |
| Create Forex Transactions | Forex.Create | Create and approve foreign exchange transactions. |
| View Forex Transactions | Forex.Lookup | View foreign exchange transactions and rates. |
| Create Payee Payment Requests | PayeePaymentRequests.Create | Create and approve payee payment requests. |
| View Payee Payment Requests | PayeePaymentRequests.Lookup | View payee payment requests and statuses. |
| Create Recipients | Recipients.Create | Create recipient records for payments and transactions. |
| Delete Recipients | Recipients.Delete | Delete recipient records. |
| View Recipients | Recipients.Lookup | View recipient records and details. |
| Update Recipients | Recipients.Update | Edit and update recipient records. |
| View Rules | Rules.Lookup | View configured business and transaction rules. |
| Create Transaction Requests | TransactionRequests.Create | Create and approve transaction requests. |
| View Transaction Requests | TransactionRequests.Lookup | View transaction requests and statuses. |
| View Transactions | Transactions.Lookup | View transaction history and transaction details. |
For information about configuring identity clients, see Manage identity clients.
Updated 15 days ago
Related information
Did this page help you?