{"title":"Submit modifications in your Customer Area","category":"default","creationDate":1678718460,"content":"<p>If you require batch processing of payment modifications, the Customer Area offers the easiest way to get this done. Based on a simple <a href=\"#input-file\">CSV input file<\/a> that you upload, the Customer Area will help you to complete missing details and fix errors in the input file. The Customer Area is able to help you with the following modifications:<\/p>\n<ul>\n<li>Capture<\/li>\n<li>Cancel<\/li>\n<li>Refund<\/li>\n<li>Cancel or refund<\/li>\n<\/ul>\n<h2 id=\"before-you-begin\">Requirements<\/h2>\n<p>To be able to submit files in the Customer Area for batch processing of modifications, you need to have the following <a href=\"\/account\/user-roles\">roles<\/a>:<\/p>\n<ul>\n<li>Merchant submit batch modifications<\/li>\n<li>Merchant manage payments role<\/li>\n<\/ul>\n<p>If you need to process modifications for multiple merchant accounts, 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> to enable this for you.<\/p>\n<p>To receive updates on the outcome of modifications, set up <a href=\"\/development-resources\/webhooks\">webhooks<\/a>.<\/p>\n<h2 id=\"input-file\">Create an input file<\/h2>\n<p>To provide details of the payment modifications you require, you need to prepare a CSV (Comma Separated Values) file as per <a href=\"https:\/\/tools.ietf.org\/html\/rfc4180\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">RFC 4180<\/a> (with some exceptions), saved in <a href=\"https:\/\/en.wikipedia.org\/wiki\/UTF-8\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">UTF-8<\/a> format.<\/p>\n<p>To create a valid CSV input file, keep to the following rules:<\/p>\n<ul>\n<li>The file does not contain a header row.<\/li>\n<li>Each modification is a separate record, on a separate line.<\/li>\n<li>All records contain the same fields.<\/li>\n<li>The records do not contain empty fields (null values).<\/li>\n<li>The file does not contain more than 6000 records.<\/li>\n<li>Each record can contain the following fields:<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\">Merchant account<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The merchant account that you want to process the modifications for.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">PSP reference<\/td>\n<td style=\"text-align: center;\"><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;\">The PSP reference of the payment you want to modify.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Modification<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Type of modification. Allowed values: <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/modification-request-file\/authorisationreferral-request\">authoriseReferral<\/a>, <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/modification-request-file\/capture-request\">capture<\/a>, <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/modification-request-file\/cancel-request\">cancel<\/a>, <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/modification-request-file\/refund-request\">refund<\/a>, or <a href=\"\/development-resources\/batch-processing\/advanced-sftp-batch-files\/batch-request-file\/modification-request-file\/cancelorrefund-request\">cancelOrRefund<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Amount<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Transaction amount of the modification, in <a href=\"\/development-resources\/currency-codes\">minor units<\/a>. For example, if you want to refund GBP&nbsp;10, specify a value of 1000.  <div class=\"notices yellow\">For cancelOrRefund we will always refund the full amount, no matter which value you provide here.<\/div><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Currency<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Three-letter <a href=\"\/development-resources\/currency-codes\">currency code<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\">Reference<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Your unique reference for the modification.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div class=\"sc-notice info\"><div>\n<ul>\n<li>If you do not provide a <span translate=\"no\"><strong>Merchant account<\/strong><\/span>, we use the name of the account you are uploading the input file from.<\/li>\n<li>If you do not provide the <span translate=\"no\"><strong>Modification<\/strong><\/span>, <span translate=\"no\"><strong>Amount<\/strong><\/span>, or <span translate=\"no\"><strong>Currency<\/strong><\/span>, you can use the Customer Area to add these fields. However, that would set the same value for all records.\n<\/div><\/div><\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Example input file'\" :id=\"''\" :code-data='[{\"language\":\"raw\",\"tabTitle\":\"\",\"content\":\"YOUR_MERCHANT_ACCOUNT,PPKFQ89R6QRXGN82,refund,1000,EUR,\\nYOUR_MERCHANT_ACCOUNT,QFQTPCQ8HXSKGK82,refund,10000,EUR,\\nYOUR_MERCHANT_ACCOUNT,R8QTPCQ8HXSKGK82,capture,19123,EUR,YOUR_MODIFICATION_REFERENCE\\nYOUR_MERCHANT_ACCOUNT,JLCMPCQ8HXSKGK82,capture,4000,EUR,YOUR_MODIFICATION_REFERENCE\\nYOUR_MERCHANT_ACCOUNT,QJCMPCQ8HXSKGK82,refund,1000,GBP,\\nYOUR_MERCHANT_ACCOUNT,WNKH9MC2XJMLNK82,refund,1000,GBP,\\nYOUR_MERCHANT_ACCOUNT,ZQXDPCQ8HXSKGK82,refund,6000,NOK,\\nYOUR_MERCHANT_ACCOUNT,FJM726V375BV9D82,refund,2700,SGD,\\nYOUR_MERCHANT_ACCOUNT,V4HZ4RBFJGXXGN82,cancelOrRefund,0,EUR,\\nYOUR_MERCHANT_ACCOUNT,GH4R4RBFJGXXGN82,cancel,2000,EUR,\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"upload-modifications\">Upload modifications<\/h2>\n<ol>\n<li>\n<p><a href=\"#input-file\">Create a CSV input file<\/a> containing at least the PSP references of the payments you want to modify.<\/p>\n<\/li>\n<li>\n<p>Log in to your\u00a0<a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<\/li>\n<li>\n<p><a href=\"\/account\/manage-account-structure#switching-between-accounts\">Switch to your merchant account<\/a>.<\/p>\n<\/li>\n<li>\n<p>Go to\u00a0<strong>Finance<\/strong>\u00a0&gt;\u00a0<strong>Batch modifications<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Select <strong>Upload File<\/strong>, then select your CSV input file and select <strong>Submit<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Under <strong>Review Batch<\/strong> check for any errors:<\/p>\n<ul>\n<li>\n<p>If there are no errors, you'll see an overview of the batch, with the number of modifications and their total value.<\/p>\n<\/li>\n<li>\n<p>\"<em>Incomplete data<\/em>\": all records in the input file are missing one or more fields.<br \/>\nYou can add the missing fields in the input file and then upload the file again.<br \/>\nOr you can add the missing fields in the Customer Area, as described in the next step.<\/p>\n<\/li>\n<li>\n<p>Other errors: fix the input file based on the error description, and upload the file again.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>To fix an <em>Incomplete data<\/em> error by adding missing fields in the Customer Area:<\/p>\n<div class=\"sc-notice info\"><div>\n<p>All records will get the same value for the added field.<\/p>\n<\/div><\/div>\n<ol>\n<li>Select the <span style=\"font-size: 25px;\"><strong>+<\/strong><\/span> button. A dialog appears.<\/li>\n<li>In the <strong>Column<\/strong> field, select the field that is missing from the records.<\/li>\n<li>In the <strong>Fixed Value<\/strong> field, select the value to assign to the field, or enter an amount in minor units.<\/li>\n<li>Select <strong>Add Column<\/strong>.<\/li>\n<li>Repeat as needed if more fields are missing from the records.<\/li>\n<\/ol>\n<\/li>\n<li>\n<p>Select <strong>Upload<\/strong>.<br \/>\nThe batch file is QUEUED, and then PROCESSED.<\/p>\n<\/li>\n<\/ol>\n<h2>Check the result<\/h2>\n<p>After the batch file has finished processing, the status changes to COMPLETED. You can download the batch result file to check the result messages for the individual modifications. A result message can be green or red. Green (successful) means that the modification passed the validation. However, processing the modification can still fail.<\/p>\n<p>The validation of modifications consists of checks like the following:<\/p>\n<ul>\n<li>Is the amount to modify not higher than the authorised amount?<\/li>\n<li>Are there remaining funds in the payment to refund, capture or cancel?<\/li>\n<li>Does the merchant account have the funds to refund the transaction?<\/li>\n<\/ul>\n<p>If a modification passes the validation, we mark the modification as successful and try to process it. If the modification then fails, we inform you asynchronously through a webhook.<\/p>\n<h2 id=\"see-also\">See also<\/h2>\n<ul>\n<li><a href=\"\/development-resources\/batch-processing\">Batch processing<\/a><\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/submit-modifications","articleFields":{"description":"Create and upload input files for batch processing of payment modifications.","feedback_component":true,"last_edit_on":"13-03-2023 15:41","filters_component":false},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/batch-processing\/submit-modifications","title":"Submit modifications in your Customer Area","content":"If you require batch processing of payment modifications, the Customer Area offers the easiest way to get this done. Based on a simple CSV input file that you upload, the Customer Area will help you to complete missing details and fix errors in the input file. The Customer Area is able to help you with the following modifications:\n\nCapture\nCancel\nRefund\nCancel or refund\n\nRequirements\nTo be able to submit files in the Customer Area for batch processing of modifications, you need to have the following roles:\n\nMerchant submit batch modifications\nMerchant manage payments role\n\nIf you need to process modifications for multiple merchant accounts, contact our Support Team to enable this for you.\nTo receive updates on the outcome of modifications, set up webhooks.\nCreate an input file\nTo provide details of the payment modifications you require, you need to prepare a CSV (Comma Separated Values) file as per RFC 4180 (with some exceptions), saved in UTF-8 format.\nTo create a valid CSV input file, keep to the following rules:\n\nThe file does not contain a header row.\nEach modification is a separate record, on a separate line.\nAll records contain the same fields.\nThe records do not contain empty fields (null values).\nThe file does not contain more than 6000 records.\nEach record can contain the following fields:\n\n\n\n\nField\nRequired\nDescription\n\n\n\n\nMerchant account\n\nThe merchant account that you want to process the modifications for.\n\n\nPSP reference\n\nThe PSP reference of the payment you want to modify.\n\n\nModification\n\nType of modification. Allowed values: authoriseReferral, capture, cancel, refund, or cancelOrRefund.\n\n\nAmount\n\nTransaction amount of the modification, in minor units. For example, if you want to refund GBP&nbsp;10, specify a value of 1000.  For cancelOrRefund we will always refund the full amount, no matter which value you provide here.\n\n\nCurrency\n\nThree-letter currency code.\n\n\nReference\n\nYour unique reference for the modification.\n\n\n\n\n\nIf you do not provide a Merchant account, we use the name of the account you are uploading the input file from.\nIf you do not provide the Modification, Amount, or Currency, you can use the Customer Area to add these fields. However, that would set the same value for all records.\n\n\n\n    \n\nUpload modifications\n\n\nCreate a CSV input file containing at least the PSP references of the payments you want to modify.\n\n\nLog in to your\u00a0Customer Area.\n\n\nSwitch to your merchant account.\n\n\nGo to\u00a0Finance\u00a0&gt;\u00a0Batch modifications.\n\n\nSelect Upload File, then select your CSV input file and select Submit.\n\n\nUnder Review Batch check for any errors:\n\n\nIf there are no errors, you'll see an overview of the batch, with the number of modifications and their total value.\n\n\n\"Incomplete data\": all records in the input file are missing one or more fields.\nYou can add the missing fields in the input file and then upload the file again.\nOr you can add the missing fields in the Customer Area, as described in the next step.\n\n\nOther errors: fix the input file based on the error description, and upload the file again.\n\n\n\n\nTo fix an Incomplete data error by adding missing fields in the Customer Area:\n\nAll records will get the same value for the added field.\n\n\nSelect the + button. A dialog appears.\nIn the Column field, select the field that is missing from the records.\nIn the Fixed Value field, select the value to assign to the field, or enter an amount in minor units.\nSelect Add Column.\nRepeat as needed if more fields are missing from the records.\n\n\n\nSelect Upload.\nThe batch file is QUEUED, and then PROCESSED.\n\n\nCheck the result\nAfter the batch file has finished processing, the status changes to COMPLETED. You can download the batch result file to check the result messages for the individual modifications. A result message can be green or red. Green (successful) means that the modification passed the validation. However, processing the modification can still fail.\nThe validation of modifications consists of checks like the following:\n\nIs the amount to modify not higher than the authorised amount?\nAre there remaining funds in the payment to refund, capture or cancel?\nDoes the merchant account have the funds to refund the transaction?\n\nIf a modification passes the validation, we mark the modification as successful and try to process it. If the modification then fails, we inform you asynchronously through a webhook.\nSee also\n\nBatch processing\n","type":"page","locale":"en","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Batch processing","lvl3":"Submit modifications in your Customer Area"},"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\/submit-modifications"},"levels":4,"category":"Development Resources","category_color":"green","tags":["Submit","modifications","Customer"]}}