{"title":"Integration and go-live checklist","category":"default","creationDate":1557888420,"content":"<div class=\"additional-info-block output-inline\">\n<h5 class=\"article__heading additional-info-block__title\">Adyen APIs Postman collections<\/h5><div class=\"additional-info-block__body\"><p><img style=\"width: 20px;\" alt=\"\" src=\"\/user\/pages\/reuse\/pfs-general\/link-to-postman-collections\/postman-icon.svg?decoding=auto&amp;fetchpriority=auto\" \/> Fork our <a href=\"https:\/\/www.postman.com\/adyendev\/workspace\/adyen-apis\/overview\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Postman collections<\/a> in your private workspace to start testing API calls with your own credentials.<\/p><\/div><\/div>\n\n<p>On this page you can learn about the steps required to enable the use of business accounts for your users.<\/p>\n<p>Before you start building your integration, make sure that you have <a href=\"\/pt\/business-accounts\/get-started#design-implementation\">designed your implementation<\/a> with your Adyen implementation manager.<\/p>\n<p>The integration steps are the following:<\/p>\n<ul>\n<li><a href=\"#review-your-account-structure\">Review your account structure<\/a><\/li>\n<li><a href=\"#complete-the-integration-checklist-for-adyen-for-platforms\">Complete the integration checklist for Adyen for Platforms<\/a><\/li>\n<li><a href=\"#test-your-api-keys\">Test your API keys<\/a><\/li>\n<li><a href=\"#set-up-webhooks\">Set up webhooks<\/a><\/li>\n<li><a href=\"#implement-business-account-features\">Implement business account features<\/a><\/li>\n<li><a href=\"#go-live\">Go live<\/a><\/li>\n<\/ul>\n<h2>Review your account structure<\/h2>\n<p>Before you start using business accounts, you must be familiar with the Adyen account structure. Every Adyen for Platforms integration with business accounts must have at least the following resource types:<\/p>\n<ul>\n<li><strong>Company account<\/strong>: represents your core business entity and holds your merchant accounts.<\/li>\n<li><strong>Merchant account<\/strong>: the account where we process payments for your users. You can have multiple merchant accounts.<\/li>\n<li><strong>Balance platform<\/strong>: the accounting system in which you manage your users and funds.<\/li>\n<li><strong>Account holder<\/strong>: specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).<\/li>\n<li><strong>Balance account<\/strong>: holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.<\/li>\n<li><strong>Legal entity<\/strong>: contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.<\/li>\n<li><strong>Transfer instrument<\/strong>: your user's verified bank account where they can receive payouts.<\/li>\n<li><strong>Business line<\/strong>: contains information about your user's line of business, including their industry and source of funds.<\/li>\n<li><strong>Payment instrument<\/strong> (business account): an externally-facing resource for interacting with funds on the associated balance account. Creating a payment instrument generates an account number. Each balance account can have only one payment instrument of type <span translate=\"no\"><strong>bankAccount<\/strong><\/span>.<\/li>\n<\/ul>\n<p>For details on the different account structures and example use cases, see <a href=\"\/pt\/business-accounts\/account-structure-resources\">Account structures<\/a>.<\/p>\n<h2>Complete the integration checklist for Adyen for Platforms<\/h2>\n<p>Before integrating business accounts, you must complete the integration steps for either the <a href=\"\/pt\/marketplaces\/integration-checklist\">marketplace<\/a> or <a href=\"\/pt\/platforms\/integration-checklist\">platform<\/a> model of Adyen for Platforms.<\/p>\n<h2>Test your API keys<\/h2>\n<p>To make API requests related to business accounts, you can use the same API credentials that you generated for your <a href=\"\/pt\/marketplaces\/integration-checklist\/#generate-and-test-your-api-keys\">marketplace<\/a> or <a href=\"\/pt\/platforms\/integration-checklist\/#generate-and-test-your-api-keys\">platform<\/a>. If needed, you can <a href=\"\/pt\/business-accounts\/manage-access#manage-api-credentials\">generate your API credentials<\/a> and assign roles to them 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<p>Make sure that you have the following API credentials and roles.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">API<\/th>\n<th style=\"text-align: left;\">Credential<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <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><br\/><br\/> <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<td style=\"text-align: left;\"><span translate=\"no\"><strong>ws@BalancePlatform.<\/strong><\/span><strong>[YourBalancePlatform]<\/strong><br\/><br\/>Use this API credential to send funds to or receive funds from third parties, set rules to automatically approve or decline outgoimg transfers, and create resources such as account holders, balance accounts, and business accounts.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/legalentity\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Legal Entity Management API<\/a><\/td>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>ws<em>[123456]@Scope.Company<\/em>[YourCompanyAccount]<\/strong><\/span><br\/><br\/>Use this API credential to create and manage legal entities that contain the information required for verification checks.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Set up webhooks<\/h2>\n<p>Webhooks are a crucial part of your integration. Adyen sends webhooks to communicate events in your balance platform, such as if your user needs to provide additional information for onboarding, or when funds are debited or credited from their business accounts.<\/p>\n<ol>\n<li><a href=\"\/pt\/development-resources\/webhooks\/#expose-an-endpoint-on-your-server\">Set up webhook endpoints<\/a> on your server and build the logic for acknowledging webhooks.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\/#set-up-webhooks-in-your-customer-area\">Configure webhooks<\/a> in your Customer Area.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\/secure-webhooks\/verify-hmac-signatures\/\">Secure webhooks<\/a> with HMAC signing.<\/li>\n<\/ol>\n<h2>Implement business account features<\/h2>\n<p>In addition to setting up your marketplace or platform, business accounts require you to take additional actions:<\/p>\n<ul>\n<li>Make sure that your users pass the <a href=\"\/pt\/business-accounts\/verification-requirements\">additional verification checks required for business accounts<\/a>.<\/li>\n<li>(Optional) <a href=\"\/pt\/business-accounts\/implement-sca\">Implement Adyen's authentication SDK<\/a> to authenticate your user's transactions and reduce the chance of fraud.<\/li>\n<li>Learn how to make requests to <a href=\"\/pt\/business-accounts\/send-funds\">send funds to<\/a> or <a href=\"\/pt\/business-accounts\/receive-funds\">receive funds from<\/a> third parties using your Adyen business accounts.<\/li>\n<li>Learn how to <a href=\"\/pt\/business-accounts\/transfer-funds-internally\">initiate internal direct debits<\/a> between the balance accounts in your balance platform.<\/li>\n<li>(Optional) Integrate with the <a href=\"\/pt\/business-accounts\/open-banking\">Adyen Open Banking Platform<\/a>.<\/li>\n<\/ul>\n<h2>Go live<\/h2>\n<p>To take your business accounts integration live:<\/p>\n<ol>\n<li><strong>Replicate your test account setup in your live account<\/strong><br \/>\nThe business account setup from your test account for Adyen for Platforms is <em>not<\/em> automatically replicated in your live account.<\/li>\n<li><strong>Update your code base<\/strong><\/li>\n<li><strong>Switch to live API credentials<\/strong><br \/>\nGet your live API credentials from your Adyen contact. Use these credentials in your live account.<\/li>\n<li><strong>Switch from test to live endpoints<\/strong><br \/>\nChange the endpoints from <code>test<\/code> to <code>live<\/code>. For example, <code>https:\/\/balanceplatform-api-test.adyen.com\/<\/code> to<br \/>\n<code>https:\/\/balanceplatform-api-live.adyen.com\/<\/code>.<\/li>\n<li><strong>Run end-to-end tests<\/strong>\n<ul>\n<li>Live API credentials: make your first live API requests to make sure that your live API credentials are working.<\/li>\n<li><a href=\"\/pt\/business-accounts\/create-business-accounts\">Business accounts<\/a>: confirm that you can create business accounts with the <span translate=\"no\"><strong>issueBankAccount<\/strong><\/span> <a href=\"\/pt\/business-accounts\/verification-overview\/capabilities#business-account-capabilities\">capability<\/a><\/li>\n<li>Third-party transfers: confirm that you can <a href=\"\/pt\/business-accounts\/send-funds\">send funds to<\/a> and <a href=\"\/pt\/business-accounts\/receive-funds\">receive funds from<\/a> third parties with the <span translate=\"no\"><strong>sendToThirdParty<\/strong><\/span> and <span translate=\"no\"><strong>receiveFromThirdParty<\/strong><\/span> <a href=\"\/pt\/business-accounts\/verification-overview\/capabilities#business-account-capabilities\">capabilities<\/a>.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\">Webhooks<\/a>: confirm that you can receive and accept webhooks in the live environment.<\/li>\n<\/ul><\/li>\n<\/ol>","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/integration-checklist","articleFields":{"description":"Checklist for building and taking your Adyen for Platforms integration live with business accounts.","feedback_component":true,"last_edit_on":"06-03-2023 15:13","parameters":{"directoryPath":"\/business-accounts","model":"balance platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/integration-checklist","title":"Integration and go-live checklist","content":"\nAdyen APIs Postman collections Fork our Postman collections in your private workspace to start testing API calls with your own credentials.\n\nOn this page you can learn about the steps required to enable the use of business accounts for your users.\nBefore you start building your integration, make sure that you have designed your implementation with your Adyen implementation manager.\nThe integration steps are the following:\n\nReview your account structure\nComplete the integration checklist for Adyen for Platforms\nTest your API keys\nSet up webhooks\nImplement business account features\nGo live\n\nReview your account structure\nBefore you start using business accounts, you must be familiar with the Adyen account structure. Every Adyen for Platforms integration with business accounts must have at least the following resource types:\n\nCompany account: represents your core business entity and holds your merchant accounts.\nMerchant account: the account where we process payments for your users. You can have multiple merchant accounts.\nBalance platform: the accounting system in which you manage your users and funds.\nAccount holder: specifies what your user can do in your platform, for example, receive fund transfers to their balance account and payouts to their verified transfer instrument (bank account).\nBalance account: holds the funds of your user or your platform. All financial activities in your platform, such as paying out to a bank account, happen through balance accounts.\nLegal entity: contains information about your user, for example, the legal name, address, and tax information of the organization. Adyen uses this information to perform verification checks required by payment industry regulations.\nTransfer instrument: your user's verified bank account where they can receive payouts.\nBusiness line: contains information about your user's line of business, including their industry and source of funds.\nPayment instrument (business account): an externally-facing resource for interacting with funds on the associated balance account. Creating a payment instrument generates an account number. Each balance account can have only one payment instrument of type bankAccount.\n\nFor details on the different account structures and example use cases, see Account structures.\nComplete the integration checklist for Adyen for Platforms\nBefore integrating business accounts, you must complete the integration steps for either the marketplace or platform model of Adyen for Platforms.\nTest your API keys\nTo make API requests related to business accounts, you can use the same API credentials that you generated for your marketplace or platform. If needed, you can generate your API credentials and assign roles to them in your Customer Area.\nMake sure that you have the following API credentials and roles.\n\n\n\nAPI\nCredential\n\n\n\n\n Configuration API Transfers API\nws@BalancePlatform.[YourBalancePlatform]Use this API credential to send funds to or receive funds from third parties, set rules to automatically approve or decline outgoimg transfers, and create resources such as account holders, balance accounts, and business accounts.\n\n\n Legal Entity Management API\nws[123456]@Scope.Company[YourCompanyAccount]Use this API credential to create and manage legal entities that contain the information required for verification checks.\n\n\n\nSet up webhooks\nWebhooks are a crucial part of your integration. Adyen sends webhooks to communicate events in your balance platform, such as if your user needs to provide additional information for onboarding, or when funds are debited or credited from their business accounts.\n\nSet up webhook endpoints on your server and build the logic for acknowledging webhooks.\nConfigure webhooks in your Customer Area.\nSecure webhooks with HMAC signing.\n\nImplement business account features\nIn addition to setting up your marketplace or platform, business accounts require you to take additional actions:\n\nMake sure that your users pass the additional verification checks required for business accounts.\n(Optional) Implement Adyen's authentication SDK to authenticate your user's transactions and reduce the chance of fraud.\nLearn how to make requests to send funds to or receive funds from third parties using your Adyen business accounts.\nLearn how to initiate internal direct debits between the balance accounts in your balance platform.\n(Optional) Integrate with the Adyen Open Banking Platform.\n\nGo live\nTo take your business accounts integration live:\n\nReplicate your test account setup in your live account\nThe business account setup from your test account for Adyen for Platforms is not automatically replicated in your live account.\nUpdate your code base\nSwitch to live API credentials\nGet your live API credentials from your Adyen contact. Use these credentials in your live account.\nSwitch from test to live endpoints\nChange the endpoints from test to live. For example, https:\/\/balanceplatform-api-test.adyen.com\/ to\nhttps:\/\/balanceplatform-api-live.adyen.com\/.\nRun end-to-end tests\n\nLive API credentials: make your first live API requests to make sure that your live API credentials are working.\nBusiness accounts: confirm that you can create business accounts with the issueBankAccount capability\nThird-party transfers: confirm that you can send funds to and receive funds from third parties with the sendToThirdParty and receiveFromThirdParty capabilities.\nWebhooks: confirm that you can receive and accept webhooks in the live environment.\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Integration and go-live checklist"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"\/pt\/business-accounts\/integration-checklist"},"levels":3,"category":"","category_color":"","tags":["Integration","go-live","checklist"]}}