Scopes limit the resources or actions you can access in the API. Your user has a list of valid scopes you are allowed to access. When authenticating you can also create a Bearer Token that is only allowed to access some of the scopes your user has access to.
All possible scopes are listed below. Your user will have access to some or all of these scopes.
urn:v2:customers:all -
POST,
PATCH,
PUT, and
GET
/customersurn:v2:distributions:all -
GET /distributionsurn:v2:merchants:all -
POST,
PATCH,
PUT,
GET, and
DELETE
/merchantsurn:v2:merchants:read -
GET /merchantsurn:v2:accounts:all -
POST,
PUT,
GET, and
DELETE
/accountsurn:v2:accounts:read -
GET /accountsurn:v2:channels:all -
POST and
GET
/channelsurn:v2:conversations:all -
POST,
GET, and
PATCH
/conversations;
GET /items;
POST /closeurn:v2:messages:all -
POST and
GET
/messagesurn:v2:partners:read -
GET /partnersurn:v2:charges:all -
POST,
PATCH, and
GET
/charges;urn:v2:refunds:all -
POST and
GET
/refundsurn:v2:tokens:all -
POST,
PUT, and
GET
/tokensurn:v2:devices:all -
GET
/devicesurn:v2:charges:distribute:create -
POST /charges/{charge_id}/distributeurn:v2:plugins:all -
POST and
GET
/pluginsurn:v2:plugins:enrollment:create:prepopulate-processing-info -
Allow pre-populating processing information fields using
data.account.processing in
POST /plugins/enrollmentThe following scopes are used by portions of the API to call other portions of the API on your behalf. For example, when you use plugins, the Plugin API will call other APIs such as Payment API or Enrollment API on your behalf. The following scopes will show up in your list of available scopes. However, there is no point in adding these scopes to tokens you generate as they will not affect functionality.
urn:v2:accounts:plugins - Enrollment Plugin access to Accountsurn:v2:merchants:plugins - Enrollment Plugin access to Merchantsurn:v2:plugins:clienturn:v2:plugins:plugins