All OAuth 2.0 clients and access tokens have a scope that restricts the clients' access to the endpoints. Depending on the scope granted, a client can have read or write access to an endpoint.
You can define scopes when creating an API Client using the
Merchant Center or through the
API Clients API. When creating a client or requesting an access token, only provide scopes required by your application. If you do not provide a scope, the access token is granted to all the scopes defined for the API Client. When requesting an OAuth 2.0 access token, the scope parameter can be omitted.
Checkout Sessions
| Merchant Center scope | API scope | Description |
|---|
| View > Checkout sessions | view_sessions:{projectKey} | Grants permission to read Checkout Sessions to interact with Checkout; for example, it is required for Connectors to interact with Checkout. |
| Manage > Checkout sessions | manage_sessions:{projectKey} | Grants permission to create a Checkout Session using the Session API. |
Applications
| Merchant Center scope | API scope | Description |
|---|
| View > Checkout applications | view_checkout_applications:{projectKey} | Grants permission to view Applications belonging to a Project. |
| Manage > Checkout applications | manage_checkout_applications:{projectKey} | Grants permission to view, create, update, and delete Applications belonging to a Project. |
Payment Integrations
| Merchant Center scope | API scope | Description |
|---|
| View > Checkout payment integrations | view_checkout_payment_integrations:{projectKey} | Grants permission to view Payment Integrations integrated into a checkout application. |
| Manage > Checkout payment integrations | manage_checkout_payment_integrations:{projectKey} | Grants permission to view, create, update, and delete Payment Integrations integrated into a checkout application. |
Payment Intents
| Merchant Center scope | API scope | Description |
|---|
| Manage > Checkout payment intents | manage_checkout_payment_intents:{projectKey} | Grants permission to capture, refund, reverse, or cancel payments made through a payment service provider (PSP) or a gift card service provider. |
Transactions BETA
| Merchant Center scope | API scope | Description |
|---|
| View > Checkout transactions | view_checkout_transactions:{projectKey} | Grants permission to view Transactions created during payment processing with Checkout. |
| Manage > Checkout transactions | manage_checkout_transactions:{projectKey} | Grants permission to create Transactions during payment processing with Checkout. |