{"title":"Get platform reports","category":"default","creationDate":1776961628,"content":"<p>You can generate balance platform reports automatically according to a specific schedule, or manually on-demand.<\/p>\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><a href=\"\/pt\/development-resources\/api-credentials\/roles\/\">API credential roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">To <a href=\"#download\">Download reports<\/a> make sure that you have the following role: <ul><li markdown=\"1\"><strong>Report service user<\/strong> API key with the <strong>BalancePlatform Report Download role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/account\/user-roles\">Customer Area roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have the following roles: <ul><li markdown=\"1\"><strong>Download Balance Platform reports<\/strong><\/li> <li markdown=\"1\"><strong>Generate Balance Platform reports<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/webhooks\">Webhooks<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Subscribe to the following webhook(s): <ul><li markdown=\"1\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/report-webhooks\/latest\/post\/balancePlatform.report.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.report.created<\/a><\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><\/p>\n<h2 id=\"generate\">Generate reports<\/h2>\n\n<div id=\"tabtM3r0\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Automatically&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To automatically generate reports:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;\\n&lt;p&gt;Log in to your &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt; and make sure you are on the correct merchant account.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Go to &lt;strong&gt;Reports&lt;\\\/strong&gt;.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Select the name of the report you want to generate.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Select &lt;strong&gt;Manage report&lt;\\\/strong&gt;.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Select &lt;strong&gt;Automatic (schedule based)&lt;\\\/strong&gt;.&lt;\\\/p&gt;\\n&lt;div class=\\&quot;sc-notice note\\&quot;&gt;&lt;div&gt;\\n&lt;p&gt;Keep the &lt;strong&gt;Automatic generation&lt;\\\/strong&gt; toggle selected. If you deselect this option, the schedule for generating reports is deleted.&lt;\\\/p&gt;\\n&lt;\\\/div&gt;&lt;\\\/div&gt;\\n&lt;\\\/li&gt;\\n&lt;li&gt;\\n&lt;p&gt;Select &lt;strong&gt;Close&lt;\\\/strong&gt;.&lt;\\\/p&gt;\\n&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;The schedule depends on the report type and your balance platform configuration. When a report is generated, Adyen sends a  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/report-webhooks\\\/latest\\\/post\\\/balancePlatform.report.created\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;balancePlatform.report.created&lt;\\\/a&gt; webhook.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;automatically_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;Manually&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;You can manually generate reports anytime in the &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt;. Some reports have additional options, such as generating in bulk, selecting a date range, or filtering.&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;Log in to your &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt; and make sure you are on the correct merchant account.&lt;\\\/li&gt;\\n&lt;li&gt;Go to &lt;strong&gt;Reports&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Select the name of the report that you want to generate.&lt;\\\/li&gt;\\n&lt;li&gt;Select &lt;strong&gt;Manage report&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Select &lt;strong&gt;Manual (generate once)&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;(Optional) Depending on the report type, select:\\n&lt;ol&gt;\\n&lt;li&gt;&lt;strong&gt;Bulk&lt;\\\/strong&gt; to generate multiple reports.&lt;\\\/li&gt;\\n&lt;li&gt;The date or time period that the report should cover.&lt;\\\/li&gt;\\n&lt;li&gt;The balance account and\\\/or account holder to filter the report on.&lt;\\\/li&gt;\\n&lt;li&gt;The time zone that you want to base the report on.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;&lt;\\\/li&gt;\\n&lt;li&gt;Select &lt;strong&gt;Generate report&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;Generating a report can take up to a few minutes.&lt;\\\/p&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;manually_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n\n<h2>Get updates when a report is available<\/h2>\n<p>To get updates when a balance platform report is generated and available for download, listen to the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/report-webhooks\/latest\/post\/balancePlatform.report.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.report.created<\/a> webhook. The webhook contains the URL at which you can download the report.<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example webhook'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n  \\\"data\\\": {\\n    \\\"balancePlatform\\\": \\\"YourBalancePlatform\\\",\\n    \\\"creationDate\\\": \\\"2022-01-02T02:01:08+02:00\\\",\\n    \\\"id\\\": \\\"balanceplatform_balance_report_2022_01_01.csv\\\",\\n    \\\"downloadUrl\\\": \\\"https:\\\/\\\/balanceplatform-test.adyen.com\\\/balanceplatform\\\/reportDownload\\\/v1\\\/YourBalancePLatform\\\/balanceplatform_balance_report_2022_01_01.csv\\\",\\n    \\\"reportType\\\": \\\"balanceplatform_balance_report\\\",\\n    \\\"fileName\\\": \\\"balanceplatform_balance_report_2022_01_01.csv\\\"\\n  },\\n  \\\"environment\\\": \\\"test\\\",\\n  \\\"type\\\": \\\"balancePlatform.report.created\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"download\">Download reports<\/h2>\n<p>All reports are generated in CSV format. You can also generate the Accounting report in TSV format. We recommend that you create a script to load the reports and reconcile into your systems. Alternatively, you can use any spreadsheet software to open the file and reconcile manually.<\/p>\n<p>You can download reports manually from your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, or programmatically by making an HTTP GET request.<\/p>\n\n<div id=\"tabn16zI\">\n    <div data-component-wrapper=\"tabs\">\n        <tabs\n                        :items=\"[{&quot;title&quot;:&quot;Customer Area&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;You can download all generated balance platform reports from the &lt;strong&gt;Reports&lt;\\\/strong&gt; page of your &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt;.&lt;\\\/p&gt;\\n&lt;p&gt;To download reports manually:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;Log in to your &lt;a href=\\&quot;https:\\\/\\\/ca-test.adyen.com\\\/\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot; class=\\&quot;external-link no-image\\&quot;&gt;Customer Area&lt;\\\/a&gt; and make sure you are on the correct merchant account.&lt;\\\/li&gt;\\n&lt;li&gt;Go to &lt;strong&gt;Reports&lt;\\\/strong&gt;.&lt;\\\/li&gt;\\n&lt;li&gt;Select the name of the report type you want to download.&lt;\\\/li&gt;\\n&lt;li&gt;In the &lt;strong&gt;Generated reports&lt;\\\/strong&gt; table, select the arrow in the &lt;strong&gt;Download&lt;\\\/strong&gt; column of the specific report you want to download.&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;customer_area_0_1&quot;,&quot;relation&quot;:&quot;&quot;},{&quot;title&quot;:&quot;HTTP GET request&quot;,&quot;content&quot;:&quot;\\n&lt;p&gt;To download reports programmatically:&lt;\\\/p&gt;\\n&lt;ol&gt;\\n&lt;li&gt;Ask your Adyen contact for your report credentials. You must use your report credentials to authenticate your GET request.&lt;\\\/li&gt;\\n&lt;li&gt;Download the report with an HTTP GET request. Include:\\n&lt;ul&gt;\\n&lt;li&gt;The name of your report.&lt;\\\/li&gt;\\n&lt;li&gt;Your API key or the basic authentication password for your report.&lt;\\\/li&gt;\\n&lt;li&gt;The URL from the &lt;code&gt;downloadUrl&lt;\\\/code&gt; field in the  &lt;a href=\\&quot;https:\\\/\\\/docs.adyen.com\\\/api-explorer\\\/report-webhooks\\\/latest\\\/post\\\/balancePlatform.report.created\\&quot; class=\\&quot;codeLabel  external-link no-image\\&quot; target=\\&quot;_blank\\&quot; rel=\\&quot;nofollow noopener noreferrer\\&quot;&gt;balancePlatform.report.created&lt;\\\/a&gt; webhook.&lt;\\\/li&gt;\\n&lt;\\\/ul&gt;&lt;\\\/li&gt;\\n&lt;\\\/ol&gt;\\n&lt;p&gt;The following is an example of how to use basic authentication to download a Balance Platform Balance Report:&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Download a Balance Report with basic authentication&#039;\\&quot; :id=\\&quot;&#039;download-balance-report&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;$ wget --http-user=&#039;report_[123456]@BalancePlatform.YOUR_BALANCE_PLATFORM&#039; \\\\\\\\\\\\n--http-password=&#039;YOUR_PASSWORD&#039; \\\\\\\\\\\\nhttps:\\\\\\\\\\\\\\\/\\\\\\\\\\\\\\\/balanceplatform-test.adyen.com\\\\\\\\\\\\\\\/balanceplatform\\\\\\\\\\\\\\\/reportDownload\\\\\\\\\\\\\\\/v1\\\\\\\\\\\\\\\/YOUR_BALANCE_PLATFORM\\\\\\\\\\\\\\\/balanceplatform_balance_report_2022_01_31.csv&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&lt;p&gt;The following is an example of how to use an API key to download a Balance Platform Balance Report:&lt;\\\/p&gt;\\n&lt;div data-component-wrapper=\\&quot;code-sample\\&quot;&gt;\\n    &lt;code-sample :title=\\&quot;&#039;Download a Balance Report with API key&#039;\\&quot; :id=\\&quot;&#039;download-balance-report-apikey&#039;\\&quot; :code-data=\\&quot;[{&amp;quot;language&amp;quot;:&amp;quot;bash&amp;quot;,&amp;quot;tabTitle&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;content&amp;quot;:&amp;quot;curl -L -X GET &#039;https:\\\\\\\/\\\\\\\/balanceplatform-test.adyen.com\\\\\\\/balanceplatform\\\\\\\/reportDownload\\\\\\\/v1\\\\\\\/{YOUR_BALANCE_PLATFORM}\\\\\\\/balanceplatform_balance_report_2022_01_31.csv&#039; \\\\\\\\\\\\n-H &#039;x-api-key: YOUR_API_KEY&#039; \\\\\\\\&amp;quot;}]\\&quot; :enable-copy-link-to-code-block=\\&quot;true\\&quot; :code-sample-card-size=\\&quot;&#039;fullsize&#039;\\&quot;&gt;&lt;\\\/code-sample&gt;\\n&lt;\\\/div&gt;\\n&quot;,&quot;altTitle&quot;:null,&quot;oldTabId&quot;:&quot;http_get_request_1_2&quot;,&quot;relation&quot;:&quot;&quot;}]\"\n            :should-update-when-url-changes='false'>\n        <\/tabs>\n    <\/div>\n<\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/prepare-reports\/generate-download-reports","articleFields":{"description":"Learn how to generate and download reports for your balance platform automatically or manually.","feedback_component":true,"filters_component":false,"type":"page","_expandable":{"operations":""},"status":"current","parameters":{"integrationType":"payouts","directoryPath":"\/payouts\/payout-service","transferType":"payout","model":"payouts"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/prepare-reports\/generate-download-reports","title":"Get platform reports","content":"You can generate balance platform reports automatically according to a specific schedule, or manually on-demand.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nAPI credential roles\nTo Download reports make sure that you have the following role: Report service user API key with the BalancePlatform Report Download role\n\n\nCustomer Area roles\nMake sure that you have the following roles: Download Balance Platform reports Generate Balance Platform reports\n\n\nWebhooks\nSubscribe to the following webhook(s):  balancePlatform.report.created\n\n\n\n\nGenerate reports\n\n\n    \n        \n        \n    \n\n\nGet updates when a report is available\nTo get updates when a balance platform report is generated and available for download, listen to the  balancePlatform.report.created webhook. The webhook contains the URL at which you can download the report.\n\n    \n\nDownload reports\nAll reports are generated in CSV format. You can also generate the Accounting report in TSV format. We recommend that you create a script to load the reports and reconcile into your systems. Alternatively, you can use any spreadsheet software to open the file and reconcile manually.\nYou can download reports manually from your Customer Area, or programmatically by making an HTTP GET request.\n\n\n    \n        \n        \n    \n\n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Prepare the reports","lvl4":"Get platform reports"},"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":"https:\/\/docs.adyen.com\/pt\/payouts\/payout-service\/prepare-reports","lvl4":"\/pt\/payouts\/payout-service\/prepare-reports\/generate-download-reports"},"levels":5,"category":"","category_color":"","tags":["platform","reports"]}}