{"title":"Batch request file","category":"default","creationDate":1779620072,"content":"<p>The following fields are common across all batch request files, regardless of the\u00a0<a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-file-naming-and-structure\">transaction type<\/a>\u00a0being submitted. They must be included in each batch request file.<\/p>\n<pre><code class=\"language-text\">FH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData\nBH,1,BlockHeaderEchoData\n...\nBT,5\nFT,1<\/code><\/pre>\n<h4 id=\"file-header-fh\">File Header\u00a0[FH]<\/h4>\n<p>Contains information that is crucial to successfully process the batch file:<\/p>\n<ul>\n<li>It identifies the merchant account the transactions refers to;<\/li>\n<li>It specifies the <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-file-naming-and-structure\">file submission number<\/a>;<\/li>\n<li>It defines the <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-file-naming-and-structure\">transaction type<\/a> that needs to be processed.<\/li>\n<\/ul>\n<table><thead><tr class=\"header\"><th style=\"text-align: left;\"><p>Field #<\/p><\/th><th style=\"text-align: left;\"><p>Format<\/p><\/th><th style=\"text-align: left;\"><p>Required<\/p><\/th><th style=\"text-align: left;\"><p>Description<\/p><\/th><\/tr><\/thead><tbody><tr><td style=\"text-align: left;\"><p>1<\/p><\/td><td style=\"text-align: left;\">Fixed value: `FH`<\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\"><p>Record type identifier.<\/p><\/td><\/tr><tr><td style=\"text-align: left;\"><p>2<\/p><\/td><td style=\"text-align: left;\">Fixed value: `1.0`<\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\">Version number.<br> This field enables version control for the release of future enhancements for batch processing.<\/td><\/tr><tr><td style=\"text-align: left;\"><p>3<\/p><\/td><td style=\"text-align: left;\">Allowed values:<ul><li>\n<p><code>TEST<\/code><\/p>\n<\/li><li>\n<p><code>LIVE<\/code><\/p>\n<\/li><\/ul><\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\">It specifies the environment: either test or live\/production.<\/td><\/tr><tr><td style=\"text-align: left;\"><p>4<\/p><\/td><td style=\"text-align: left;\">Fixed value: `Company`<\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\"><p>Account type.<\/p><\/td><\/tr><tr><td style=\"text-align: left;\"><p>5<\/p><\/td><td style=\"text-align: left;\"><p>Alphanumeric<\/p><\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\"><p>Specifies the company account name.<\/p><\/td><\/tr><tr><td style=\"text-align: left;\"><p>6<\/p><\/td><td style=\"text-align: left;\"><p>Alphanumeric<\/p><\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\">Submission platform.<br>The value specified in the file should match the corresponding value in the file name.<\/td><\/tr><tr><td style=\"text-align: left;\"><p>7<\/p><\/td><td style=\"text-align: left;\"><p>Numeric<\/p><\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\">File sequence number.<br>The value\u00a0specified in the file should match the corresponding value in the file name.<\/td><\/tr><tr><td style=\"text-align: left;\"><p>8<\/p><\/td><td style=\"text-align: left;\"><p>Alphanumeric<\/p><\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\"><p>The username of the API credential linked to your Adyen company account.<\/p><\/td><\/tr><tr><td style=\"text-align: left;\"><p>9<\/p><\/td><td style=\"text-align: left;\"><p>Allowed values:<\/p><ul><li>\n<p><a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/authorisation-request-file\">Authorisation<\/a><\/p>\n<\/li><li>\n<p><a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/payout-request-file\">Payout<\/a><\/p>\n<\/li><li>\n<p><a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/refundwithdata-request-file\">RefundWithData<\/a><\/p>\n<\/li><li>\n<p><a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/modification-request-file\">Modification<\/a><\/p>\n<\/li><li>\n<p><a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/payoutmodification-request-file\">PayoutModification<\/a><\/p>\n<\/li><li>\n<p><a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/accountupdater-request-file\">AccountUpdater<\/a><\/p>\n<\/li><\/ul><\/td><td style=\"text-align: left;\"><p><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/p><\/td><td style=\"text-align: left;\">File type.  <br>Defines the type of transactions that are submitted for further processing.<\/td><\/tr><tr><td style=\"text-align: left;\"><p>10<\/p><\/td><td style=\"text-align: left;\"><p>Alphanumeric<\/p><\/td><td style=\"text-align: left;\"><p><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/p><\/td><td style=\"text-align: left;\"><p>`EchoData`<br>In this field you can specify any data you may want to be returned with the result file. When this field is populated, its content is returned exactly as is. The\u00a0Adyen payments platform does not use this data.<br>Maximum character length: 80 characters.<\/p><\/td><\/tr><\/tbody><\/table>\n<h4 id=\"file-trailer-ft\">File Trailer\u00a0[FT]<\/h4>\n<p>Specifies the number of blocks in the batch file.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>FT<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Record type identifier.<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Numeric<\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Number of blocks in the file.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"block-header-bh\">Block Header\u00a0[BH]<\/h4>\n<p>Notifies the Adyen payments platform about a new grouping of transactions that should be expected.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field #<\/th>\n<th style=\"text-align: left;\">Format<\/th>\n<th style=\"text-align: left;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">1<\/td>\n<td style=\"text-align: left;\">Fixed value: <code>BH<\/code><\/td>\n<td style=\"text-align: left;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Record type identifier.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">2<\/td>\n<td style=\"text-align: left;\">Numeric<\/td>\n<td style=\"text-align: left;\"><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td style=\"text-align: left;\">Block number.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Its value increments sequentially by one unit per block.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">3<\/td>\n<td style=\"text-align: left;\">Alphanumeric<\/td>\n<td style=\"text-align: left;\"><img title=\"-x-\" alt=\"-x-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/x.png\" \/><\/td>\n<td style=\"text-align: left;\"><code>EchoData<\/code><br \/>In this field you can specify any data you may want to be returned with the result file. When this field is populated, its content is returned exactly as is. The\u00a0Adyen payments platform does not use this data.<br \/>Maximum character length: 80 characters.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"block-trailer-bt\">Block Trailer\u00a0[BT]<\/h4>\n<p>Specifies the number of lines in the block it refers to.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>BT<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Record type identifier.<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Numeric<\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Number of line records in the block.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div class=\"sc-notice note\"><div>\n<p>After preparing the batch file as outlined above, you can upload it to the <em>in<\/em> sub-folder of your SFTP folder. The Adyen payments platform can then fetch the file and add it to the processing queue.<\/p>\n<\/div><\/div>","url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file","articleFields":{"id":"24216642","type":"page","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file","title":"Batch request file","content":"The following fields are common across all batch request files, regardless of the\u00a0transaction type\u00a0being submitted. They must be included in each batch request file.\nFH,1.0,TEST,Company,TestCompany,Default,2,ws@Company.TestCompany,Authorisation,FileHeaderEchoData\nBH,1,BlockHeaderEchoData\n...\nBT,5\nFT,1\nFile Header\u00a0[FH]\nContains information that is crucial to successfully process the batch file:\n\nIt identifies the merchant account the transactions refers to;\nIt specifies the file submission number;\nIt defines the transaction type that needs to be processed.\n\nField #FormatRequiredDescription1Fixed value: `FH`Record type identifier.2Fixed value: `1.0`Version number. This field enables version control for the release of future enhancements for batch processing.3Allowed values:\nTEST\n\nLIVE\nIt specifies the environment: either test or live\/production.4Fixed value: `Company`Account type.5AlphanumericSpecifies the company account name.6AlphanumericSubmission platform.The value specified in the file should match the corresponding value in the file name.7NumericFile sequence number.The value\u00a0specified in the file should match the corresponding value in the file name.8AlphanumericThe username of the API credential linked to your Adyen company account.9Allowed values:\nAuthorisation\n\nPayout\n\nRefundWithData\n\nModification\n\nPayoutModification\n\nAccountUpdater\nFile type.  Defines the type of transactions that are submitted for further processing.10Alphanumeric`EchoData`In this field you can specify any data you may want to be returned with the result file. When this field is populated, its content is returned exactly as is. The\u00a0Adyen payments platform does not use this data.Maximum character length: 80 characters.\nFile Trailer\u00a0[FT]\nSpecifies the number of blocks in the batch file.\n\n\n\nField #\nFormat\nRequired\nDescription\n\n\n\n\n1\nFixed value: FT\n\nRecord type identifier.\n\n\n2\nNumeric\n\nNumber of blocks in the file.\n\n\n\nBlock Header\u00a0[BH]\nNotifies the Adyen payments platform about a new grouping of transactions that should be expected.\n\n\n\nField #\nFormat\nRequired\nDescription\n\n\n\n\n1\nFixed value: BH\n\nRecord type identifier.\n\n\n2\nNumeric\n\nBlock number.\n\n\nIts value increments sequentially by one unit per block.\n\n\n3\nAlphanumeric\n\nEchoDataIn this field you can specify any data you may want to be returned with the result file. When this field is populated, its content is returned exactly as is. The\u00a0Adyen payments platform does not use this data.Maximum character length: 80 characters.\n\n\n\nBlock Trailer\u00a0[BT]\nSpecifies the number of lines in the block it refers to.\n\n\n\nField #\nFormat\nRequired\nDescription\n\n\n\n\n1\nFixed value: BT\n\nRecord type identifier.\n\n\n2\nNumeric\n\nNumber of line records in the block.\n\n\n\n\nAfter preparing the batch file as outlined above, you can upload it to the in sub-folder of your SFTP folder. The Adyen payments platform can then fetch the file and add it to the processing queue.\n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Batch processing","lvl3":"Submit transaction batch files through SFTP","lvl4":"Batch request file"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"https:\/\/docs.adyen.com\/development-resources\/batch-processing","lvl3":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files","lvl4":"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file"},"levels":5,"category":"Development Resources","category_color":"green","tags":["Batch","request"]}}