{"title":"Open banking","category":"default","creationDate":1776961628,"content":"<p>Open banking is a regulatory initiative that was introduced in Europe in 2018 through the Revised Payment Services Directive (<a href=\"https:\/\/www.adyen.com\/knowledge-hub\/psd2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">PSD2<\/a>. It requires financial institutions, such as Adyen, to provide secure access to their customers' data and allow third-party providers to initiate payments on behalf of the customer with the customer's explicit consent. Adyen provides secure open banking APIs that let third-party service providers interact with Adyen business accounts and get the account holders' consent for those interactions.<\/p>\n<p>This documentation is for third-party providers and explains how they can interact with Adyen business accounts to:<\/p>\n<ul>\n<li>Retrieve account information<\/li>\n<li>Initiate payments<\/li>\n<li>\n<p>Confirm funds<\/p>\n<p><div class=\"sc-notice note\"><div> This is not <a href=\"\/pt\/payment-methods\/pay-by-bank-europe\">Pay by Bank (Europe)<\/a> or <a href=\"\/pt\/payment-methods\/pay-by-bank-us\">Pay by Bank (US)<\/a> , which is a specific payment method within Checkout.<\/p>\n<\/div><\/div>\n<\/li>\n<\/ul>\n<h2>Requirements<\/h2>\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;\">Not applicable; this documentation is intended for third-party providers.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\">This documentation is for the EU region only. For UK documentation, see the <a href=\"https:\/\/openbankinguk.github.io\/read-write-api-site3\/v4.0\/profiles\/read-write-data-api-profile.html\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Open Banking documentation<\/a>. Also, see a list of <a href=\"#supported-countries-and-regions\">supported countries and regions<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">If you are a third-party service provider seeking access to Adyen's open banking interfaces, you must: <ul><li>Be licensed by a national regulatory authority.<\/li><li>Have a Qualified Website Authentication Certificate (QWAC). This can be obtained from <a href=\"https:\/\/webgate.ec.europa.eu\/tl-browser\/#\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Qualified Trusted Service Providers<\/a> (QTSP).<\/li><li>Complete the <a href=\"#onboard-with-adyen\">Adyen onboarding steps<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Adyen open banking APIs<\/h2>\n<p>Adyen's open banking interface provides a secure and reliable way for third-party providers to access Adyen's APIs and interact with the data of Adyen business accounts. This involves the use of APIs that allow third-party providers to access and use financial data from financial institutions. Typically, the Adyen open banking flow has three participants:<\/p>\n<ul>\n<li><strong>Adyen business account holder<\/strong>: This is an account holder that has a business account with Adyen, often referred to as the <em>payment service user<\/em> in the open banking industry.<\/li>\n<li><strong>A third-party provider<\/strong>:\n<ul>\n<li>An <strong>account information service provider (AISP)<\/strong>: a third-party provider that requests information about Adyen business accounts.<\/li>\n<li>A <strong>payment initiation service provider (PISP)<\/strong>: a third-party provider that initiates payments from Adyen business accounts.<\/li>\n<li>A <strong>payment instrument issuer service provider (PIISP)<\/strong>: a third-party provider that requests information about the available funds in Adyen business accounts.<\/li>\n<\/ul><\/li>\n<li><strong>Account servicing payment service provider<\/strong>: Adyen, as the financial institution that manages the business accounts of the account holders.<\/li>\n<\/ul>\n<p>Adyen provides third-party providers with the following regulatory APIs:<\/p>\n<ul>\n<li><strong>Open Banking API for the EU<\/strong>: Follows the <a href=\"https:\/\/www.berlin-group.org\/nextgenpsd2-downloads\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">NextGenPSD2<\/a> standard created by <a href=\"https:\/\/www.berlin-group.org\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">The Berlin Group<\/a>.<\/li>\n<li><strong>Open Banking API for the UK<\/strong>: Follows the <a href=\"https:\/\/standards.openbanking.org.uk\/api-specifications\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Open Banking API specifications<\/a> created by <a href=\"https:\/\/www.openbanking.org.uk\/about-us\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Open Banking Limited<\/a>.<\/li>\n<\/ul>\n<h3>Base URL and API structure<\/h3>\n<p>The table below describes the structure of each API request URL.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Description<\/th>\n<th style=\"text-align: left;\">Value<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Test base URL<\/strong><\/td>\n<td style=\"text-align: left;\"><code>https:\/\/openbanking-psd2-test.adyen.com<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Live base live URL<\/strong><\/td>\n<td style=\"text-align: left;\"><code>https:\/\/openbanking-psd2-live.adyen.com<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Region identifier<\/strong><\/td>\n<td style=\"text-align: left;\"><ul><li><code>obeu<\/code> for EU APIs.<\/li><li><code>obuk<\/code> for UK APIs.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Third-party providers<\/strong><\/td>\n<td style=\"text-align: left;\"><ul><li><code>\/asip<\/code> for account information service providers for EU APIs.<\/li><li><code>\/pisp<\/code> for payment initiation service providers.<\/li><li><code>\/piis<\/code> for payment instrument issuer service providers.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>API version<\/strong><\/td>\n<td style=\"text-align: left;\">The version of the API. Currently, <code>\/v1<\/code> is supported.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Endpoint<\/strong><\/td>\n<td style=\"text-align: left;\">The specific resource you are accessing (for example, <code>\/accounts<\/code>).<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><strong>Example URL<\/strong><br \/>\n<code>https:\/\/openbanking-psd2-live.adyen.com\/obeu\/pisp\/v1\/accounts<\/code><\/p>\n<h2>How it works<\/h2>\n<p>The typical open banking flow with Adyen is as follows:<\/p>\n<ol>\n<li>An account holder requests a service from a third-party provider. The third-party provider can only ask for those scopes agreed to by the account holder.<\/li>\n<li>The third-party provider requests the account holder to:\n<ol>\n<li>Authenticate themselves with Adyen.<\/li>\n<li>Provide consent to Adyen to allow the third-party provider to perform the requested service.<\/li>\n<\/ol><\/li>\n<li>If the previous step is successful, Adyen allows the third-party provider to use the open banking API.<\/li>\n<li>Adyen sends the requested information through the open banking API.<\/li>\n<\/ol>\n<h2>Onboard with Adyen<\/h2>\n<p>To integrate with the Adyen's open banking interface, third-party providers need to register and obtain the necessary credentials to access the APIs. They also need to ensure that their systems comply with the relevant security and data protection requirements. Third-party service provider must be licensed by a national regulatory authority and have a Qualified Website Authentication Certificate (QWAC). This can be obtained from <a href=\"https:\/\/webgate.ec.europa.eu\/tl-browser\/#\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Qualified Trusted Service Providers<\/a> (QTSP).<\/p>\n<ol>\n<li>\n<p>To onboard with Adyen as a third-party provider, gather the required information:<\/p>\n<ul>\n<li><strong>QWAC certificate<\/strong>: PEM-formatted QWAC certificate file. Add the certificate as an attachment.<\/li>\n<li><strong>Redirect URL<\/strong>: This URL used to redirect successful authentications with the authorization code.<\/li>\n<li><strong>Third-party provider website<\/strong>: Your website URL.<\/li>\n<li><strong>Scopes<\/strong>: The scopes to be enabled for your OAuth client. The available scopes are:\n<ul>\n<li><strong>AISP<\/strong><\/li>\n<li><strong>PISP<\/strong><\/li>\n<li><strong>PIISP<\/strong><\/li>\n<\/ul><\/li>\n<\/ul>\n<\/li>\n<li>\n<p>Send an email to <a href=\"mailto:openbanking@adyen.com\" class=\"mailto\">openbanking@adyen.com<\/a>. Adyen reviews your information and sends you the <strong>client ID<\/strong> and <strong>client secret<\/strong> used in the <a href=\"\/pt\/business-accounts\/oauth-flow\">OAuth flow<\/a> to get access token.<\/p>\n<\/li>\n<\/ol>\n<h2>Supported countries and regions<\/h2>\n<p>The table shows the supported countries and regions, and availability. This documentation is for the EU region only. For UK documentation, see the <a href=\"https:\/\/openbankinguk.github.io\/read-write-api-site3\/v4.0\/profiles\/read-write-data-api-profile.html\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Open Banking documentation<\/a>.<\/p>\n<table>\n<thead>\n<tr>\n<th>Countries\/regions<\/th>\n<th style=\"text-align: center;\">Account information<\/th>\n<th>Payment<\/th>\n<th style=\"text-align: left;\">Funds check<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>EU<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<tr>\n<td>UK<\/td>\n<td style=\"text-align: center;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><br><\/p>","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/open-banking","articleFields":{"description":"Learn how to integrate with the Adyen Open Banking platform.","feedback_component":true,"id":"31504141","type":"page","_expandable":{"operations":""},"status":"current","section_label":"Open banking","next_steps":[{"title":"Authentication","description":"Implement OAuth 2.0 to enable secure communication with Adyen.","url":"\/business-accounts\/oauth-flow","required":true},{"title":"Consent interface","description":"Learn how to manage user consents with our dedicated endpoints.","url":"\/business-accounts\/consent","required":true},{"title":"AISP interface","description":"Learn how to consume our dedicated AISP endpoints.","url":"\/business-accounts\/aisp","required":false},{"title":"PISP interface","description":"Learn how to consume our dedicated PISP endpoints.","url":"\/business-accounts\/pisp","required":false},{"title":"PIISP interface","description":"Learn how to consume our dedicated PIISP endpoints.","url":"\/business-accounts\/piisp","required":false}],"parameters":{"directoryPath":"\/business-accounts","model":"balance platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/open-banking","title":"Open banking","content":"Open banking is a regulatory initiative that was introduced in Europe in 2018 through the Revised Payment Services Directive (PSD2. It requires financial institutions, such as Adyen, to provide secure access to their customers' data and allow third-party providers to initiate payments on behalf of the customer with the customer's explicit consent. Adyen provides secure open banking APIs that let third-party service providers interact with Adyen business accounts and get the account holders' consent for those interactions.\nThis documentation is for third-party providers and explains how they can interact with Adyen business accounts to:\n\nRetrieve account information\nInitiate payments\n\nConfirm funds\n This is not Pay by Bank (Europe) or Pay by Bank (US) , which is a specific payment method within Checkout.\n\n\n\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nNot applicable; this documentation is intended for third-party providers.\n\n\nLimitations\nThis documentation is for the EU region only. For UK documentation, see the Open Banking documentation. Also, see a list of supported countries and regions.\n\n\nSetup steps\nIf you are a third-party service provider seeking access to Adyen's open banking interfaces, you must: Be licensed by a national regulatory authority.Have a Qualified Website Authentication Certificate (QWAC). This can be obtained from Qualified Trusted Service Providers (QTSP).Complete the Adyen onboarding steps.\n\n\n\nAdyen open banking APIs\nAdyen's open banking interface provides a secure and reliable way for third-party providers to access Adyen's APIs and interact with the data of Adyen business accounts. This involves the use of APIs that allow third-party providers to access and use financial data from financial institutions. Typically, the Adyen open banking flow has three participants:\n\nAdyen business account holder: This is an account holder that has a business account with Adyen, often referred to as the payment service user in the open banking industry.\nA third-party provider:\n\nAn account information service provider (AISP): a third-party provider that requests information about Adyen business accounts.\nA payment initiation service provider (PISP): a third-party provider that initiates payments from Adyen business accounts.\nA payment instrument issuer service provider (PIISP): a third-party provider that requests information about the available funds in Adyen business accounts.\n\nAccount servicing payment service provider: Adyen, as the financial institution that manages the business accounts of the account holders.\n\nAdyen provides third-party providers with the following regulatory APIs:\n\nOpen Banking API for the EU: Follows the NextGenPSD2 standard created by The Berlin Group.\nOpen Banking API for the UK: Follows the Open Banking API specifications created by Open Banking Limited.\n\nBase URL and API structure\nThe table below describes the structure of each API request URL.\n\n\n\nDescription\nValue\n\n\n\n\nTest base URL\nhttps:\/\/openbanking-psd2-test.adyen.com\n\n\nLive base live URL\nhttps:\/\/openbanking-psd2-live.adyen.com\n\n\nRegion identifier\nobeu for EU APIs.obuk for UK APIs.\n\n\nThird-party providers\n\/asip for account information service providers for EU APIs.\/pisp for payment initiation service providers.\/piis for payment instrument issuer service providers.\n\n\nAPI version\nThe version of the API. Currently, \/v1 is supported.\n\n\nEndpoint\nThe specific resource you are accessing (for example, \/accounts).\n\n\n\nExample URL\nhttps:\/\/openbanking-psd2-live.adyen.com\/obeu\/pisp\/v1\/accounts\nHow it works\nThe typical open banking flow with Adyen is as follows:\n\nAn account holder requests a service from a third-party provider. The third-party provider can only ask for those scopes agreed to by the account holder.\nThe third-party provider requests the account holder to:\n\nAuthenticate themselves with Adyen.\nProvide consent to Adyen to allow the third-party provider to perform the requested service.\n\nIf the previous step is successful, Adyen allows the third-party provider to use the open banking API.\nAdyen sends the requested information through the open banking API.\n\nOnboard with Adyen\nTo integrate with the Adyen's open banking interface, third-party providers need to register and obtain the necessary credentials to access the APIs. They also need to ensure that their systems comply with the relevant security and data protection requirements. Third-party service provider must be licensed by a national regulatory authority and have a Qualified Website Authentication Certificate (QWAC). This can be obtained from Qualified Trusted Service Providers (QTSP).\n\n\nTo onboard with Adyen as a third-party provider, gather the required information:\n\nQWAC certificate: PEM-formatted QWAC certificate file. Add the certificate as an attachment.\nRedirect URL: This URL used to redirect successful authentications with the authorization code.\nThird-party provider website: Your website URL.\nScopes: The scopes to be enabled for your OAuth client. The available scopes are:\n\nAISP\nPISP\nPIISP\n\n\n\n\nSend an email to openbanking@adyen.com. Adyen reviews your information and sends you the client ID and client secret used in the OAuth flow to get access token.\n\n\nSupported countries and regions\nThe table shows the supported countries and regions, and availability. This documentation is for the EU region only. For UK documentation, see the Open Banking documentation.\n\n\n\nCountries\/regions\nAccount information\nPayment\nFunds check\n\n\n\n\nEU\n\n\n\n\n\nUK\n\n\n\n\n\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Open banking"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"\/pt\/business-accounts\/open-banking"},"levels":3,"category":"","category_color":"","tags":["banking"]},"articleFiles":{"adyen-connect-button.png":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/user\/pages\/docs\/07.business-accounts\/28.open-banking\/adyen-connect-button.png\" \/>","adyen-open-banking.svg":"<img alt=\"\" src=\"https:\/\/docs.adyen.com\/user\/pages\/docs\/07.business-accounts\/28.open-banking\/adyen-open-banking.svg\" \/>"}}