{"title":"Get reports using SFTP","category":"default","creationDate":1686304440,"content":"<p>You can connect to our SSH File Transfer Protocol (SFTP) servers to get reports. When SFTP is set up for your account, you can access your SFTP <a href=\"#directory-structure\">directory<\/a> to retrieve reports, or submit batch data.<\/p>\n<p>Keep in mind that an SFTP connection requires a higher degree of technical knowledge and further development resources. You can <a href=\"\/reporting\/automatically-get-reports#download-reports\">download reports automatically<\/a> without using SFTP.<\/p>\n<h2>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;\">All Adyen integrations.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/account\/user-roles\">Customer Area roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have the following role(s)<ul><li markdown=\"1\"><strong>Merchant admin<\/strong><\/li> <li markdown=\"1\"><strong>Merchant report<\/strong><\/li> <\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\">The SFTP server gives you access to all the reports generated for your company. You cannot restrict access to reports from specific merchant accounts or sub-merchant accounts.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin: <ul><li markdown=\"1\">Refer to our <a href=\"\/reporting\">Reporting documentation<\/a> to learn about reports in Adyen.<\/li> <li markdown=\"1\"><a href=\"#set-up-your-sftp-server-access\">Contact our Support team to get your SFTP access<\/a>.<\/li> <\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Set up your SFTP server access<\/h2>\n<p>Contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> with a request to create a SFTP directory where you can access your reports. Include the following information in your request:<\/p>\n<ul>\n<li><strong>Your Customer Area <a href=\"\/account\/account-structure#company-account\">company account<\/a><\/strong>.<\/li>\n<li><strong>Your source IP addresses<\/strong>: The IP addresses of the servers from which you want to access the SFTP server. Make sure that these are <strong>external<\/strong> IP addresses, and that the allowlisted IP range is <strong>static<\/strong>. For available options, refer to the documentation of your provider:\n<ul>\n<li><a href=\"https:\/\/learn.microsoft.com\/en-us\/azure\/nat-gateway\/nat-overview\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Azure NAT Gateway for Azure<\/a><\/li>\n<li><a href=\"https:\/\/cloud.google.com\/compute\/docs\/ip-addresses\/configure-static-external-ip-address\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Static IP address in GCP<\/a><\/li>\n<li><a href=\"https:\/\/docs.aws.amazon.com\/AWSEC2\/latest\/UserGuide\/elastic-ip-addresses-eip.html\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Elastic IP address in AWS<\/a><\/li>\n<\/ul><\/li>\n<li><strong>Your public SSH key<\/strong>: The length of your SSH key must be 2048 bits or 4096 bits.<\/li>\n<\/ul>\n<p>You will receive a response from Support when your SFTP server is configured and ready for you to access from your source IP addresses.<\/p>\n<h2>Connect to the SFTP server<\/h2>\n<p>Use the details below to connect to the relevant SFTP server.<\/p>\n<p>If you have issues connecting to the SFTP server, check out the <a href=\"https:\/\/help.adyen.com\/knowledge\/ecommerce-integrations\/integrations-basics\/how-can-i-troubleshoot-sftp-connections\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">troubleshooting steps<\/a>.<\/p>\n<h3>Test<\/h3>\n<p>To connect to the test SFTP server, use:<\/p>\n<ul>\n<li><strong>Host<\/strong>: <code>sftp-test.adyen.com<\/code><\/li>\n<li><strong>Port<\/strong>: <code>5892<\/code><\/li>\n<li><strong>User<\/strong>: the user provided to you by Support. For example, <code>sftpreport_123456@Company.YOUR_COMPANY_ACCOUNT<\/code>.<\/li>\n<li><strong>Allowlist IP<\/strong>: <code>213.52.172.120<\/code><\/li>\n<\/ul>\n<h3>Live<\/h3>\n<p>To connect to the live SFTP server from all regions except of <a href=\"#india-live\">India<\/a>, use:<\/p>\n<ul>\n<li><strong>Host<\/strong>: <code>sftp-live.adyen.com<\/code><\/li>\n<li><strong>Port<\/strong>: <code>5631<\/code><\/li>\n<li><strong>User<\/strong>: the user provided to you by Support. For example, <code>sftpreport_123456@Company.YOUR_COMPANY_ACCOUNT<\/code>.<\/li>\n<li><strong>Allowlist IP<\/strong>: <code>82.199.87.148<\/code><\/li>\n<\/ul>\n<h3>India live<\/h3>\n<p>If you process live payments in India, you need to connect to the India-specific SFTP to comply with data localization requirements. To connect to the India live SFTP server, use:<\/p>\n<ul>\n<li><strong>Host<\/strong>: <code>sftp-live-in.adyen.com<\/code><\/li>\n<li><strong>Port<\/strong>: <code>5631<\/code><\/li>\n<li><strong>User<\/strong>: the user provided to you by Support. For example, <code>sftpreport_123456@Company.YOUR_COMPANY_ACCOUNT<\/code>.<\/li>\n<li><strong>Allowlist IP<\/strong>: <code>147.12.20.251<\/code><\/li>\n<\/ul>\n<h2>Directory structure<\/h2>\n<p>Your SFTP directory is configured for your company account. Adyen will create a subdirectory for each of your merchant accounts and sub-merchant accounts, after they have generated their first report.<\/p>\n<p>Reports for <a href=\"\/account\/account-structure#company-account\">company accounts<\/a> are located in the root directory. Reports for <a href=\"\/account\/account-structure#merchant-accounts\">merchant accounts<\/a> and sub-merchant accounts are located in directories corresponding to their names.<\/p>\n<p>The SFTP directory only contains reports that were generated after you set it up. To include reports that were generated before you set up your SFTP connection, <a href=\"\/reporting\/manually-get-reports\/\">regenerate them in your Customer Area<\/a>.<\/p>\n<p>The reports in your SFTP directory are also visible in your Customer Area, unless you have write access and delete them from your SFTP directory.<\/p>\n<p>The following table shows the directory structure:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Directory<\/th>\n<th style=\"text-align: left;\">Structure<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><a href=\"\/account\/account-structure#company-account\">Company account<\/a> directory<\/td>\n<td style=\"text-align: left;\"><code>\/REPORT_NAME.csv.gz<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><a href=\"\/account\/account-structure#merchant-accounts\">Merchant account<\/a> directory<\/td>\n<td style=\"text-align: left;\"><code>\/YOUR_MERCHANT_ACCOUNT\/REPORT_NAME.csv.gz<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Sub-merchant account directory<\/td>\n<td style=\"text-align: left;\"><code>\/YOUR_MERCHANT_NAME\/YOUR_SUB_MERCHANT_NAME\/REPORT_NAME.csv.gz<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/reporting\/manually-get-reports\"\n                        target=\"_self\"\n                        >\n                    Manually get reports\n                <\/a><\/li><li><a href=\"\/reporting\/time-zone-setting\"\n                        target=\"_self\"\n                        >\n                    Time zone setting\n                <\/a><\/li><li><a href=\"\/reporting\/platform-reports\/\"\n                        target=\"_self\"\n                        >\n                    Platform reports\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/reporting\/automatically-get-reports\/get-reports-using-sftp","articleFields":{"description":"Learn how to get Adyen reports using SSH File Transfer Protocol (SFTP).","feedback_component":true,"last_edit_on":"09-06-2023 11:54","filters_component":false,"page_id":"be8ea332-f9ac-4437-a52b-b52659ab78f2","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/reporting\/automatically-get-reports\/get-reports-using-sftp","title":"Get reports using SFTP","content":"You can connect to our SSH File Transfer Protocol (SFTP) servers to get reports. When SFTP is set up for your account, you can access your SFTP directory to retrieve reports, or submit batch data.\nKeep in mind that an SFTP connection requires a higher degree of technical knowledge and further development resources. You can download reports automatically without using SFTP.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nAll Adyen integrations.\n\n\nCustomer Area roles\nMake sure that you have the following role(s)Merchant admin Merchant report \n\n\nLimitations\nThe SFTP server gives you access to all the reports generated for your company. You cannot restrict access to reports from specific merchant accounts or sub-merchant accounts.\n\n\nSetup steps\nBefore you begin: Refer to our Reporting documentation to learn about reports in Adyen. Contact our Support team to get your SFTP access. \n\n\n\nSet up your SFTP server access\nContact our Support Team with a request to create a SFTP directory where you can access your reports. Include the following information in your request:\n\nYour Customer Area company account.\nYour source IP addresses: The IP addresses of the servers from which you want to access the SFTP server. Make sure that these are external IP addresses, and that the allowlisted IP range is static. For available options, refer to the documentation of your provider:\n\nAzure NAT Gateway for Azure\nStatic IP address in GCP\nElastic IP address in AWS\n\nYour public SSH key: The length of your SSH key must be 2048 bits or 4096 bits.\n\nYou will receive a response from Support when your SFTP server is configured and ready for you to access from your source IP addresses.\nConnect to the SFTP server\nUse the details below to connect to the relevant SFTP server.\nIf you have issues connecting to the SFTP server, check out the troubleshooting steps.\nTest\nTo connect to the test SFTP server, use:\n\nHost: sftp-test.adyen.com\nPort: 5892\nUser: the user provided to you by Support. For example, sftpreport_123456@Company.YOUR_COMPANY_ACCOUNT.\nAllowlist IP: 213.52.172.120\n\nLive\nTo connect to the live SFTP server from all regions except of India, use:\n\nHost: sftp-live.adyen.com\nPort: 5631\nUser: the user provided to you by Support. For example, sftpreport_123456@Company.YOUR_COMPANY_ACCOUNT.\nAllowlist IP: 82.199.87.148\n\nIndia live\nIf you process live payments in India, you need to connect to the India-specific SFTP to comply with data localization requirements. To connect to the India live SFTP server, use:\n\nHost: sftp-live-in.adyen.com\nPort: 5631\nUser: the user provided to you by Support. For example, sftpreport_123456@Company.YOUR_COMPANY_ACCOUNT.\nAllowlist IP: 147.12.20.251\n\nDirectory structure\nYour SFTP directory is configured for your company account. Adyen will create a subdirectory for each of your merchant accounts and sub-merchant accounts, after they have generated their first report.\nReports for company accounts are located in the root directory. Reports for merchant accounts and sub-merchant accounts are located in directories corresponding to their names.\nThe SFTP directory only contains reports that were generated after you set it up. To include reports that were generated before you set up your SFTP connection, regenerate them in your Customer Area.\nThe reports in your SFTP directory are also visible in your Customer Area, unless you have write access and delete them from your SFTP directory.\nThe following table shows the directory structure:\n\n\n\nDirectory\nStructure\n\n\n\n\nCompany account directory\n\/REPORT_NAME.csv.gz\n\n\nMerchant account directory\n\/YOUR_MERCHANT_ACCOUNT\/REPORT_NAME.csv.gz\n\n\nSub-merchant account directory\n\/YOUR_MERCHANT_NAME\/YOUR_SUB_MERCHANT_NAME\/REPORT_NAME.csv.gz\n\n\n\nSee also\n\n\n                    Manually get reports\n                \n                    Time zone setting\n                \n                    Platform reports\n                \n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Reporting","lvl2":"Get reports automatically","lvl3":"Get reports using SFTP"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/reporting","lvl2":"https:\/\/docs.adyen.com\/reporting\/automatically-get-reports","lvl3":"\/reporting\/automatically-get-reports\/get-reports-using-sftp"},"levels":4,"category":"Reporting","category_color":"green","tags":["reports","using"]}}
