{"title":"Roles for API credentials","category":"default","creationDate":1683102180,"content":"<p>API credentials use web service (ws) roles to define exactly which actions you can perform. While Adyen assigns a set of default roles when your company account is created, you may need to enable additional <a href=\"\/pt\/marketplaces\/manage-access\/api-credentials-web-service\/#api-permissions\">roles<\/a> in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a> to unlock specific  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration API<\/a> or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a> functionality. These roles specify what API requests a user can perform with this credential.<\/p>\n<h2 id=\"requirements-table\">Requirements<\/h2>\n<p>Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">You must have the <a href=\"\/pt\/platforms\/\">Adyen for Platforms<\/a> integration.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/api-credentials\/\">API credentials<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">You must have a <a href=\"\/pt\/marketplaces\/manage-access\/api-credentials-web-service?tab=create-ws_1\">Balance Platform API key<\/a> (for example, <strong>ws[_123456]@BalancePlatform.[YourBalancePlatform]<\/strong>) to access the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Configuration API<\/a> and  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Frequently used roles<\/h2>\n<p>The following tabs show the most frequently used web service roles that are available in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n\n<div id=\"tabO1Kih\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Balance platform configuration&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;You can use the following roles to make requests related to balance platform configuration.&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Web service role&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;Balance Platform BCL role&lt;\\\/td&gt;\\n&lt;td&gt;You can create, update, and delete resources in your balance platform. For example: account holders, balance accounts, or transfer instruments.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;Balance Platform BCL PCI role&lt;\\\/td&gt;\\n&lt;td&gt;You can unmask and view PANs and CVVs\\\/CVCs in the response of a POST &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/balanceplatform\\\/latest\\\/post\\\/paymentInstruments\\&quot; class=\\&quot;codeLabel external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;\\\/paymentInstruments&lt;\\\/a&gt; request. &lt;div class=\\&quot;notices yellow\\&quot;&gt;To use this role, you must also have the Balance Platform BCL role enabled.&lt;\\\/div&gt;&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;balance_platform_configuration_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Issuing&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;The following table shows roles that you use if your integration includes the Adyen Issuing solution.&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Web service role&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;Bank SCA Webservice Role&lt;\\\/td&gt;\\n&lt;td&gt;You can manage device registration for &lt;a href=\\&quot;\\\/pt\\\/get-started-with-adyen\\\/adyen-glossary\\\/#strong-customer-authentication-sca\\&quot;&gt;Strong Customer Authentication&lt;\\\/a&gt; (SCA).&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;Bank Manage TransactionRules role&lt;\\\/td&gt;\\n&lt;td&gt;You can manage the &lt;a href=\\&quot;\\\/pt\\\/risk-management\\\/configure-manual-risk\\\/standard-risk-rules\\&quot;&gt;risk engine rules&lt;\\\/a&gt; for your platform.&lt;br&gt;All the permissions granted by this role are included in the Balance Platform BCL role.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;issuing_1_2&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Transfers&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;The following table shows roles that you use to make requests related to fund transfers.&lt;\\\/p&gt;\\n&lt;table&gt;\\n&lt;thead&gt;\\n&lt;tr&gt;\\n&lt;th&gt;Web service role&lt;\\\/th&gt;\\n&lt;th&gt;Description&lt;\\\/th&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/thead&gt;\\n&lt;tbody&gt;\\n&lt;tr&gt;\\n&lt;td&gt;Bank Transfer Initiation Webservice role&lt;\\\/td&gt;\\n&lt;td&gt;You can initiate transfers. &lt;div class=\\&quot;sc-notice note\\&quot;&gt;&lt;div&gt; This is only available for Transfers API &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/transfers\\\/1\\\/overview\\&quot; class=\\&quot;codeLabel external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;v1&lt;\\\/a&gt;. &lt;\\\/div&gt;&lt;\\\/div&gt;&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;TransferService Webservice Initiate role&lt;\\\/td&gt;\\n&lt;td&gt;You can initiate transfers.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;tr&gt;\\n&lt;td&gt;TransferService Webservice Retrieve role&lt;\\\/td&gt;\\n&lt;td&gt;You can view initiated transfers.&lt;\\\/td&gt;\\n&lt;\\\/tr&gt;\\n&lt;\\\/tbody&gt;\\n&lt;\\\/table&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;transfers_2_3&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/marketplaces\/manage-access\"\n                        target=\"_self\"\n                        >\n                    Manage access for your team\n                <\/a><\/li><\/ul><\/div>\n\n","url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/manage-access\/webservice-roles","articleFields":{"description":"Learn what roles your API credential needs to perform an action","feedback_component":true,"type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"03-05-2023 10:25","parameters":{"directoryPath":"\/marketplaces","model":"marketplace"},"filters_component":false},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/marketplaces\/manage-access\/webservice-roles","title":"Roles for API credentials","content":"API credentials use web service (ws) roles to define exactly which actions you can perform. While Adyen assigns a set of default roles when your company account is created, you may need to enable additional roles in your Customer Area to unlock specific  Configuration API or  Transfers API functionality. These roles specify what API requests a user can perform with this credential.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have the Adyen for Platforms integration.\n\n\nAPI credentials\nYou must have a Balance Platform API key (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]) to access the  Configuration API and  Transfers API.\n\n\n\nFrequently used roles\nThe following tabs show the most frequently used web service roles that are available in your Customer Area.\n\n\n    \n        \n        \n    \n\n\nSee also\n\n\n                    Manage access for your team\n                \n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Marketplaces","lvl2":"Manage access for your team","lvl3":"Roles for API credentials"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/marketplaces","lvl2":"https:\/\/docs.adyen.com\/pt\/marketplaces\/manage-access","lvl3":"\/pt\/marketplaces\/manage-access\/webservice-roles"},"levels":4,"category":"Marketplaces","category_color":"green","tags":["Roles","credentials"]}}
