{"title":"Submit transaction batch files through SFTP","category":"default","creationDate":1779706501,"content":"<p>Batch file processing allows you to process multiple transactions in bulk: you submit a file listing all the payments you want us to process.<\/p>\n<p>This feature comes in handy when you need to process refunds or retry failed capture attempts, for example. You group all the transactions in a file and then upload it for Adyen to process all the data.<\/p>\n<p>Each batch file can hold only one\u00a0request type per merchant account. Create separate files for each request like authorisation, refund, capture etc.<\/p>\n<p>If you need to process modifications for multiple merchant accounts, contact our\u00a0<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> to enable this for you.<\/p>\n<p>A secure communication channel is required to submit batch files. To achieve that, we use the <a href=\"https:\/\/en.wikipedia.org\/wiki\/SSH_File_Transfer_Protocol\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">SFTP<\/a> transfer protocol and <a href=\"https:\/\/en.wikipedia.org\/wiki\/Pretty_Good_Privacy\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">PGP<\/a> data encryption.<\/p>\n<h2 id=\"sftp-configuration\">SFTP\u00a0configuration<\/h2>\n<p>Send the following information to the\u00a0<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>\u00a0to create a secure FTP (SFTP) directory for you to upload your batch files:<\/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 address(s)<\/strong>: the IP addresses of the servers you from which you are going to upload batch request files. Make sure that these are external IP addresses and not your internal network ones.<\/li>\n<li><strong>Your public SSH key<\/strong>: you need to generate an RSA SSH key pair (public and private keys). The length of your SSH key must be 2048 bits or 4096 bits. Reference for\u00a0<a href=\"https:\/\/www.ssh.com\/academy\/ssh\/keygen#:~:text=t option and-,key size,-using the -b\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Linux\/terminal<\/a> OR\u00a0for <a href=\"https:\/\/www.ssh.com\/academy\/ssh\/putty\/windows\/puttygen\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Windows<\/a>.<\/li>\n<li><strong>Technical point of contact<\/strong>: the names and email addresses of your technical points of contact.<\/li>\n<\/ul>\n<p>You will receive a response from Adyen Support when your SFTP server is configured and ready for you to access.<\/p>\n<h2>Connecting to the SFTP server<\/h2>\n<p>When you connect to the SFTP server, use the following information:<\/p>\n<p><strong>Test<\/strong><br \/>\n<span translate=\"no\"><strong>Host<\/strong><\/span>: <code>sftp-test.adyen.com<\/code><br \/>\n<span translate=\"no\"><strong>Port<\/strong><\/span>: <code>5892<\/code><br \/>\n<span translate=\"no\"><strong>User<\/strong><\/span>: the user provided to you by Support. For example: <code>batch_12345@Company.YOUR_COMPANY_ACCOUNT<\/code>.<br \/>\n<span translate=\"no\"><strong>Allowlist host IP<\/strong><\/span>: <code>213.52.172.120<\/code>, <code>147.12.18.50<\/code><\/p>\n<p><strong>Live<\/strong><br \/>\n<span translate=\"no\"><strong>Host<\/strong><\/span>: <code>sftp-live.adyen.com<\/code><br \/>\n<span translate=\"no\"><strong>Port<\/strong><\/span>: <code>5631<\/code><br \/>\n<span translate=\"no\"><strong>User<\/strong><\/span>: the user provided to you by Support. For example: <code>batch_56789@Company.YOUR_COMPANY_ACCOUNT<\/code>.<br \/>\n<span translate=\"no\"><strong>Allowlist host IP<\/strong><\/span>: <code>82.199.87.148<\/code><\/p>\n<h2 id=\"pgp-encryption\">PGP encryption<\/h2>\n<p>To keep your customer data secure, you must encrypt batch files with Adyen's PGP key before uploading them. Then, Adyen processes the batch and signs a <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-result-file\">batch result file<\/a> using Adyen's PGP key.<\/p>\n<p>For additional security, you can <a href=\"\/development-resources\/pgp-encryption#step-2-register-pgp-key-with-adyen\">register your PGP public key<\/a> with Adyen. When you register your PGP public key in the Customer Area, Adyen encrypts the batch result file with it.<\/p>\n<p>To encrypt with Adyen's PGP key:<\/p>\n<ol>\n<li>In your\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, go to\u00a0<strong>Settings<\/strong> &gt; <strong>Account settings<\/strong>.<\/li>\n<li>Click the\u00a0<strong>Manage PGP Keys<\/strong>\u00a0link.<\/li>\n<li>Select the Adyen key you want to use. To download the public part, select <strong>Download<\/strong>.<\/li>\n<li>Encrypt the file with this key before sending it to Adyen. Adyen signs the\u00a0<a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-result-file\">batch result file<\/a>\u00a0with this key.<\/li>\n<\/ol>\n<p>If you want Adyen to encrypt result files, <a href=\"\/development-resources\/pgp-encryption#step-2-register-pgp-key-with-adyen\">register your PGP public key<\/a> with Adyen, and specify\u00a0<strong>Batch Files<\/strong>\u00a0as the <strong>Purpose<\/strong> of the key.<\/p>\n<h3 id=\"pgp-troubleshooting\">PGP troubleshooting<\/h3>\n<p>In some cases, your file may be rejected. You receive a\u00a0<a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-acknowledgement-file\">batch acknowledgment file<\/a>\u00a0providing details about the rejections. Common causes for batch file rejection are:<\/p>\n<ul>\n<li>You send a PGP-encrypted file whose decryption operation returns errors.<br \/>\nFor example, a failure to verify the signature, or the key used to sign the file is not configured for your company account.<\/li>\n<li>You send a PGP-encrypted file, but you do not have a public key to encrypt the response file.<\/li>\n<li>You send an unencrypted file containing live card numbers.<\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files","articleFields":{"description":"Create input files for batch processing of transactions and upload the input file through SFTP.","id":"24216636","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"14-07-2020 13:36","feedback_component":true,"page_id":"c9b19b9b-bba7-4a20-9036-c28d1b1e16c4","filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files","title":"Submit transaction batch files through SFTP","content":"Batch file processing allows you to process multiple transactions in bulk: you submit a file listing all the payments you want us to process.\nThis feature comes in handy when you need to process refunds or retry failed capture attempts, for example. You group all the transactions in a file and then upload it for Adyen to process all the data.\nEach batch file can hold only one\u00a0request type per merchant account. Create separate files for each request like authorisation, refund, capture etc.\nIf you need to process modifications for multiple merchant accounts, contact our\u00a0Support Team to enable this for you.\nA secure communication channel is required to submit batch files. To achieve that, we use the SFTP transfer protocol and PGP data encryption.\nSFTP\u00a0configuration\nSend the following information to the\u00a0Support Team\u00a0to create a secure FTP (SFTP) directory for you to upload your batch files:\n\nYour Customer Area company account.\nYour source IP address(s): the IP addresses of the servers you from which you are going to upload batch request files. Make sure that these are external IP addresses and not your internal network ones.\nYour public SSH key: you need to generate an RSA SSH key pair (public and private keys). The length of your SSH key must be 2048 bits or 4096 bits. Reference for\u00a0Linux\/terminal OR\u00a0for Windows.\nTechnical point of contact: the names and email addresses of your technical points of contact.\n\nYou will receive a response from Adyen Support when your SFTP server is configured and ready for you to access.\nConnecting to the SFTP server\nWhen you connect to the SFTP server, use the following information:\nTest\nHost: sftp-test.adyen.com\nPort: 5892\nUser: the user provided to you by Support. For example: batch_12345@Company.YOUR_COMPANY_ACCOUNT.\nAllowlist host IP: 213.52.172.120, 147.12.18.50\nLive\nHost: sftp-live.adyen.com\nPort: 5631\nUser: the user provided to you by Support. For example: batch_56789@Company.YOUR_COMPANY_ACCOUNT.\nAllowlist host IP: 82.199.87.148\nPGP encryption\nTo keep your customer data secure, you must encrypt batch files with Adyen's PGP key before uploading them. Then, Adyen processes the batch and signs a batch result file using Adyen's PGP key.\nFor additional security, you can register your PGP public key with Adyen. When you register your PGP public key in the Customer Area, Adyen encrypts the batch result file with it.\nTo encrypt with Adyen's PGP key:\n\nIn your\u00a0Customer Area, go to\u00a0Settings &gt; Account settings.\nClick the\u00a0Manage PGP Keys\u00a0link.\nSelect the Adyen key you want to use. To download the public part, select Download.\nEncrypt the file with this key before sending it to Adyen. Adyen signs the\u00a0batch result file\u00a0with this key.\n\nIf you want Adyen to encrypt result files, register your PGP public key with Adyen, and specify\u00a0Batch Files\u00a0as the Purpose of the key.\nPGP troubleshooting\nIn some cases, your file may be rejected. You receive a\u00a0batch acknowledgment file\u00a0providing details about the rejections. Common causes for batch file rejection are:\n\nYou send a PGP-encrypted file whose decryption operation returns errors.\nFor example, a failure to verify the signature, or the key used to sign the file is not configured for your company account.\nYou send a PGP-encrypted file, but you do not have a public key to encrypt the response file.\nYou send an unencrypted file containing live card numbers.\n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Batch processing","lvl3":"Submit transaction batch files through SFTP"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"https:\/\/docs.adyen.com\/development-resources\/batch-processing","lvl3":"\/development-resources\/batch-processing\/advanced-sftp-batch-files"},"levels":4,"category":"Development Resources","category_color":"green","tags":["Submit","transaction","batch","files","through"]}}
