{"title":"Integration and go-live checklist","category":"default","creationDate":1776961628,"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 develop and go live with your Adyen Payouts integration.<\/p>\n<p><strong>Not yet in touch with Adyen?<\/strong> <a href=\"https:\/\/www.adyen.com\/contact\/sales\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Contact us<\/a> to register your interest for Adyen Payouts.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements 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;\">Use this information to build an <a href=\"\/pt\/payouts\/payout-service\">Adyen payouts integration<\/a>.<\/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;\">Make sure that you have <a href=\"\/pt\/payouts\/payout-service\/get-started#get-test-accounts\">received your API credentials<\/a> from your Adyen contact.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">You must have completed the following steps with your Adyen contact:<br\/><ul><li markdown=\"1\"><a href=\"\/pt\/payouts\/payout-service\/get-started#design-implementation\">Designed your implementation<\/a>.<\/li><li markdown=\"1\">Set up a <a href=\"\/pt\/payouts\/payout-service\/account-structure-resources#balance-platform\">balance platform<\/a>, along with other required resources.<\/li><li markdown=\"1\">Defined a settlement model that determines how sales funds are settled into your balance account.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Review your account structure<\/h2>\n<p>Before you start the integration process, you must be familiar with the Adyen account structure. Every Adyen Payout integration must have at least the following resource types:<\/p>\n<ul>\n<li><strong>Company account<\/strong>: the account tied to your core business entity, that contains your merchant accounts.<\/li>\n<li><strong>Merchant account<\/strong>: the account where we process payments for your business. You can have multiple merchant accounts.<\/li>\n<li><strong>Balance platform<\/strong>: the accounting system in which you manage the flow of your business' funds. Your merchant account is connected to your balance platform.<\/li>\n<li><strong>Legal entity<\/strong>: represents your business entity, holds and links information required for verification checks.<\/li>\n<li><strong>Account holder<\/strong>: represents your business in the balance platform. The account holder is linked to the legal entity resource.<\/li>\n<li><strong>Balance account<\/strong>: the account where your business' funds are held. All financial activities, such as initiating payouts, happen through balance accounts. You can have multiple balance accounts, but in most use cases, one balance account is enough.<\/li>\n<li><strong>Transfer instrument<\/strong>: your verified bank account where you can pay out your funds.<\/li>\n<\/ul>\n<p>For details on the different account structures and example use cases, see <a href=\"\/pt\/payouts\/payout-service\/account-structure-resources\">Account structure<\/a>.<\/p>\n<h2>Get ready for development<\/h2>\n<p>At the end of this section you should have the API key and the webhook configuration that you need to start integrating.<\/p>\n<h3>Check out Adyen\u2019s server-side libraries<\/h3>\n<p>Adyen provides <a href=\"\/pt\/development-resources\/libraries\/\">server-side API libraries<\/a> in several languages. Installing a library is not required, but will save you development time, because a library:<\/p>\n<ul>\n<li>Uses the latest API version.<\/li>\n<li>Has generated models and examples to help you construct requests.<\/li>\n<li>Sends the request to Adyen using its built-in HTTP client, so you do not have to create your own.<\/li>\n<\/ul>\n<p>Pick a library in the language of your choice and follow the <a href=\"\/pt\/development-resources\/libraries\">installation instructions<\/a>.<\/p>\n<h3 id=\"test-credentials\">Generate and test your API keys<\/h3>\n<p>Adyen is an API-first payment service provider, which means that you must integrate with our APIs to build and customize your implementation. You can <a href=\"\/pt\/payouts\/payout-service\/manage-access\/api-credentials-web-service\">generate your API credentials<\/a> 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>You need credentials for the following APIs:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\"><div style=\"width:100px\">API<\/div><\/th>\n<th style=\"text-align: left;\"><div style=\"width:120px\"> Credential<\/div><\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <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.[YourBalancePlatform]<\/strong><\/span><\/td>\n<td style=\"text-align: left;\">Use this API to  transfer funds and make one-off payouts.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>To verify that your test API credential is working, make your first request. The following example shows a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transfers\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/transfers<\/a> request:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example GET \/transfers request'\" :id=\"'get-transfers-test'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/v4\\\/transfers?createdSince=2024-10-12T09:20:30Z&amp;createdUntil=2024-11-13T08:45:30Z&amp;limit=5 \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X GET \\\\\\n-d ''&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v37.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.transfers.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.service.transfers.*;\\n\\nClient client = new Client(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, Environment.TEST);\\n\\\/\\\/ Send the request\\nTransfersApi service = new TransfersApi(client);\\nFindTransfersResponse response = service.getAllTransfers(LocalDateTime.parse(\\&quot;2024-10-12T09:20:30Z\\&quot;);, LocalDateTime.parse(\\&quot;2024-11-13T08:45:30\\&quot;);, 5, null);&quot;},{&quot;language&quot;:&quot;php&quot;,&quot;tabTitle&quot;:&quot;PHP&quot;,&quot;content&quot;:&quot;&lt;?php\\n\\\/\\\/ Adyen PHP API Library v27.0.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Service\\\\Transfers\\\\TransfersApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;);\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n$requestOptions['queryParams'] = array('createdSince' =&gt; '2024-10-12T09:20:30', 'createdUntil' =&gt; '2024-11-13T08:45:30', 'limit' =&gt; 5);\\n\\n\\\/\\\/ Send the request\\n$service = new TransfersApi($client);\\n$response = $service-&gt;getAllTransfers($requestOptions);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v31.0.0\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.Transfers;\\nusing Adyen.Service.Transfers;\\n\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Send the request\\nvar service = new TransfersService(client);\\nvar response = service.GetAllTransfers(createdSince: DateTime.Parse(\\&quot;2024-10-12T09:20:30\\&quot;), createdUntil: DateTime.Parse(\\&quot;2024-11-13T08:45:30\\&quot;), limit: 5);&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v26.1.0\\nconst { Client, TransfersAPI } = require('@adyen\\\/api-library');\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst transfersAPI = new TransfersAPI(client);\\nconst response = transfersAPI.TransfersApi.getAllTransfers(Date.parse(\\&quot;2024-10-12T09:20:30\\&quot;), Date.parse(\\&quot;2024-11-13T08:45:30\\&quot;), 5);&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v20.0.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v20\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v20\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v20\\\/src\\\/transfers\\&quot;\\n)\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Send the request\\nservice := client.Transfers()\\nreq := service.TransfersApi.GetAllTransfersInput()\\nreq = req.CreatedUntil(DateTime.Parse(\\&quot;2024-11-13T08:45:30\\&quot;)).Limit(5)\\nres, httpRes, err := service.TransfersApi.GetAllTransfers(context.Background(), req)&quot;},{&quot;language&quot;:&quot;py&quot;,&quot;tabTitle&quot;:&quot;Python&quot;,&quot;content&quot;:&quot;# Adyen Python API Library v13.4.0\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\nquery_parameters = {\\n  \\&quot;createdSince\\&quot; : \\&quot;2024-10-12T09:20:30\\&quot;,\\n  \\&quot;createdUntil\\&quot; : \\&quot;2024-11-13T08:45:30\\&quot;,\\n  \\&quot;limit\\&quot; : \\&quot;5\\&quot;\\n}\\n\\n# Send the request\\nresult = adyen.transfers.transfers_api.get_all_transfers(query_parameters=query_parameters)&quot;},{&quot;language&quot;:&quot;rb&quot;,&quot;tabTitle&quot;:&quot;Ruby&quot;,&quot;content&quot;:&quot;# Adyen Ruby API Library v10.2.0\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_BALANCE_PLATFORM_API_KEY'\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nquery_params = {\\n  :createdSince =&gt; '2024-10-12T09:20:30',\\n  :createdUntil =&gt; '2024-11-13T08:45:30',\\n  :limit =&gt; '5'\\n}\\n\\n# Send the request\\nresult = adyen.transfers.transfers_api.get_all_transfers(query_params: query_params)&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v26.1.0\\nimport { Client, TransfersAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\nconst client = new Client({ apiKey: \\&quot;ADYEN_BALANCE_PLATFORM_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot; });\\n\\n\\\/\\\/ Send the request\\nconst transfersAPI = new TransfersAPI(client);\\nconst response = transfersAPI.TransfersApi.getAllTransfers(Date.parse(\\&quot;2024-10-12T09:20:30\\&quot;), Date.parse(\\&quot;2024-11-13T08:45:30\\&quot;), 5);&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>If the call is successful, you receive an <span translate=\"no\"><strong>HTTP 200 OK<\/strong><\/span> result code along with the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transfers#responses-200-data\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">data<\/a> and  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/get\/transfers#responses-200-_links\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">_links<\/a> parameters.<\/p>\n<h2 id=\"Set-up-webhooks\">Set up webhooks<\/h2>\n<p>Adyen sends webhooks to communicate events, such as when a resource was created or a payout was triggered.<\/p>\n<ol>\n<li><strong>Configure a webhook endpoint<\/strong>.<br \/>\n<a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">Set up a webhook endpoint<\/a> in your system to receive webhooks from Adyen.<\/li>\n<li><strong>Configure webhooks<\/strong>.<br \/>\n<a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">Configure webhooks<\/a> in your Customer Area.<\/li>\n<li><strong>(Recommended) Verify the HMAC signature<\/strong>.<br \/>\n<a href=\"\/pt\/development-resources\/webhooks\/secure-webhooks\/verify-hmac-signatures\">Verify that the webhook<\/a> is sent from Adyen.<\/li>\n<li><strong>Accept webhooks<\/strong>.<br \/>\nAdyen sends a webhook for every status update in the payout lifecycle. <a href=\"\/pt\/development-resources\/webhooks\/handle-webhook-events#accept-webhooks\">Acknowledge<\/a> every webhook that you receive from Adyen.<\/li>\n<li><strong>(Recommended) Develop a fallback logic for payout errors<\/strong>.<br \/>\nIn case that a payout fails, we recommend that you develop a fallback logic that attempts to fix the error automatically. You can identify the cause of the payout error by using the <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-bank-accounts\/payout-webhooks\/#reason-codes\">reason code<\/a>.<\/li>\n<\/ol>\n<h2 id=\"pay-out-sub-merchants\">Pay out<\/h2>\n<p>Pay out funds to your beneficiaries or to your own transfer instrument.<\/p>\n<p><\/p>\n<ol>\n<li><strong>Pay out to third parties on demand<\/strong>.<br \/>\nPay out to third-party <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-bank-accounts\">bank accounts<\/a> or <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-cards\">cards<\/a>.<\/li>\n<li><strong>Pay out to your transfer instrument<\/strong>.<br \/>\nYou can pay out your sales funds to your transfer instrument. You can decide how much reserve to maintain in your balance account and transfer any excess funds to your external bank account. Transfers can be made either through scheduled payouts or on-demand payouts.<\/li>\n<li><strong>Listen to webhooks<\/strong>.<br \/>\nLearn which webhooks Adyen sends to inform your server of your payouts to <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-bank-accounts\/payout-webhooks\">bank accounts<\/a> or <a href=\"\/pt\/payouts\/payout-service\/pay-out-to-cards\/payout-webhooks\">cards<\/a>.<\/li>\n<\/ol>\n<h2 id=\"reports\">Accounting and reconciliation<\/h2>\n<p>Use reports to reconcile payments and balances in your system.<\/p>\n<ol>\n<li><strong>Set up your reports credentials<\/strong>.<br \/>\nYour Adyen contact will provide you with a reports credential, which you will need if you want to programmatically download reports.<\/li>\n<li><strong>Download reports<\/strong>.<br \/>\n<a href=\"\/pt\/payouts\/payout-service\/prepare-reports#download-reports\">Download reports<\/a>, either manually or automatically through your Customer Area.<\/li>\n<li><strong>Reconcile using reports<\/strong>.<br \/>\nFamiliarize yourself with the <a href=\"\/pt\/payouts\/payout-service\/reconciliation-use-cases\/\">common reconciliation processes<\/a> at Adyen.<\/li>\n<\/ol>\n<h2 id=\"go-live\">Going live<\/h2>\n<p>To get your Payouts integration live, you need to apply for a <a href=\"\/pt\/payouts\/payout-service\/get-started#apply-for-live-account\">live account<\/a>. When you have your live account, follow the steps below to take your integration live.<\/p>\n<ol>\n<li>\n<p><strong>Replicate your test account setup<\/strong>.<br \/>\nThe setup from your test account is <em>not<\/em> replicated to your live account.<\/p>\n<\/li>\n<li>\n<p><strong>Update your code base<\/strong>.<\/p>\n<ul>\n<li>Switch to live Balance Platform API credentials: get your live API credentials from your Adyen contact. Use these credentials in your live platform.<\/li>\n<li>Switch from test to live endpoints: change the endpoints from <code>test<\/code> to <code>live<\/code>. For example, <code>https:\/\/balanceplatform-api-test.adyen.com\/btl\/v4<\/code> to live <code>https:\/\/balanceplatform-api-live.adyen.com\/btl\/v4<\/code>.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p><strong>Run end-to-end tests<\/strong>.<\/p>\n<ul>\n<li>Live Balance Platform API credentials: make your <a href=\"#test-credentials\">first live API request<\/a> to make sure that your live API credentials are working.<\/li>\n<li>Payouts: test successful payout scenarios as well as error handling scenarios.<\/li>\n<li><a href=\"\/pt\/development-resources\/webhooks\/configure-and-manage\">Webhooks<\/a>: confirm that you can receive and accept webhooks in the live environment.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/payouts\/payout-service\/manage-access\/\"\n                        target=\"_self\"\n                        >\n                    Manage access for your team\n                <\/a><\/li><li><a href=\"\/payouts\/payout-service\/payout-lifecycle\/\"\n                        target=\"_self\"\n                        >\n                    Payout lifecycle\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/integration-checklist","articleFields":{"description":"Checklist for building and taking your Adyen payouts integration live.","feedback_component":true,"parameters":{"directoryPath":"\/payouts\/payout-service"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/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 develop and go live with your Adyen Payouts integration.\nNot yet in touch with Adyen? Contact us to register your interest for Adyen Payouts.\nRequirements\nBefore you begin, take into account the following requirements and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nUse this information to build an Adyen payouts integration.\n\n\nAPI credentials\nMake sure that you have received your API credentials from your Adyen contact.\n\n\nSetup steps\nYou must have completed the following steps with your Adyen contact:Designed your implementation.Set up a balance platform, along with other required resources.Defined a settlement model that determines how sales funds are settled into your balance account.\n\n\n\nReview your account structure\nBefore you start the integration process, you must be familiar with the Adyen account structure. Every Adyen Payout integration must have at least the following resource types:\n\nCompany account: the account tied to your core business entity, that contains your merchant accounts.\nMerchant account: the account where we process payments for your business. You can have multiple merchant accounts.\nBalance platform: the accounting system in which you manage the flow of your business' funds. Your merchant account is connected to your balance platform.\nLegal entity: represents your business entity, holds and links information required for verification checks.\nAccount holder: represents your business in the balance platform. The account holder is linked to the legal entity resource.\nBalance account: the account where your business' funds are held. All financial activities, such as initiating payouts, happen through balance accounts. You can have multiple balance accounts, but in most use cases, one balance account is enough.\nTransfer instrument: your verified bank account where you can pay out your funds.\n\nFor details on the different account structures and example use cases, see Account structure.\nGet ready for development\nAt the end of this section you should have the API key and the webhook configuration that you need to start integrating.\nCheck out Adyen\u2019s server-side libraries\nAdyen provides server-side API libraries in several languages. Installing a library is not required, but will save you development time, because a library:\n\nUses the latest API version.\nHas generated models and examples to help you construct requests.\nSends the request to Adyen using its built-in HTTP client, so you do not have to create your own.\n\nPick a library in the language of your choice and follow the installation instructions.\nGenerate and test your API keys\nAdyen is an API-first payment service provider, which means that you must integrate with our APIs to build and customize your implementation. You can generate your API credentials in your Customer Area.\nYou need credentials for the following APIs:\n\n\n\nAPI\n Credential\nDescription\n\n\n\n\n Transfers API\nws@BalancePlatform.[YourBalancePlatform]\nUse this API to  transfer funds and make one-off payouts.\n\n\n\nTo verify that your test API credential is working, make your first request. The following example shows a GET  \/transfers request:\n\n    \n\nIf the call is successful, you receive an HTTP 200 OK result code along with the  data and  _links parameters.\nSet up webhooks\nAdyen sends webhooks to communicate events, such as when a resource was created or a payout was triggered.\n\nConfigure a webhook endpoint.\nSet up a webhook endpoint in your system to receive webhooks from Adyen.\nConfigure webhooks.\nConfigure webhooks in your Customer Area.\n(Recommended) Verify the HMAC signature.\nVerify that the webhook is sent from Adyen.\nAccept webhooks.\nAdyen sends a webhook for every status update in the payout lifecycle. Acknowledge every webhook that you receive from Adyen.\n(Recommended) Develop a fallback logic for payout errors.\nIn case that a payout fails, we recommend that you develop a fallback logic that attempts to fix the error automatically. You can identify the cause of the payout error by using the reason code.\n\nPay out\nPay out funds to your beneficiaries or to your own transfer instrument.\n\n\nPay out to third parties on demand.\nPay out to third-party bank accounts or cards.\nPay out to your transfer instrument.\nYou can pay out your sales funds to your transfer instrument. You can decide how much reserve to maintain in your balance account and transfer any excess funds to your external bank account. Transfers can be made either through scheduled payouts or on-demand payouts.\nListen to webhooks.\nLearn which webhooks Adyen sends to inform your server of your payouts to bank accounts or cards.\n\nAccounting and reconciliation\nUse reports to reconcile payments and balances in your system.\n\nSet up your reports credentials.\nYour Adyen contact will provide you with a reports credential, which you will need if you want to programmatically download reports.\nDownload reports.\nDownload reports, either manually or automatically through your Customer Area.\nReconcile using reports.\nFamiliarize yourself with the common reconciliation processes at Adyen.\n\nGoing live\nTo get your Payouts integration live, you need to apply for a live account. When you have your live account, follow the steps below to take your integration live.\n\n\nReplicate your test account setup.\nThe setup from your test account is not replicated to your live account.\n\n\nUpdate your code base.\n\nSwitch to live Balance Platform API credentials: get your live API credentials from your Adyen contact. Use these credentials in your live platform.\nSwitch from test to live endpoints: change the endpoints from test to live. For example, https:\/\/balanceplatform-api-test.adyen.com\/btl\/v4 to live https:\/\/balanceplatform-api-live.adyen.com\/btl\/v4.\n\n\n\nRun end-to-end tests.\n\nLive Balance Platform API credentials: make your first live API request to make sure that your live API credentials are working.\nPayouts: test successful payout scenarios as well as error handling scenarios.\nWebhooks: confirm that you can receive and accept webhooks in the live environment.\n\n\n\nSee also\n\n\n                    Manage access for your team\n                \n                    Payout lifecycle\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Integration and go-live checklist"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payouts","lvl2":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service","lvl3":"\/pt\/payouts\/payout-service\/integration-checklist"},"levels":4,"category":"","category_color":"","tags":["Integration","go-live","checklist"]},"articleFiles":{"get-transfers-test.js":"<p alt=\"\">get-transfers-test.js<\/p>"}}