Permissions
This document outlines all the available permissions and their descriptions for the application.
Table of Contents
- Quick Reference
- CRM
- Applications
- Support
- Residuals
- Reports
- Gateway
- Equipment
- Underwriting
- Manage Merchants
- Merchant Accounts
- API Keys
- Compliance
Quick reference
| Permission | Name |
|---|---|
readCRM | View CRM Data |
writeCRM | Manage CRM Data |
readApplications | View Applications |
writeApplications | Manage Applications |
readSupport | View Support Tickets |
writeSupport | Manage Support Tickets |
readResiduals | View Residuals |
writeResiduals | Manage Residuals |
readReports | View Reports |
writeReports | Manage Reports |
readGateway | View Gateway Settings |
writeGateway | Manage Gateway Settings |
readEquipment | View Equipment |
writeEquipment | Manage Equipment |
readUnderwriting | View Underwriting |
writeUnderwriting | Manage Underwriting |
readMerchants | View Merchants |
writeMerchants | Manage Merchants |
readVirtualTerminal | View Virtual Terminal |
writeVirtualTerminal | Use Virtual Terminal |
readMerchantStatements | View Statements |
writeMerchantStatements | Manage Statements |
readChargebacks | View Chargebacks |
writeChargebacks | Manage Chargebacks |
readMerchantCustomers | View Customers |
writeMerchantCustomers | Manage Customers |
readMerchantTransactions | View Transactions |
writeMerchantTransactions | Manage Transactions |
readMerchantPaymentForms | View Payment Forms |
writeMerchantPaymentForms | Create Payment Forms |
readApiKeys | View API Keys |
writeApiKeys | Manage API Keys |
readCompliance | View Compliance |
writeCompliance | Manage Compliance |
CRM
-
View CRM Data
- Description: Access customer profiles, leads, and contact history. View customer interactions and relationship data.
- Permission:
readCRM
-
Manage CRM Data
- Description: Create and modify customer profiles, update lead information, and manage customer relationships. Add notes and track interactions.
- Permission:
writeCRM
Applications
-
View Applications
- Description: Access merchant applications, view submission details, and track application status through the approval process.
- Permission:
readApplications
-
Manage Applications
- Description: Process merchant applications, update application status, request additional information, and manage the approval workflow.
- Permission:
writeApplications
Support
-
View Support Tickets
- Description: Access support tickets, view merchant inquiries, and track ticket status and resolution progress.
- Permission:
readSupport
-
Manage Support Tickets
- Description: Create and update support tickets, assign agents, respond to merchant inquiries, and resolve customer issues.
- Permission:
writeSupport
Residuals
-
View Residuals
- Description: Access commission reports, view revenue sharing calculations, and monitor payment distributions.
- Permission:
readResiduals
-
Manage Residuals
- Description: Configure commission structures, adjust revenue sharing rules, and process residual payments to partners.
- Permission:
writeResiduals
Reports
-
View Reports
- Description: Access financial reports, transaction analytics, merchant performance metrics, and system statistics.
- Permission:
readReports
-
Manage Reports
- Description: Create custom reports, configure reporting parameters, and schedule automated report generation.
- Permission:
writeReports
Gateway
-
View Gateway Settings
- Description: Access payment gateway configurations, view processing rules, and monitor transaction routing.
- Permission:
readGateway
-
Manage Gateway Settings
- Description: Configure payment gateways, set up processing rules, manage transaction routing, and optimize payment flows.
- Permission:
writeGateway
Equipment
-
View Equipment
- Description: Access terminal inventory, view device status, and track hardware assignments to merchants.
- Permission:
readEquipment
-
Manage Equipment
- Description: Process equipment orders, configure terminals, manage inventory, and handle hardware deployments.
- Permission:
writeEquipment
Underwriting
-
View Underwriting
- Description: Access risk assessments, view merchant verification status, and monitor compliance requirements.
- Permission:
readUnderwriting
-
Manage Underwriting
- Description: Conduct risk assessments, verify merchant information, set risk parameters, and manage approval criteria.
- Permission:
writeUnderwriting
Manage Merchants
-
View Merchants
- Description: Access merchant profiles, view account settings, and monitor merchant status and activity.
- Permission:
readMerchants
-
Manage Merchants
- Description: Create and modify merchant accounts, update business information, and configure merchant settings.
- Permission:
writeMerchants
Merchant Accounts
-
View Virtual Terminal
- Description: Access the virtual terminal interface and view transaction processing capabilities.
- Permission:
readVirtualTerminal
-
Use Virtual Terminal
- Description: Process payments through the virtual terminal and manage transaction operations.
- Permission:
writeVirtualTerminal
-
View Statements
- Description: Access merchant statements, transaction summaries, and financial reports.
- Permission:
readMerchantStatements
-
Manage Statements
- Description: Generate merchant statements, configure statement settings, and manage report delivery.
- Permission:
writeMerchantStatements
-
View Chargebacks
- Description: Access chargeback cases, view dispute details, and monitor resolution status.
- Permission:
readChargebacks
-
Manage Chargebacks
- Description: Handle chargeback disputes, submit evidence, and manage resolution processes.
- Permission:
writeChargebacks
-
View Customers
- Description: Access customer profiles, view payment methods, and monitor customer activity.
- Permission:
readMerchantCustomers
-
Manage Customers
- Description: Create and update customer profiles, manage payment methods, and handle customer data.
- Permission:
writeMerchantCustomers
-
View Transactions
- Description: Access transaction history, view payment details, and monitor processing status.
- Permission:
readMerchantTransactions
-
Manage Transactions
- Description: Process refunds, void transactions, and handle transaction-related operations.
- Permission:
writeMerchantTransactions
-
View Payment Forms
- Description: Access payment form templates, view form configurations, and monitor form usage.
- Permission:
readMerchantPaymentForms
-
Create Payment Forms
- Description: Design custom payment forms, configure payment options, and manage form deployments.
- Permission:
writeMerchantPaymentForms
API Keys
-
View API Keys
- Description: Access API credentials, view integration settings, and monitor API usage.
- Permission:
readApiKeys
-
Manage API Keys
- Description: Generate API keys, configure access levels, and manage integration permissions.
- Permission:
writeApiKeys
Compliance
-
View Compliance
- Description: Access compliance requirements, view compliance status, and monitor compliance metrics.
- Permission:
readCompliance
-
Manage Compliance
- Description: Configure compliance rules, update requirements, and manage compliance settings.
- Permission:
writeCompliance