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

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

Name
string

string:

Maximum length is 255 characters

The name of the permission group

Type
GroupType

GroupType:

DEFAULT, CUSTOM

The type of permission group

Scopes
Scopes

Scopes:

View Sub-parameters

The Scopes of the permissions

Scopes.ClientDetails
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client details

Scopes.ClientDetails.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientDetails.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientDetails.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.ClientLogo
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client logo

Scopes.ClientLogo.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientLogo.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientLogo.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.ClientWallets
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client wallets

Scopes.ClientWallets.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientWallets.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientWallets.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.ClientBankAccounts
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client bank accounts

Scopes.ClientBankAccounts.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientBankAccounts.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientBankAccounts.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.ClientPayins
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client payins

Scopes.ClientPayins.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientPayins.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientPayins.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.ClientPayouts
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client payouts

Scopes.ClientPayouts.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientPayouts.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientPayouts.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.ClientTransactions
Permissions

Permissions:

View Sub-parameters

API endpoints linked to client transactions

Scopes.ClientTransactions.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.ClientTransactions.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.ClientTransactions.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.SSOs
Permissions

Permissions:

View Sub-parameters

API endpoints linked to SSOs

Scopes.SSOs.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.SSOs.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.SSOs.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.PermissionGroups
Permissions

Permissions:

View Sub-parameters

API endpoints linked to permission groups

Scopes.PermissionGroups.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.PermissionGroups.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.PermissionGroups.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Users
Permissions

Permissions:

View Sub-parameters

API endpoints linked to users

Scopes.Users.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Users.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Users.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Wallets
Permissions

Permissions:

View Sub-parameters

API endpoints linked to wallets

Scopes.Wallets.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Wallets.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Wallets.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.BankingAliases
Permissions

Permissions:

View Sub-parameters

API endpoints linked to banking aliases

Scopes.BankingAliases.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.BankingAliases.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.BankingAliases.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Cards
Permissions

Permissions:

View Sub-parameters

API endpoints linked to cards

Scopes.Cards.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Cards.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Cards.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.BankAccounts
Permissions

Permissions:

View Sub-parameters

API endpoints linked to bank accounts

Scopes.BankAccounts.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.BankAccounts.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.BankAccounts.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.PreAuthorizations
Permissions

Permissions:

View Sub-parameters

API endpoints linked to preauthorizations

Scopes.PreAuthorizations.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.PreAuthorizations.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.PreAuthorizations.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Payins
Permissions

Permissions:

View Sub-parameters

API endpoints linked to payins

Scopes.Payins.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Payins.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Payins.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Transfers
Permissions

Permissions:

View Sub-parameters

API endpoints linked to transfers

Scopes.Transfers.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Transfers.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Transfers.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Payouts
Permissions

Permissions:

View Sub-parameters

API endpoints linked to payouts

Scopes.Payouts.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Payouts.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Payouts.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Refunds
Permissions

Permissions:

View Sub-parameters

API endpoints linked to refunds

Scopes.Refunds.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Refunds.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Refunds.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Transactions
Permissions

Permissions:

View Sub-parameters

API endpoints linked to transactions

Scopes.Transactions.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Transactions.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Transactions.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.KYCDocuments
Permissions

Permissions:

View Sub-parameters

API endpoints linked to KYC documents

Scopes.KYCDocuments.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.KYCDocuments.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.KYCDocuments.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Disputes
Permissions

Permissions:

View Sub-parameters

API endpoints linked to disputes

Scopes.Disputes.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Disputes.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Disputes.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Repudiations
Permissions

Permissions:

View Sub-parameters

API endpoints linked to repudiations

Scopes.Repudiations.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Repudiations.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Repudiations.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Mandates
Permissions

Permissions:

View Sub-parameters

API endpoints linked to mandates

Scopes.Mandates.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Mandates.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Mandates.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Reporting
Permissions

Permissions:

View Sub-parameters

API endpoints linked to reporting

Scopes.Reporting.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Reporting.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Reporting.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Responses
Permissions

Permissions:

View Sub-parameters

API endpoints linked to responses

Scopes.Responses.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Responses.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Responses.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Events
Permissions

Permissions:

View Sub-parameters

API endpoints linked to events

Scopes.Events.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Events.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Events.Create
bool

bool:

true, false

allows POST requests on the related endpoints

Scopes.Hooks
Permissions

Permissions:

View Sub-parameters

API endpoints linked to hooks

Scopes.Hooks.Read
bool

bool:

true, false

allows GET requests on the related endpoints

Scopes.Hooks.Edit
bool

bool:

true, false

allows PUT requests on the related endpoints

Scopes.Hooks.Create
bool

bool:

true, false

allows POST requests on the related endpoints

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"Name": "Users only",
"Type": "CUSTOM",
"Scopes": {
"ClientDetails": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientLogo": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientWallets": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientBankAccounts": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientPayins": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientPayouts": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientTransactions": {
"Read": false,
"Edit": false,
"Create": false
},
"SSOs": {
"Read": false,
"Edit": false,
"Create": false
},
"PermissionGroups": {
"Read": false,
"Edit": false,
"Create": false
},
"Users": {
"Read": false,
"Edit": false,
"Create": false
},
"Wallets": {
"Read": false,
"Edit": false,
"Create": false
},
"BankingAliases": {
"Read": false,
"Edit": false,
"Create": false
},
"Cards": {
"Read": false,
"Edit": false,
"Create": false
},
"BankAccounts": {
"Read": false,
"Edit": false,
"Create": false
},
"PreAuthorizations": {
"Read": false,
"Edit": false,
"Create": false
},
"Payins": {
"Read": false,
"Edit": false,
"Create": false
},
"Transfers": {
"Read": false,
"Edit": false,
"Create": false
},
"Payouts": {
"Read": false,
"Edit": false,
"Create": false
},
"Refunds": {
"Read": false,
"Edit": false,
"Create": false
},
"Transactions": {
"Read": false,
"Edit": false,
"Create": false
},
"KYCDocuments": {
"Read": false,
"Edit": false,
"Create": false
},
"Disputes": {
"Read": false,
"Edit": false,
"Create": false
},
"Repudiations": {
"Read": false,
"Edit": false,
"Create": false
},
"Mandates": {
"Read": false,
"Edit": false,
"Create": false
},
"Reporting": {
"Read": false,
"Edit": false,
"Create": false
},
"Responses": {
"Read": false,
"Edit": false,
"Create": false
},
"Events": {
"Read": false,
"Edit": false,
"Create": false
},
"Hooks": {
"Read": false,
"Edit": false,
"Create": false
}
}
}

Create a Permission Group

Note that all Scopes are set to "false" by default.

POST .../v2.01/ClientId

The ID of your client account

/clients/permissiongroups/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

Name
string

string:

Maximum length is 255 characters

required

The name of the permission group

Scopes
Scopes

Scopes:

View Sub-parameters

optional

The Scopes of the permissions

Scopes.ClientDetails
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client details

Scopes.ClientDetails.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientDetails.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientDetails.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientLogo
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client logo

Scopes.ClientLogo.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientLogo.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientLogo.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientWallets
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client wallets

Scopes.ClientWallets.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientWallets.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientWallets.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientBankAccounts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client bank accounts

Scopes.ClientBankAccounts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientBankAccounts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientBankAccounts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientPayins
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client payins

Scopes.ClientPayins.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientPayins.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientPayins.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientPayouts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client payouts

Scopes.ClientPayouts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientPayouts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientPayouts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientTransactions
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client transactions

Scopes.ClientTransactions.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientTransactions.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientTransactions.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.SSOs
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to SSOs

Scopes.SSOs.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.SSOs.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.SSOs.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.PermissionGroups
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to permission groups

Scopes.PermissionGroups.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.PermissionGroups.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.PermissionGroups.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Users
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to users

Scopes.Users.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Users.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Users.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Wallets
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to wallets

Scopes.Wallets.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Wallets.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Wallets.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.BankingAliases
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to banking aliases

Scopes.BankingAliases.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.BankingAliases.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.BankingAliases.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Cards
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to cards

Scopes.Cards.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Cards.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Cards.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.BankAccounts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to bank accounts

Scopes.BankAccounts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.BankAccounts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.BankAccounts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.PreAuthorizations
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to preauthorizations

Scopes.PreAuthorizations.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.PreAuthorizations.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.PreAuthorizations.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Payins
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to payins

Scopes.Payins.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Payins.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Payins.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Transfers
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to transfers

Scopes.Transfers.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Transfers.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Transfers.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Payouts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to payouts

Scopes.Payouts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Payouts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Payouts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Refunds
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to refunds

Scopes.Refunds.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Refunds.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Refunds.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Transactions
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to transactions

Scopes.Transactions.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Transactions.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Transactions.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.KYCDocuments
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to KYC documents

Scopes.KYCDocuments.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.KYCDocuments.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.KYCDocuments.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Disputes
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to disputes

Scopes.Disputes.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Disputes.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Disputes.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Repudiations
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to repudiations

Scopes.Repudiations.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Repudiations.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Repudiations.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Mandates
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to mandates

Scopes.Mandates.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Mandates.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Mandates.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Reporting
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to reporting

Scopes.Reporting.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Reporting.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Reporting.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Responses
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to responses

Scopes.Responses.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Responses.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Responses.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Events
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to events

Scopes.Events.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Events.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Events.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Hooks
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to hooks

Scopes.Hooks.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Hooks.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Hooks.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

  • View
  • Code
  • Run
  • View
  • Code
  • Run
POST .../clients/permissiongroups/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"Name": "Users only",
"Scopes": {
"ClientDetails": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientLogo": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientWallets": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientBankAccounts": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientPayins": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientPayouts": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientTransactions": {
"Read": false,
"Edit": false,
"Create": false
},
"SSOs": {
"Read": false,
"Edit": false,
"Create": false
},
"PermissionGroups": {
"Read": false,
"Edit": false,
"Create": false
},
"Users": {
"Read": false,
"Edit": false,
"Create": false
},
"Wallets": {
"Read": false,
"Edit": false,
"Create": false
},
"BankingAliases": {
"Read": false,
"Edit": false,
"Create": false
},
"Cards": {
"Read": false,
"Edit": false,
"Create": false
},
"BankAccounts": {
"Read": false,
"Edit": false,
"Create": false
},
"PreAuthorizations": {
"Read": false,
"Edit": false,
"Create": false
},
"Payins": {
"Read": false,
"Edit": false,
"Create": false
},
"Transfers": {
"Read": false,
"Edit": false,
"Create": false
},
"Payouts": {
"Read": false,
"Edit": false,
"Create": false
},
"Refunds": {
"Read": false,
"Edit": false,
"Create": false
},
"Transactions": {
"Read": false,
"Edit": false,
"Create": false
},
"KYCDocuments": {
"Read": false,
"Edit": false,
"Create": false
},
"Disputes": {
"Read": false,
"Edit": false,
"Create": false
},
"Repudiations": {
"Read": false,
"Edit": false,
"Create": false
},
"Mandates": {
"Read": false,
"Edit": false,
"Create": false
},
"Reporting": {
"Read": false,
"Edit": false,
"Create": false
},
"Responses": {
"Read": false,
"Edit": false,
"Create": false
},
"Events": {
"Read": false,
"Edit": false,
"Create": false
},
"Hooks": {
"Read": false,
"Edit": false,
"Create": false
}
}
}
require_once("mangopay.php");

try {


$ = new \MangoPay\();
$->Tag = "custom meta";
$->Name = "Users only";
$->Scopes = new \MangoPay\();
$->Scopes->ClientDetails = new \MangoPay\();
$->Scopes->ClientDetails->Read = false;
$->Scopes->ClientDetails->Edit = false;
$->Scopes->ClientDetails->Create = false;
$->Scopes->ClientLogo = new \MangoPay\();
$->Scopes->ClientLogo->Read = false;
$->Scopes->ClientLogo->Edit = false;
$->Scopes->ClientLogo->Create = false;
$->Scopes->ClientWallets = new \MangoPay\();
$->Scopes->ClientWallets->Read = false;
$->Scopes->ClientWallets->Edit = false;
$->Scopes->ClientWallets->Create = false;
$->Scopes->ClientBankAccounts = new \MangoPay\();
$->Scopes->ClientBankAccounts->Read = false;
$->Scopes->ClientBankAccounts->Edit = false;
$->Scopes->ClientBankAccounts->Create = false;
$->Scopes->ClientPayins = new \MangoPay\();
$->Scopes->ClientPayins->Read = false;
$->Scopes->ClientPayins->Edit = false;
$->Scopes->ClientPayins->Create = false;
$->Scopes->ClientPayouts = new \MangoPay\();
$->Scopes->ClientPayouts->Read = false;
$->Scopes->ClientPayouts->Edit = false;
$->Scopes->ClientPayouts->Create = false;
$->Scopes->ClientTransactions = new \MangoPay\();
$->Scopes->ClientTransactions->Read = false;
$->Scopes->ClientTransactions->Edit = false;
$->Scopes->ClientTransactions->Create = false;
$->Scopes->SSOs = new \MangoPay\();
$->Scopes->SSOs->Read = false;
$->Scopes->SSOs->Edit = false;
$->Scopes->SSOs->Create = false;
$->Scopes->PermissionGroups = new \MangoPay\();
$->Scopes->PermissionGroups->Read = false;
$->Scopes->PermissionGroups->Edit = false;
$->Scopes->PermissionGroups->Create = false;
$->Scopes->Users = new \MangoPay\();
$->Scopes->Users->Read = false;
$->Scopes->Users->Edit = false;
$->Scopes->Users->Create = false;
$->Scopes->Wallets = new \MangoPay\();
$->Scopes->Wallets->Read = false;
$->Scopes->Wallets->Edit = false;
$->Scopes->Wallets->Create = false;
$->Scopes->BankingAliases = new \MangoPay\();
$->Scopes->BankingAliases->Read = false;
$->Scopes->BankingAliases->Edit = false;
$->Scopes->BankingAliases->Create = false;
$->Scopes->Cards = new \MangoPay\();
$->Scopes->Cards->Read = false;
$->Scopes->Cards->Edit = false;
$->Scopes->Cards->Create = false;
$->Scopes->BankAccounts = new \MangoPay\();
$->Scopes->BankAccounts->Read = false;
$->Scopes->BankAccounts->Edit = false;
$->Scopes->BankAccounts->Create = false;
$->Scopes->PreAuthorizations = new \MangoPay\();
$->Scopes->PreAuthorizations->Read = false;
$->Scopes->PreAuthorizations->Edit = false;
$->Scopes->PreAuthorizations->Create = false;
$->Scopes->Payins = new \MangoPay\();
$->Scopes->Payins->Read = false;
$->Scopes->Payins->Edit = false;
$->Scopes->Payins->Create = false;
$->Scopes->Transfers = new \MangoPay\();
$->Scopes->Transfers->Read = false;
$->Scopes->Transfers->Edit = false;
$->Scopes->Transfers->Create = false;
$->Scopes->Payouts = new \MangoPay\();
$->Scopes->Payouts->Read = false;
$->Scopes->Payouts->Edit = false;
$->Scopes->Payouts->Create = false;
$->Scopes->Refunds = new \MangoPay\();
$->Scopes->Refunds->Read = false;
$->Scopes->Refunds->Edit = false;
$->Scopes->Refunds->Create = false;
$->Scopes->Transactions = new \MangoPay\();
$->Scopes->Transactions->Read = false;
$->Scopes->Transactions->Edit = false;
$->Scopes->Transactions->Create = false;
$->Scopes->KYCDocuments = new \MangoPay\();
$->Scopes->KYCDocuments->Read = false;
$->Scopes->KYCDocuments->Edit = false;
$->Scopes->KYCDocuments->Create = false;
$->Scopes->Disputes = new \MangoPay\();
$->Scopes->Disputes->Read = false;
$->Scopes->Disputes->Edit = false;
$->Scopes->Disputes->Create = false;
$->Scopes->Repudiations = new \MangoPay\();
$->Scopes->Repudiations->Read = false;
$->Scopes->Repudiations->Edit = false;
$->Scopes->Repudiations->Create = false;
$->Scopes->Mandates = new \MangoPay\();
$->Scopes->Mandates->Read = false;
$->Scopes->Mandates->Edit = false;
$->Scopes->Mandates->Create = false;
$->Scopes->Reporting = new \MangoPay\();
$->Scopes->Reporting->Read = false;
$->Scopes->Reporting->Edit = false;
$->Scopes->Reporting->Create = false;
$->Scopes->Responses = new \MangoPay\();
$->Scopes->Responses->Read = false;
$->Scopes->Responses->Edit = false;
$->Scopes->Responses->Create = false;
$->Scopes->Events = new \MangoPay\();
$->Scopes->Events->Read = false;
$->Scopes->Events->Edit = false;
$->Scopes->Events->Create = false;
$->Scopes->Hooks = new \MangoPay\();
$->Scopes->Hooks->Read = false;
$->Scopes->Hooks->Edit = false;
$->Scopes->Hooks->Create = false;

$Result = $Api->->($);

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
POST .../clients/permissiongroups/ HTTP/1.1
Body Parameters :
{
"Tag": "",
"Name": "",
"Scopes": {
"ClientDetails": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientLogo": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientWallets": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientBankAccounts": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientPayins": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientPayouts": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientTransactions": {
"Read": "",
"Edit": "",
"Create": ""
},
"SSOs": {
"Read": "",
"Edit": "",
"Create": ""
},
"PermissionGroups": {
"Read": "",
"Edit": "",
"Create": ""
},
"Users": {
"Read": "",
"Edit": "",
"Create": ""
},
"Wallets": {
"Read": "",
"Edit": "",
"Create": ""
},
"BankingAliases": {
"Read": "",
"Edit": "",
"Create": ""
},
"Cards": {
"Read": "",
"Edit": "",
"Create": ""
},
"BankAccounts": {
"Read": "",
"Edit": "",
"Create": ""
},
"PreAuthorizations": {
"Read": "",
"Edit": "",
"Create": ""
},
"Payins": {
"Read": "",
"Edit": "",
"Create": ""
},
"Transfers": {
"Read": "",
"Edit": "",
"Create": ""
},
"Payouts": {
"Read": "",
"Edit": "",
"Create": ""
},
"Refunds": {
"Read": "",
"Edit": "",
"Create": ""
},
"Transactions": {
"Read": "",
"Edit": "",
"Create": ""
},
"KYCDocuments": {
"Read": "",
"Edit": "",
"Create": ""
},
"Disputes": {
"Read": "",
"Edit": "",
"Create": ""
},
"Repudiations": {
"Read": "",
"Edit": "",
"Create": ""
},
"Mandates": {
"Read": "",
"Edit": "",
"Create": ""
},
"Reporting": {
"Read": "",
"Edit": "",
"Create": ""
},
"Responses": {
"Read": "",
"Edit": "",
"Create": ""
},
"Events": {
"Read": "",
"Edit": "",
"Create": ""
},
"Hooks": {
"Read": "",
"Edit": "",
"Create": ""
}
}
}

Update a Permission Group

A default Permission Group ( with "Id" = "ADMIN", "WRITE" or "READ" ) CANNOT be modified.

PUT .../v2.01/ClientId

The ID of your client account

/clients/PermissionGroups/PermissionGroupId

Id of a permission group

/

Parameters

Tag
string

string:

Maximum length is 255 characters

optional

Custom data that you can add to this item

Name
string

string:

Maximum length is 255 characters

optional

The name of the permission group

Scopes
Scopes

Scopes:

View Sub-parameters

optional

The Scopes of the permissions

Scopes.ClientDetails
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client details

Scopes.ClientDetails.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientDetails.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientDetails.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientLogo
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client logo

Scopes.ClientLogo.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientLogo.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientLogo.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientWallets
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client wallets

Scopes.ClientWallets.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientWallets.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientWallets.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientBankAccounts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client bank accounts

Scopes.ClientBankAccounts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientBankAccounts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientBankAccounts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientPayins
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client payins

Scopes.ClientPayins.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientPayins.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientPayins.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientPayouts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client payouts

Scopes.ClientPayouts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientPayouts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientPayouts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.ClientTransactions
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to client transactions

Scopes.ClientTransactions.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.ClientTransactions.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.ClientTransactions.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.SSOs
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to SSOs

Scopes.SSOs.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.SSOs.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.SSOs.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.PermissionGroups
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to permission groups

Scopes.PermissionGroups.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.PermissionGroups.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.PermissionGroups.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Users
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to users

Scopes.Users.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Users.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Users.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Wallets
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to wallets

Scopes.Wallets.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Wallets.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Wallets.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.BankingAliases
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to banking aliases

Scopes.BankingAliases.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.BankingAliases.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.BankingAliases.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Cards
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to cards

Scopes.Cards.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Cards.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Cards.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.BankAccounts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to bank accounts

Scopes.BankAccounts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.BankAccounts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.BankAccounts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.PreAuthorizations
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to preauthorizations

Scopes.PreAuthorizations.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.PreAuthorizations.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.PreAuthorizations.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Payins
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to payins

Scopes.Payins.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Payins.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Payins.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Transfers
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to transfers

Scopes.Transfers.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Transfers.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Transfers.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Payouts
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to payouts

Scopes.Payouts.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Payouts.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Payouts.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Refunds
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to refunds

Scopes.Refunds.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Refunds.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Refunds.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Transactions
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to transactions

Scopes.Transactions.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Transactions.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Transactions.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.KYCDocuments
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to KYC documents

Scopes.KYCDocuments.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.KYCDocuments.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.KYCDocuments.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Disputes
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to disputes

Scopes.Disputes.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Disputes.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Disputes.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Repudiations
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to repudiations

Scopes.Repudiations.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Repudiations.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Repudiations.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Mandates
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to mandates

Scopes.Mandates.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Mandates.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Mandates.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Reporting
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to reporting

Scopes.Reporting.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Reporting.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Reporting.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Responses
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to responses

Scopes.Responses.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Responses.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Responses.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Events
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to events

Scopes.Events.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Events.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Events.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

Scopes.Hooks
Permissions

Permissions:

View Sub-parameters

optional

API endpoints linked to hooks

Scopes.Hooks.Read
bool

bool:

true, false

optional

allows GET requests on the related endpoints

Scopes.Hooks.Edit
bool

bool:

true, false

optional

allows PUT requests on the related endpoints

Scopes.Hooks.Create
bool

bool:

true, false

optional

allows POST requests on the related endpoints

  • View
  • Code
  • Run
  • View
  • Code
  • Run
PUT .../clients/PermissionGroups/:PermissionGroupId/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"Name": "Users only",
"Scopes": {
"ClientDetails": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientLogo": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientWallets": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientBankAccounts": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientPayins": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientPayouts": {
"Read": false,
"Edit": false,
"Create": false
},
"ClientTransactions": {
"Read": false,
"Edit": false,
"Create": false
},
"SSOs": {
"Read": false,
"Edit": false,
"Create": false
},
"PermissionGroups": {
"Read": false,
"Edit": false,
"Create": false
},
"Users": {
"Read": false,
"Edit": false,
"Create": false
},
"Wallets": {
"Read": false,
"Edit": false,
"Create": false
},
"BankingAliases": {
"Read": false,
"Edit": false,
"Create": false
},
"Cards": {
"Read": false,
"Edit": false,
"Create": false
},
"BankAccounts": {
"Read": false,
"Edit": false,
"Create": false
},
"PreAuthorizations": {
"Read": false,
"Edit": false,
"Create": false
},
"Payins": {
"Read": false,
"Edit": false,
"Create": false
},
"Transfers": {
"Read": false,
"Edit": false,
"Create": false
},
"Payouts": {
"Read": false,
"Edit": false,
"Create": false
},
"Refunds": {
"Read": false,
"Edit": false,
"Create": false
},
"Transactions": {
"Read": false,
"Edit": false,
"Create": false
},
"KYCDocuments": {
"Read": false,
"Edit": false,
"Create": false
},
"Disputes": {
"Read": false,
"Edit": false,
"Create": false
},
"Repudiations": {
"Read": false,
"Edit": false,
"Create": false
},
"Mandates": {
"Read": false,
"Edit": false,
"Create": false
},
"Reporting": {
"Read": false,
"Edit": false,
"Create": false
},
"Responses": {
"Read": false,
"Edit": false,
"Create": false
},
"Events": {
"Read": false,
"Edit": false,
"Create": false
},
"Hooks": {
"Read": false,
"Edit": false,
"Create": false
}
}
}
require_once("mangopay.php");

try {

$ = new \MangoPay\();
$->Tag = "custom meta";
$->Name = "Users only";
$->Scopes = new \MangoPay\();
$->Scopes->ClientDetails = new \MangoPay\();
$->Scopes->ClientDetails->Read = false;
$->Scopes->ClientDetails->Edit = false;
$->Scopes->ClientDetails->Create = false;
$->Scopes->ClientLogo = new \MangoPay\();
$->Scopes->ClientLogo->Read = false;
$->Scopes->ClientLogo->Edit = false;
$->Scopes->ClientLogo->Create = false;
$->Scopes->ClientWallets = new \MangoPay\();
$->Scopes->ClientWallets->Read = false;
$->Scopes->ClientWallets->Edit = false;
$->Scopes->ClientWallets->Create = false;
$->Scopes->ClientBankAccounts = new \MangoPay\();
$->Scopes->ClientBankAccounts->Read = false;
$->Scopes->ClientBankAccounts->Edit = false;
$->Scopes->ClientBankAccounts->Create = false;
$->Scopes->ClientPayins = new \MangoPay\();
$->Scopes->ClientPayins->Read = false;
$->Scopes->ClientPayins->Edit = false;
$->Scopes->ClientPayins->Create = false;
$->Scopes->ClientPayouts = new \MangoPay\();
$->Scopes->ClientPayouts->Read = false;
$->Scopes->ClientPayouts->Edit = false;
$->Scopes->ClientPayouts->Create = false;
$->Scopes->ClientTransactions = new \MangoPay\();
$->Scopes->ClientTransactions->Read = false;
$->Scopes->ClientTransactions->Edit = false;
$->Scopes->ClientTransactions->Create = false;
$->Scopes->SSOs = new \MangoPay\();
$->Scopes->SSOs->Read = false;
$->Scopes->SSOs->Edit = false;
$->Scopes->SSOs->Create = false;
$->Scopes->PermissionGroups = new \MangoPay\();
$->Scopes->PermissionGroups->Read = false;
$->Scopes->PermissionGroups->Edit = false;
$->Scopes->PermissionGroups->Create = false;
$->Scopes->Users = new \MangoPay\();
$->Scopes->Users->Read = false;
$->Scopes->Users->Edit = false;
$->Scopes->Users->Create = false;
$->Scopes->Wallets = new \MangoPay\();
$->Scopes->Wallets->Read = false;
$->Scopes->Wallets->Edit = false;
$->Scopes->Wallets->Create = false;
$->Scopes->BankingAliases = new \MangoPay\();
$->Scopes->BankingAliases->Read = false;
$->Scopes->BankingAliases->Edit = false;
$->Scopes->BankingAliases->Create = false;
$->Scopes->Cards = new \MangoPay\();
$->Scopes->Cards->Read = false;
$->Scopes->Cards->Edit = false;
$->Scopes->Cards->Create = false;
$->Scopes->BankAccounts = new \MangoPay\();
$->Scopes->BankAccounts->Read = false;
$->Scopes->BankAccounts->Edit = false;
$->Scopes->BankAccounts->Create = false;
$->Scopes->PreAuthorizations = new \MangoPay\();
$->Scopes->PreAuthorizations->Read = false;
$->Scopes->PreAuthorizations->Edit = false;
$->Scopes->PreAuthorizations->Create = false;
$->Scopes->Payins = new \MangoPay\();
$->Scopes->Payins->Read = false;
$->Scopes->Payins->Edit = false;
$->Scopes->Payins->Create = false;
$->Scopes->Transfers = new \MangoPay\();
$->Scopes->Transfers->Read = false;
$->Scopes->Transfers->Edit = false;
$->Scopes->Transfers->Create = false;
$->Scopes->Payouts = new \MangoPay\();
$->Scopes->Payouts->Read = false;
$->Scopes->Payouts->Edit = false;
$->Scopes->Payouts->Create = false;
$->Scopes->Refunds = new \MangoPay\();
$->Scopes->Refunds->Read = false;
$->Scopes->Refunds->Edit = false;
$->Scopes->Refunds->Create = false;
$->Scopes->Transactions = new \MangoPay\();
$->Scopes->Transactions->Read = false;
$->Scopes->Transactions->Edit = false;
$->Scopes->Transactions->Create = false;
$->Scopes->KYCDocuments = new \MangoPay\();
$->Scopes->KYCDocuments->Read = false;
$->Scopes->KYCDocuments->Edit = false;
$->Scopes->KYCDocuments->Create = false;
$->Scopes->Disputes = new \MangoPay\();
$->Scopes->Disputes->Read = false;
$->Scopes->Disputes->Edit = false;
$->Scopes->Disputes->Create = false;
$->Scopes->Repudiations = new \MangoPay\();
$->Scopes->Repudiations->Read = false;
$->Scopes->Repudiations->Edit = false;
$->Scopes->Repudiations->Create = false;
$->Scopes->Mandates = new \MangoPay\();
$->Scopes->Mandates->Read = false;
$->Scopes->Mandates->Edit = false;
$->Scopes->Mandates->Create = false;
$->Scopes->Reporting = new \MangoPay\();
$->Scopes->Reporting->Read = false;
$->Scopes->Reporting->Edit = false;
$->Scopes->Reporting->Create = false;
$->Scopes->Responses = new \MangoPay\();
$->Scopes->Responses->Read = false;
$->Scopes->Responses->Edit = false;
$->Scopes->Responses->Create = false;
$->Scopes->Events = new \MangoPay\();
$->Scopes->Events->Read = false;
$->Scopes->Events->Edit = false;
$->Scopes->Events->Create = false;
$->Scopes->Hooks = new \MangoPay\();
$->Scopes->Hooks->Read = false;
$->Scopes->Hooks->Edit = false;
$->Scopes->Hooks->Create = false;
$->Id = 8494514;

$Result = $Api->->($);

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
PUT .../clients/PermissionGroups// HTTP/1.1
Body Parameters :
{
"Tag": "",
"Name": "",
"Scopes": {
"ClientDetails": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientLogo": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientWallets": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientBankAccounts": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientPayins": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientPayouts": {
"Read": "",
"Edit": "",
"Create": ""
},
"ClientTransactions": {
"Read": "",
"Edit": "",
"Create": ""
},
"SSOs": {
"Read": "",
"Edit": "",
"Create": ""
},
"PermissionGroups": {
"Read": "",
"Edit": "",
"Create": ""
},
"Users": {
"Read": "",
"Edit": "",
"Create": ""
},
"Wallets": {
"Read": "",
"Edit": "",
"Create": ""
},
"BankingAliases": {
"Read": "",
"Edit": "",
"Create": ""
},
"Cards": {
"Read": "",
"Edit": "",
"Create": ""
},
"BankAccounts": {
"Read": "",
"Edit": "",
"Create": ""
},
"PreAuthorizations": {
"Read": "",
"Edit": "",
"Create": ""
},
"Payins": {
"Read": "",
"Edit": "",
"Create": ""
},
"Transfers": {
"Read": "",
"Edit": "",
"Create": ""
},
"Payouts": {
"Read": "",
"Edit": "",
"Create": ""
},
"Refunds": {
"Read": "",
"Edit": "",
"Create": ""
},
"Transactions": {
"Read": "",
"Edit": "",
"Create": ""
},
"KYCDocuments": {
"Read": "",
"Edit": "",
"Create": ""
},
"Disputes": {
"Read": "",
"Edit": "",
"Create": ""
},
"Repudiations": {
"Read": "",
"Edit": "",
"Create": ""
},
"Mandates": {
"Read": "",
"Edit": "",
"Create": ""
},
"Reporting": {
"Read": "",
"Edit": "",
"Create": ""
},
"Responses": {
"Read": "",
"Edit": "",
"Create": ""
},
"Events": {
"Read": "",
"Edit": "",
"Create": ""
},
"Hooks": {
"Read": "",
"Edit": "",
"Create": ""
}
}
}

View a Permission Group

GET .../v2.01/ClientId

The ID of your client account

/clients/PermissionGroups/PermissionGroupId

Id of a permission group

/
  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../clients/PermissionGroups/:PermissionGroupId/ HTTP/1.1
require_once("mangopay.php");

try {

$PermissionGroupId = 8494514;

$ = $Api->->($PermissionGroupId);

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
GET .../clients/PermissionGroups// HTTP/1.1

List all Permission Groups

GET .../v2.01/ClientId

The ID of your client account

/clients/permissiongroups/

Get parameters

Page
int

int

optional

The page number of results you wish to return

Per_Page
int

int

optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

The column to sort against and direction, separated by a :

optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
  • Run
  • View
  • Code
  • Run
GET .../clients/permissiongroups/ HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
require_once("mangopay.php");

try {

$Page = 1;
$Per_Page = 25;
$Sort = "CreationDate:DESC";

$ = $Api->->($Page, $Per_Page, $Sort);

} catch(MangoPay\Libraries\ResponseException $e) {
// handle/log the response exception with code $e->GetCode(), message $e->GetMessage() and error(s) $e->GetErrorDetails()

} catch(MangoPay\Libraries\Exception $e) {
// handle/log the exception $e->GetMessage()

}
GET .../clients/permissiongroups/ HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}