The Permission Group object
A Permission Group sets a specific level of permissions. Each SSO is assigned to a permission group that defines which API elements the user is allowed to view, edit and create. There are 3 default permission groups:
1. The "Admin" permission group ( "Id": "ADMIN" ) that allows to:
- View and edit client settings
- View data such as users details
- Edit data such as create a payin
2. The "Read & Write" permission group ( "Id": "WRITE" ) that allows to:
- View data such as users details
- Edit data such as create a payin
3. The "Read Only" permission group ( "Id": "READ" ) that allows to:
- View data such as users details
Parameters
Name
string:
Maximum length is 255 characters
The name of the permission group
Type
GroupType:
DEFAULT, CUSTOM
The type of permission group
Scopes
Scopes:
View Sub-parameters
The Scopes of the permissions
Scopes.ClientDetails
Permissions:
View Sub-parameters
API endpoints linked to client details
Scopes.ClientDetails.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientDetails.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientDetails.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.ClientLogo
Permissions:
View Sub-parameters
API endpoints linked to client logo
Scopes.ClientLogo.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientLogo.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientLogo.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.ClientWallets
Permissions:
View Sub-parameters
API endpoints linked to client wallets
Scopes.ClientWallets.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientWallets.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientWallets.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.ClientBankAccounts
Permissions:
View Sub-parameters
API endpoints linked to client bank accounts
Scopes.ClientBankAccounts.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientBankAccounts.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientBankAccounts.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.ClientPayins
Permissions:
View Sub-parameters
API endpoints linked to client payins
Scopes.ClientPayins.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientPayins.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientPayins.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.ClientPayouts
Permissions:
View Sub-parameters
API endpoints linked to client payouts
Scopes.ClientPayouts.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientPayouts.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientPayouts.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.ClientTransactions
Permissions:
View Sub-parameters
API endpoints linked to client transactions
Scopes.ClientTransactions.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.ClientTransactions.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.ClientTransactions.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.SSOs
Permissions:
View Sub-parameters
API endpoints linked to SSOs
Scopes.SSOs.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.SSOs.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.SSOs.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.PermissionGroups
Permissions:
View Sub-parameters
API endpoints linked to permission groups
Scopes.PermissionGroups.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.PermissionGroups.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.PermissionGroups.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Users
Permissions:
View Sub-parameters
API endpoints linked to users
Scopes.Users.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Users.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Users.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Wallets
Permissions:
View Sub-parameters
API endpoints linked to wallets
Scopes.Wallets.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Wallets.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Wallets.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.BankingAliases
Permissions:
View Sub-parameters
API endpoints linked to banking aliases
Scopes.BankingAliases.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.BankingAliases.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.BankingAliases.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Cards
Permissions:
View Sub-parameters
API endpoints linked to cards
Scopes.Cards.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Cards.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Cards.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.BankAccounts
Permissions:
View Sub-parameters
API endpoints linked to bank accounts
Scopes.BankAccounts.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.BankAccounts.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.BankAccounts.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.PreAuthorizations
Permissions:
View Sub-parameters
API endpoints linked to preauthorizations
Scopes.PreAuthorizations.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.PreAuthorizations.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.PreAuthorizations.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Payins
Permissions:
View Sub-parameters
API endpoints linked to payins
Scopes.Payins.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Payins.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Payins.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Transfers
Permissions:
View Sub-parameters
API endpoints linked to transfers
Scopes.Transfers.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Transfers.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Transfers.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Payouts
Permissions:
View Sub-parameters
API endpoints linked to payouts
Scopes.Payouts.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Payouts.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Payouts.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Refunds
Permissions:
View Sub-parameters
API endpoints linked to refunds
Scopes.Refunds.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Refunds.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Refunds.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Transactions
Permissions:
View Sub-parameters
API endpoints linked to transactions
Scopes.Transactions.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Transactions.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Transactions.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.KYCDocuments
Permissions:
View Sub-parameters
API endpoints linked to KYC documents
Scopes.KYCDocuments.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.KYCDocuments.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.KYCDocuments.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Disputes
Permissions:
View Sub-parameters
API endpoints linked to disputes
Scopes.Disputes.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Disputes.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Disputes.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Repudiations
Permissions:
View Sub-parameters
API endpoints linked to repudiations
Scopes.Repudiations.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Repudiations.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Repudiations.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Mandates
Permissions:
View Sub-parameters
API endpoints linked to mandates
Scopes.Mandates.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Mandates.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Mandates.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Reporting
Permissions:
View Sub-parameters
API endpoints linked to reporting
Scopes.Reporting.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Reporting.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Reporting.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Responses
Permissions:
View Sub-parameters
API endpoints linked to responses
Scopes.Responses.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Responses.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Responses.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Events
Permissions:
View Sub-parameters
API endpoints linked to events
Scopes.Events.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Events.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Events.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.Hooks
Permissions:
View Sub-parameters
API endpoints linked to hooks
Scopes.Hooks.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.Hooks.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.Hooks.Create
bool:
true, false
allows POST requests on the related endpoints
Scopes.UboDeclarations
Permissions:
View Sub-parameters
API endpoints linked to UBO declaration
Scopes.UboDeclarations.Read
bool:
true, false
allows GET requests on the related endpoints
Scopes.UboDeclarations.Edit
bool:
true, false
allows PUT requests on the related endpoints
Scopes.UboDeclarations.Create
bool:
true, false
allows POST requests on the related endpoints