{"title":"Batch acknowledgement file","category":"default","creationDate":1779620072,"content":"<p>We describe the fields\u00a0included in the\u00a0<a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-file-naming-and-structure\">batch acknowledgment (ACK) file<\/a>.<\/p>\n<p>After validating the submitted batch request file, an ACK file generates:<\/p>\n<ul>\n<li>If the batch request file successfully passes the validation check, the ACK file provides a report overview of the processed data.<\/li>\n<li>If one or more lines in the requested file do not pass the validation check, they are included in the generated ACK file so you can review them.<\/li>\n<\/ul>\n<h2 id=\"ack---validation-successful\">ACK - Validation successful<\/h2>\n<p>After receiving a batch request file, the Adyen payments platform\u00a0carries out a series of validation checks.\u00a0If all validation checks are successful, a batch acknowledgment (ACK) file generates and returns with the fields described below.<\/p>\n<pre><code class=\"language-text\">FH,1.0,TEST,Company,TestCompany,CaptureOverAuthAmount,1,ws@Company.TestCompany,Modification,EchoData_BatchAck\nR,2,8\nN,NextFileSubmissionNumber,2<\/code><\/pre>\n<h4 id=\"file-header-fh\">File Header\u00a0[FH]<\/h4>\n<p>The File Header\u00a0[FH] record marks the start of the ACK file.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>FH<\/code>.<\/td>\n<td>Record type identifier.<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Numeric<\/td>\n<td>Version number.<br \/> This field enables version control for the release of future enhancements for batch processing.<\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>Allowed values:<ul><li markdown=\"1\"><code>TEST<\/code><\/li><li markdown=\"1\"><code>LIVE<\/code><\/li><\/ul><\/td>\n<td>It specifies the environment: either test or live\/production.<\/td>\n<\/tr>\n<tr>\n<td>4<\/td>\n<td>Fixed value: <code>Company<\/code><\/td>\n<td>Account type.<\/td>\n<\/tr>\n<tr>\n<td>5<\/td>\n<td>Alphanumeric<\/td>\n<td>Specifies the company account name.<\/td>\n<\/tr>\n<tr>\n<td>6<\/td>\n<td>Alphanumeric<\/td>\n<td>Submission platform.<br \/>The value specified in the file should match the corresponding value in the file name.<\/td>\n<\/tr>\n<tr>\n<td>7<\/td>\n<td>Numeric<\/td>\n<td>File sequence number.<br \/>The value\u00a0specified in the file should match the corresponding value in the file name.<\/td>\n<\/tr>\n<tr>\n<td>8<\/td>\n<td>Alphanumeric<\/td>\n<td>The username of the API credential linked to your Adyen company account.<\/td>\n<\/tr>\n<tr>\n<td>9<\/td>\n<td>Allowed values:<ul><li markdown=\"1\"><code>Authorisation<\/code><\/li><li markdown=\"1\"><code>Payout<\/code><\/li><li markdown=\"1\"><code>RefundWithData<\/code><\/li><li markdown=\"1\"><code>Modification<\/code><\/li><li markdown=\"1\"><code>PayoutModification<\/code><\/li><li markdown=\"1\"><code>AccountUpdater<\/code><\/li><\/ul><\/td>\n<td>File type.  <br \/>Defines the type of transactions that are submitted for further processing.<\/td>\n<\/tr>\n<tr>\n<td>10<\/td>\n<td>Alphanumeric<\/td>\n<td><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=\"record-line-r\">Record Line\u00a0[R]<\/h4>\n<p>The File Trailer record specifies the number of blocks and lines in the ACK file.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>R<\/code><\/td>\n<td>Record type identifier.<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Numeric<\/td>\n<td>Number of processed blocks.<\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>Numeric<\/td>\n<td>Number of processed line records.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"next-file-submission-number-n\">Next File Submission Number\u00a0[N]<\/h4>\n<p>This line specifies the number of the next file to process in a batch submission sequence. File sequence numbers are associated with the submission platform the files originate from, and they sequentially increment by one unit after each successful file submission.<\/p>\n<p>The\u00a0<code>NextFileSubmissionNumber<\/code> sub-line is always included in an ACK file, regardless of the file validation outcome:<\/p>\n<ul>\n<li>\n<p>When a file in a batch process is submitted successfully and without errors, the submission number for the next file in the process increases sequentially.<\/p>\n<\/li>\n<li>\n<p>When a file in a batch process contains errors, the system tries to guess the submission number for the next file in the sequence. Therefore, this value may be incorrect.<\/p>\n<\/li>\n<\/ul>\n<p>A correct file in a batch submission process satisfies the following minimum requirements:<\/p>\n<ul>\n<li>\n<p>The file name adheres to the naming conventions for batch acknowledgement files (ACK).<\/p>\n<\/li>\n<li>\n<p>The file data matches the expected data type and format.<\/p>\n<\/li>\n<\/ul>\n<p>The submission number is always incorrect when it is not possible to read or parse the header of a file. This can happen in the following cases:<\/p>\n<ul>\n<li>\n<p>The file sequence number is missing or it is incorrectly formatted in the file name.<\/p>\n<\/li>\n<li>\n<p>The submission platform name is missing or it is incorrectly formatted in the file name.<\/p>\n<\/li>\n<li>\n<p>A database exception might occur during file insertion.<\/p>\n<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>N<\/code><\/td>\n<td>Record type identifier<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Fixed value:\u00a0<code>NextFileSubmissionNumber<\/code><\/td>\n<td>Record content definition.<\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>Numeric<\/td>\n<td>The number corresponding to the next expected file in the submission sequence.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"ack---validation-failed\">ACK - Validation failed<\/h2>\n<p>When one or more validation errors occur, an error line gets generated per line in the requested file that did not pass validation.<\/p>\n<pre><code class=\"language-text\">E,L,5,5000,Invalid Merchant Account \nE,L,6,5000,Invalid Merchant Account \nN,NextFileSubmissionNumber,2<\/code><\/pre>\n<h4 id=\"error-line-e\">Error Line [E]<\/h4>\n<p>The File Header record contains marks the start of the ACK file.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>E<\/code><\/td>\n<td>Record type identifier<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Allowed values:<ul><li markdown=\"1\"><code>FH<\/code><\/li><li markdown=\"1\"><code>L<\/code><\/li><li markdown=\"1\"><code>SL<\/code><\/li><li markdown=\"1\"><code>F<\/code><\/li><\/ul><\/td>\n<td>The record type where the error occurred:<ul><li markdown=\"1\"><code>FH<\/code>: the error occurred in the <em>file header<\/em>.<\/li><li markdown=\"1\"><code>L<\/code>: the error occurred in a <em>line<\/em> record.<\/li><li markdown=\"1\"><code>SL<\/code>: the error occurred in a <em>sub-line<\/em> record.<\/li><li markdown=\"1\"><code>F<\/code>: the error occurred as the file was incomplete or unreadable.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>Numeric<\/td>\n<td>The file line number where the error occurred.<\/td>\n<\/tr>\n<tr>\n<td>4<\/td>\n<td>Numeric<\/td>\n<td>The error code associated with the error.<\/td>\n<\/tr>\n<tr>\n<td>5<\/td>\n<td>Alphanumeric<\/td>\n<td>The error description.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"next-file-submission-number-n-1\">Next File Submission Number [N]<\/h4>\n<p>This line specifies the number of the next file to process in a batch submission sequence. File sequence numbers are associated with the submission platform the files originate from, and they sequentially increment by one unit after each successful file submission.<\/p>\n<p>The\u00a0<code>NextFileSubmissionNumber<\/code> sub-line is always included in an ACK file, regardless of the file validation outcome:<\/p>\n<ul>\n<li>\n<p>When a file in a batch process is submitted successfully and without errors, the submission number for the next file in the process increases sequentially.<\/p>\n<\/li>\n<li>\n<p>When a file in a batch process contains errors, the system tries to guess the submission number for the next file in the sequence. Therefore, this value may be incorrect.<\/p>\n<\/li>\n<\/ul>\n<p>A correct file in a batch submission process satisfies the following minimum requirements:<\/p>\n<ul>\n<li>\n<p>The file name adheres to the naming conventions for batch acknowledgement files (ACK).<\/p>\n<\/li>\n<li>\n<p>The file data matches the expected data type and format.<\/p>\n<\/li>\n<\/ul>\n<p>The submission number is always incorrect when it is not possible to read or parse the header of a file. This can happen in the following cases:<\/p>\n<ul>\n<li>\n<p>The file sequence number is missing or it is incorrectly formatted in the file name.<\/p>\n<\/li>\n<li>\n<p>The submission platform name is missing or it is incorrectly formatted in the file name.<\/p>\n<\/li>\n<li>\n<p>A database exception might occur during file insertion.<\/p>\n<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th>Field #<\/th>\n<th>Format<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Fixed value: <code>N<\/code><\/td>\n<td>Record type identifier<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Fixed value:\u00a0<code>NextFileSubmissionNumber<\/code><\/td>\n<td>Record content definition.<\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>Numeric<\/td>\n<td>The number corresponding to the next expected file in the submission sequence.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-acknowledgement-file","articleFields":{"id":"24216675","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"29-04-2019 16:55"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-acknowledgement-file","title":"Batch acknowledgement file","content":"We describe the fields\u00a0included in the\u00a0batch acknowledgment (ACK) file.\nAfter validating the submitted batch request file, an ACK file generates:\n\nIf the batch request file successfully passes the validation check, the ACK file provides a report overview of the processed data.\nIf one or more lines in the requested file do not pass the validation check, they are included in the generated ACK file so you can review them.\n\nACK - Validation successful\nAfter receiving a batch request file, the Adyen payments platform\u00a0carries out a series of validation checks.\u00a0If all validation checks are successful, a batch acknowledgment (ACK) file generates and returns with the fields described below.\nFH,1.0,TEST,Company,TestCompany,CaptureOverAuthAmount,1,ws@Company.TestCompany,Modification,EchoData_BatchAck\nR,2,8\nN,NextFileSubmissionNumber,2\nFile Header\u00a0[FH]\nThe File Header\u00a0[FH] record marks the start of the ACK file.\n\n\n\nField #\nFormat\nDescription\n\n\n\n\n1\nFixed value: FH.\nRecord type identifier.\n\n\n2\nNumeric\nVersion number. This field enables version control for the release of future enhancements for batch processing.\n\n\n3\nAllowed values:TESTLIVE\nIt specifies the environment: either test or live\/production.\n\n\n4\nFixed value: Company\nAccount type.\n\n\n5\nAlphanumeric\nSpecifies the company account name.\n\n\n6\nAlphanumeric\nSubmission platform.The value specified in the file should match the corresponding value in the file name.\n\n\n7\nNumeric\nFile sequence number.The value\u00a0specified in the file should match the corresponding value in the file name.\n\n\n8\nAlphanumeric\nThe username of the API credential linked to your Adyen company account.\n\n\n9\nAllowed values:AuthorisationPayoutRefundWithDataModificationPayoutModificationAccountUpdater\nFile type.  Defines the type of transactions that are submitted for further processing.\n\n\n10\nAlphanumeric\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\nRecord Line\u00a0[R]\nThe File Trailer record specifies the number of blocks and lines in the ACK file.\n\n\n\nField #\nFormat\nDescription\n\n\n\n\n1\nFixed value: R\nRecord type identifier.\n\n\n2\nNumeric\nNumber of processed blocks.\n\n\n3\nNumeric\nNumber of processed line records.\n\n\n\nNext File Submission Number\u00a0[N]\nThis line specifies the number of the next file to process in a batch submission sequence. File sequence numbers are associated with the submission platform the files originate from, and they sequentially increment by one unit after each successful file submission.\nThe\u00a0NextFileSubmissionNumber sub-line is always included in an ACK file, regardless of the file validation outcome:\n\n\nWhen a file in a batch process is submitted successfully and without errors, the submission number for the next file in the process increases sequentially.\n\n\nWhen a file in a batch process contains errors, the system tries to guess the submission number for the next file in the sequence. Therefore, this value may be incorrect.\n\n\nA correct file in a batch submission process satisfies the following minimum requirements:\n\n\nThe file name adheres to the naming conventions for batch acknowledgement files (ACK).\n\n\nThe file data matches the expected data type and format.\n\n\nThe submission number is always incorrect when it is not possible to read or parse the header of a file. This can happen in the following cases:\n\n\nThe file sequence number is missing or it is incorrectly formatted in the file name.\n\n\nThe submission platform name is missing or it is incorrectly formatted in the file name.\n\n\nA database exception might occur during file insertion.\n\n\n\n\n\nField #\nFormat\nDescription\n\n\n\n\n1\nFixed value: N\nRecord type identifier\n\n\n2\nFixed value:\u00a0NextFileSubmissionNumber\nRecord content definition.\n\n\n3\nNumeric\nThe number corresponding to the next expected file in the submission sequence.\n\n\n\nACK - Validation failed\nWhen one or more validation errors occur, an error line gets generated per line in the requested file that did not pass validation.\nE,L,5,5000,Invalid Merchant Account \nE,L,6,5000,Invalid Merchant Account \nN,NextFileSubmissionNumber,2\nError Line [E]\nThe File Header record contains marks the start of the ACK file.\n\n\n\nField #\nFormat\nDescription\n\n\n\n\n1\nFixed value: E\nRecord type identifier\n\n\n2\nAllowed values:FHLSLF\nThe record type where the error occurred:FH: the error occurred in the file header.L: the error occurred in a line record.SL: the error occurred in a sub-line record.F: the error occurred as the file was incomplete or unreadable.\n\n\n3\nNumeric\nThe file line number where the error occurred.\n\n\n4\nNumeric\nThe error code associated with the error.\n\n\n5\nAlphanumeric\nThe error description.\n\n\n\nNext File Submission Number [N]\nThis line specifies the number of the next file to process in a batch submission sequence. File sequence numbers are associated with the submission platform the files originate from, and they sequentially increment by one unit after each successful file submission.\nThe\u00a0NextFileSubmissionNumber sub-line is always included in an ACK file, regardless of the file validation outcome:\n\n\nWhen a file in a batch process is submitted successfully and without errors, the submission number for the next file in the process increases sequentially.\n\n\nWhen a file in a batch process contains errors, the system tries to guess the submission number for the next file in the sequence. Therefore, this value may be incorrect.\n\n\nA correct file in a batch submission process satisfies the following minimum requirements:\n\n\nThe file name adheres to the naming conventions for batch acknowledgement files (ACK).\n\n\nThe file data matches the expected data type and format.\n\n\nThe submission number is always incorrect when it is not possible to read or parse the header of a file. This can happen in the following cases:\n\n\nThe file sequence number is missing or it is incorrectly formatted in the file name.\n\n\nThe submission platform name is missing or it is incorrectly formatted in the file name.\n\n\nA database exception might occur during file insertion.\n\n\n\n\n\nField #\nFormat\nDescription\n\n\n\n\n1\nFixed value: N\nRecord type identifier\n\n\n2\nFixed value:\u00a0NextFileSubmissionNumber\nRecord content definition.\n\n\n3\nNumeric\nThe number corresponding to the next expected file in the submission sequence.\n\n\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 acknowledgement 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-acknowledgement-file"},"levels":5,"category":"Development Resources","category_color":"green","tags":["Batch","acknowledgement"]}}