Permissions
Permissions in the Switch Platform are normally associated with an authorization group. You can add new permissions or edit existing ones by tapping into Settings > Security and Users in the Switch Dashboard. You should be able to find the permissions in question under Authorization Groups.
What’s an authorization group? Excellent question.
The way you set up authorizations groups and users, defines the dynamics of your team when using Switch’s APIs. Learn more about it in Users and Authorization Groups.
Each authorization group consists of a list of specific users selected from the registered users in your team. Therefore, it’s important to consider which authorizations are necessary for each staff member when you set up your teams.
- Can these permissions allow for more than what the user needs?
- Can the user share these permissions with someone that might not be aware of the consequences of bad usage?
- Does the permission expose the user to unwanted information?
- Can another permission provide the same benefit with less added risk?
Questions about Permissions?
The Customer Success Team acts as gatekeeper to permissions in the Switch Platform. It is their responsibility to ensure that users only hold permissions they really need. For further inquiries about permissions contact support@switchpayments.com.
Interested in Switch Analytics?
Using Switch Analytics you are able to turn big data into valuable insights. Tap into balances, and user experience stats.
Analytics
Having permissions to Analytics, the user will be able to access the Analytics tab, which is available in the Switch Dashboard navigation bar.
Transactions
Enabling Transactions for an authorization group or specific users grants access to the list of transactions in the Transactions tab of the Switch Dashboard. To be able to perform actions on said transactions, users need further permissions, as described below.
| Permission | Description |
|---|---|
| Create Charge | The user can create charges. This action is performed via API and also using the Switch Dashboard. With this permission the user is able to initiate checkouts using the Create Checkout button in the Dashboard. |
| Create Instrument | The user can create instruments. This action is performed via API. |
| Create Refund | The user is able to refund payments It allows for whole and partial refunds. Refunds can never exceed the total amount paid. Refunds can be performed via API or through the Switch Dashboard by hitting the Refund button. |
| Create Reversal | The user is able to void transactions. It can be performed via API and also by hitting Void on the Switch Dashboard. |
Settlements
Enabling Settlements for an authorization group allows the respective users to access the Settlements tab in the Switch Dashboard.
| Permission | Description |
|---|---|
| Read Settlements Reports | The user can access and read settlement reports, templates and schedules. |
| Manage Settlements Reports | The user can edit and delete existing settlement reports, and also create new settlement reports., templates, and schedules. |
Risk
Concerned about security when communicating with Switch? So are we.
At Switch we ensure all types of threats, attacks, and suspicious activity is closely monitored at all times. Learn more about how we do it in Security.
Enabling Risk for an authorization group allows the respective users to access the Risk tab in the Switch Dashboard. This grants them access to the list of flagged transactions and risk rules.
| Permission | Description |
|---|---|
| Rules Management | The user is able to create, edit, and delete Risk rules: block, allow, review, and enable 3DS. |
Channels
Enabling Channels for an authorization group allows the respective users to access the Channels tab in the Switch Dashboard. This grants them access to the list of available channels and routing rules.
| Permission | Description |
|---|---|
| Activate Channels | The user can enable and disable channels. |
| Configure Channels | The user is able to edit channel details and keys. |
| Manage Routing Rules | The user is able to create routing rules and also edit and delete existing ones. |
Terminals
Enabling Terminals for an authorization group allows the respective users to access the Terminals tab in the Switch Dashboard.
| Permission | Description |
|---|---|
| Manage Terminals | The user gains access to all of the Switch Terminal options. This includes create, read, update, and delete terminals. It also allows for the creation, access, editing, and deletion of terminal model configurations, and maintenance details like the maintenance PIN. |
| Manage Terminal Business Settings | The user can change terminal settings. Except for the maintenance PIN. |
Events
Audit log?
The audit log registers changes made to elements in the Switch Platform. Every time a given resource is created, updated or deleted, an audit log event is created. Audit logs include the information being altered and also when and by whom the changes were made.
Enabling Events for an authorization group allows the respective users to access the Events tab in the Switch Dashboard. This allows them to explore listed events and all of their details.
| Permission | Description |
|---|---|
| Resend | The user is able to resend event communications to businesses. |
| Manage Destinations | The user can configure events’ delivery. |
| Event Schema | Description |
|---|---|
| Authorization Group Audit Log | Describes changes made to authorization groups. |
| Charge Audit Log | Describes changes made to a charge element. |
| Destination Audit Log | Describes changes made to destinations. |
| Events Checker Report | Contains all the failed dispatches of the last 24 hours. |
| Lifecycle Event | Describes each transaction. |
| Business Audit Log | Contains changes made to a business account. |
| Report Status | Contains the status of a report. Every time the state of a report changes an event with details on that report and its status is generated. |
| Settlements Batch | Describes settlement batches. |
| Settlements Source Group | Contains changes made to source groups. |
| Terminal Audit Log | Registers changes made to terminals. |
| Terminal Session | Registers the end of a terminal session and it includes details on said session. |
Reporting
Enabling Reporting for an authorization group allows the respective users to access the Reporting tab in the Switch Dashboard.
| Permission | Description |
|---|---|
| Manage Reporting | The user is able to create, read, edit, and delete reports, schedules, and reporting templates. |
Billing
Enabling Billing for an authorization group allows the respective users to access the Billing tab in the Switch Dashboard.
| Permission | Description |
|---|---|
| Manage Billing | The user is able to create, read, edit, and delete billing reports, schedules, and billing report templates. Users with this permission will be able to manage their descendants' billing. |
Settings
Under Settings you can find permissions to make changes to the configurations of user and business accounts. Note that some of these permissions are only available for staff members.
| Permission | Description |
|---|---|
| Manage Users | The user is able to create and manage user accounts in the current business account, it does not include sub-business accounts. Please note that a user with this permission is able to edit the permissions of any other user including their own. |
| Read Processing API Keys | Ability to read Processing API keys. |
| Manage Processing API Keys | Ability to generate, edit, and delete Processing API keys. |
| Read Authorization Groups | The user can read authorization groups on that account only. |
| Manage Authorization Groups | The user is able to generate and make changes to authorization groups in the current business account, it does not include sub-business accounts. This permission is also required when cloning authorization groups. |
User and Business
Under User and Businesses you can find permissions to make changes to the configurations of user accounts and business account environments. Note that User permissions are only made available to staff members.
| Permission | Description |
|---|---|
| Manage Business Test Accounts | Ability to create and edit test sub-accounts, create and edit users from test sub-accounts, and create and edit authorization groups from test sub-accounts. |
| Manage Business Live Accounts | Ability to create and edit live sub-accounts, create and edit users from live sub-accounts, and create and edit authorization groups from live sub-accounts. |
Next Steps
Now that you have gone through the Switch starting kit, head over to the Integrating with Switch to learn more about the integration patterns available and choose the one that best suits your needs.