{"title":"Provide supporting information as attachments","category":"default","creationDate":1776961628,"content":"<p>Before you submit a dispute, we recommend that you include attachments as supporting information. Examples of supporting information are screenshots or photos of receipts, email communication with the merchant, or any other information the card scheme can review to make a decision on the dispute.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the requirements, limitations, and preparations described under <a href=\"\/pt\/issuing\/raise-disputes#requirements\">Raise disputes<\/a>.<\/p>\n<h2>Upload an attachment<\/h2>\n<ol>\n<li>\n<p>Base64-encode any attachments the cardholder provides for upload with their dispute.<\/p>\n<\/li>\n<li>\n<p>Make a POST  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/disputes\/{disputeId}\/attachments<\/a> request, specifying the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/get\/disputes\/(disputeId)\/attachments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disputeId<\/a> as a path parameter and the following request parameters.<\/p>\n<ul>\n<li>When you present the screen to cardholders to upload attachments, make sure they know which file types we support (JPEG, PDF, TIFF).<\/li>\n<li>Make sure any photos you attach to the dispute are in-focus and not blurry.<\/li>\n<li>Attachments must be in Base64-encoded string format.<\/li>\n<li>If a cardholder wants to upload multiple attachments, you need to make a separate POST request for each attachment.<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter name<\/th>\n<th style=\"text-align: left;\">Type<\/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;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments#request-attachmentType\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">attachmentType<\/a><\/td>\n<td style=\"text-align: left;\">string<\/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 type of information contained in the attachment.<br\/>Possible values:<ul><li><span translate=\"no\"><strong>receipt<\/strong><\/span><\/li><li><span translate=\"no\"><strong>correspondence<\/strong><\/span><\/li><li><span translate=\"no\"><strong>other<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments#request-fileName\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">fileName<\/a><\/td>\n<td style=\"text-align: left;\">string<\/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 name of the attachment, including its filename extension. Minimum length: four characters, Maximum length: 17 characters, including the extension type.<br\/>Supported filename extensions:<ul><li><span translate=\"no\"><strong>jpeg<\/strong><\/span><\/li><li><span translate=\"no\"><strong>pdf<\/strong><\/span><\/li><li><span translate=\"no\"><strong>tiff<\/strong><\/span><\/li><\/ul>Examples:<ul><li><span translate=\"no\"><strong>airfare24_03.jpeg<\/strong><\/span><\/li><li><span translate=\"no\"><strong>hotel24_0315.jpeg<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments#request-content\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">content<\/a><\/td>\n<td style=\"text-align: left;\">string<\/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 content of the image. An attachment must be Base64-encoded data.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Upload an attachment as supporting information for a dispute'\" :id=\"'upload-supporting-info-attachment-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/api\\\/v4\\\/disputes\\\/40QH6J64D0HK7ZLG\\\/attachments \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-X POST \\\\\\n-d '{\\n      \\&quot;fileName\\&quot; : \\&quot;240328UAL03.jpeg\\&quot;,\\n      \\&quot;attachmentType\\&quot; : \\&quot;receipt\\&quot;,\\n      \\&quot;content\\&quot;: \\&quot;PITYERi0xLjQKJcOkw7zDts...OfCjIgMCBv+f\\\/ub0j6JPRX+E3EmC==\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>In the response, note the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments#responses-200-attachmentId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">attachmentId<\/a>. You need the ID if you want to later <a href=\"#get-an-attachment\">get the attachment<\/a>, or <a href=\"#delete-an-attachment\">delete the attachment<\/a>.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Parameter name<\/th>\n<th style=\"text-align: left;\">Type<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments#responses-200-attachmentId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">attachmentId<\/a><\/td>\n<td style=\"text-align: left;\">string<\/td>\n<td style=\"text-align: left;\">The unique identifier of the attachment.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"''\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n    \\\"attachmentId\\\": \\\"TXAT42225223223N5LNW5PC9S62DSH\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2>Get an attachment<\/h2>\n<p>You can retrieve an attachment associated with a dispute when you know the specific dispute ID and attachment ID you want.<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/get\/disputes\/(disputeId)\/attachments\/(attachmentId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/disputes\/{disputeId}\/attachments\/{attachmentId}<\/a> request, specifying the dispute  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes#responses-200-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">id<\/a> and the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/post\/disputes\/(disputeId)\/attachments#responses-200-attachmentId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">attachmentId<\/a> as path parameters.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get an attachment by attachmentId'\" :id=\"'get-supporting-info-attachment-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/api\\\/v4\\\/disputes\\\/40QH6J64D0HK7ZLG\\\/attachments\\\/TXAT42225223223N5LNW5PC9S62DSH \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-X GET&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>If you want to view the attachment, Base64-decode the <code>content<\/code> string from the response. The response also contains the <code>id<\/code>, the <code>fileName<\/code> and <code>attachmentType<\/code> type of attachment.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'get-attachment-by-id-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"{\\n   \\\"id\\\": \\\"TXAT42225223223N5LNW5PC9S62DSH\\\",\\n   \\\"fileName\\\": \\\"240328UAL03.jpeg\\\",\\n   \\\"attachmentType\\\" : \\\"receipt\\\",\\n   \\\"content\\\": \\\"PITYERi0xLjQKJcOkw7zDts...OfCjIgMCBv+f\\\/ub0j6JPRX+E3EmC==\\\"\\n}\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2>Get a list of attachments<\/h2>\n<p>You can retrieve a list of all attachments associated with a specific dispute.<\/p>\n<ol>\n<li>\n<p>Make a GET  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/get\/disputes\/(disputeId)\/attachments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/disputes\/{disputeId}\/attachments\/<\/a> request, specifying the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/get\/disputes\/(disputeId)\/attachments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disputeId<\/a> as a path parameter.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Get a list of attachments associated with a dispute'\" :id=\"'get-supporting-info-attachment-list-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/api\\\/v4\\\/disputes\\\/40QH6J64D0HK7ZLG\\\/attachments \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-X GET&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>The response contains all attachments associated with the dispute.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Response'\" :id=\"'attachment-list-response'\" :code-data='[{\"language\":\"json\",\"tabTitle\":\"\",\"content\":\"[\\n    {\\n        \\\"id\\\": \\\"TXAT42225223223N5LNW4CL9S22KNM\\\",\\n        \\\"fileName\\\": \\\"240312KLA01.jpeg\\\"\\n    },\\n    {\\n        \\\"id\\\": \\\"TXAT42225223223N5LNW4CL9S32PFZ\\\",\\n        \\\"fileName\\\": \\\"240316UAL02.jpeg\\\"\\n    },\\n    {\\n        \\\"id\\\": \\\"TXAT42225223223N5LNW5PC9S62DSH\\\",\\n        \\\"fileName\\\": \\\"240328UAL03.jpeg\\\"\\n    }\\n]\"}]' :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\n<h2>Delete an attachment<\/h2>\n<p>You may want to delete an attachment associated with a dispute in some cases. For example, your cardholder uploaded the wrong attachment and wants to remove it from the dispute.<\/p>\n<p>Adyen may retain files attached to disputes for auditing and compliance purposes.<\/p>\n<p>To delete an attachment:<\/p>\n<ol>\n<li>\n<p>Make a DELETE  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/delete\/disputes\/(disputeId)\/attachments\/(attachmentId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/disputes\/{disputeId}\/attachments\/{attachmentId}<\/a> request, specifying the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/delete\/disputes\/(disputeId)\/attachments\/(attachmentId)#path-disputeId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">disputeId<\/a> and  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers-api\/latest\/delete\/disputes\/(disputeId)\/attachments\/(attachmentId)#path-attachmentId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">attachmentId<\/a> as path parameters.<\/p>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Remove an attachment from a dispute'\" :id=\"'delete-supporting-info-attachment-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/balanceplatform-api-test.adyen.com\\\/btl\\\/api\\\/v4\\\/disputes\\\/40QH6J64D0HK7ZLG\\\/attachments\\\/HY54TH87HT90FFG9 \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-H 'x-api-key: ADYEN_BALANCE_PLATFORM_API_KEY' \\\\\\n-X DELETE \\\\\\n-d&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<\/li>\n<li>\n<p>Check that you receive an <span translate=\"no\"><strong>HTTP 204 - No Content<\/strong><\/span> status code as a response. This indicates that your request to delete the attachment was successful.<\/p>\n<p>If you want to upload a file attachment you recently deleted from a dispute, make sure to provide a unique name for the file before you upload it.<\/p>\n<\/li>\n<\/ol>\n<h2 id=\"see-also\">See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/issuing\/raise-disputes#lifecycle-of-a-raised-dispute\"\n                        target=\"_self\"\n                        >\n                    Lifecycle of a raised dispute\n                <\/a><\/li><li><a href=\"\/issuing\/raise-disputes#associating-ids-throughout-the-dispute-lifecycle\"\n                        target=\"_self\"\n                        >\n                    Associating IDs throughout the dispute lifecycle\n                <\/a><\/li><li><a href=\"\/issuing\/raise-disputes\/\"\n                        target=\"_self\"\n                        >\n                    Manage disputes\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/issuing\/raise-disputes\/attach-supporting-information","articleFields":{"description":"Add supporting documentation for a raised dispute, and manage attachments.","parameters":{"directoryPath":"\/issuing"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/issuing\/raise-disputes\/attach-supporting-information","title":"Provide supporting information as attachments","content":"Before you submit a dispute, we recommend that you include attachments as supporting information. Examples of supporting information are screenshots or photos of receipts, email communication with the merchant, or any other information the card scheme can review to make a decision on the dispute.\nRequirements\nBefore you begin, take into account the requirements, limitations, and preparations described under Raise disputes.\nUpload an attachment\n\n\nBase64-encode any attachments the cardholder provides for upload with their dispute.\n\n\nMake a POST  \/disputes\/{disputeId}\/attachments request, specifying the  disputeId as a path parameter and the following request parameters.\n\nWhen you present the screen to cardholders to upload attachments, make sure they know which file types we support (JPEG, PDF, TIFF).\nMake sure any photos you attach to the dispute are in-focus and not blurry.\nAttachments must be in Base64-encoded string format.\nIf a cardholder wants to upload multiple attachments, you need to make a separate POST request for each attachment.\n\n\n\n\nParameter name\nType\nRequired\nDescription\n\n\n\n\n attachmentType\nstring\n\nThe type of information contained in the attachment.Possible values:receiptcorrespondenceother\n\n\n fileName\nstring\n\nThe name of the attachment, including its filename extension. Minimum length: four characters, Maximum length: 17 characters, including the extension type.Supported filename extensions:jpegpdftiffExamples:airfare24_03.jpeghotel24_0315.jpeg\n\n\n content\nstring\n\nThe content of the image. An attachment must be Base64-encoded data.\n\n\n\n\n\n\n\n\nIn the response, note the  attachmentId. You need the ID if you want to later get the attachment, or delete the attachment.\n\n\n\nParameter name\nType\nDescription\n\n\n\n\n attachmentId\nstring\nThe unique identifier of the attachment.\n\n\n\n\n\n\n\n\nGet an attachment\nYou can retrieve an attachment associated with a dispute when you know the specific dispute ID and attachment ID you want.\n\n\nMake a GET  \/disputes\/{disputeId}\/attachments\/{attachmentId} request, specifying the dispute  id and the  attachmentId as path parameters.\n\n\n\n\n\nIf you want to view the attachment, Base64-decode the content string from the response. The response also contains the id, the fileName and attachmentType type of attachment.\n\n\n\n\n\nGet a list of attachments\nYou can retrieve a list of all attachments associated with a specific dispute.\n\n\nMake a GET  \/disputes\/{disputeId}\/attachments\/ request, specifying the  disputeId as a path parameter.\n\n\n\n\n\nThe response contains all attachments associated with the dispute.\n\n\n\n\n\nDelete an attachment\nYou may want to delete an attachment associated with a dispute in some cases. For example, your cardholder uploaded the wrong attachment and wants to remove it from the dispute.\nAdyen may retain files attached to disputes for auditing and compliance purposes.\nTo delete an attachment:\n\n\nMake a DELETE  \/disputes\/{disputeId}\/attachments\/{attachmentId} request, specifying the  disputeId and  attachmentId as path parameters.\n\n\n\n\n\nCheck that you receive an HTTP 204 - No Content status code as a response. This indicates that your request to delete the attachment was successful.\nIf you want to upload a file attachment you recently deleted from a dispute, make sure to provide a unique name for the file before you upload it.\n\n\nSee also\n\n\n                    Lifecycle of a raised dispute\n                \n                    Associating IDs throughout the dispute lifecycle\n                \n                    Manage disputes\n                \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Issuing","lvl2":"Raise disputes for transactions made with an Adyen-issued card","lvl3":"Provide supporting information as attachments"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/issuing","lvl2":"https:\/\/docs.adyen.com\/pt\/issuing\/raise-disputes","lvl3":"\/pt\/issuing\/raise-disputes\/attach-supporting-information"},"levels":4,"category":"Issuing","category_color":"green","tags":["Provide","supporting","information","attachments"]}}
