Update dispute

Update dispute details

PATCH https://<Platform-host>/api/transaction/:transaction_id/dispute

Path Parameters

Name	Type	Description
transaction_id*	UUID	Transaction ID

Headers

Name	Type	Description
content-type*	String	multipart/form-data

Request Body

Name	Type	Description
status*	String	Dispute status
description*	String	Explain why do you update
attachments	File array

200: OK Dispute details

Dispute Field Definition

Field Name	Type	Description	Required
data.id	uuid	Transaction ID
data.status	string	Current dispute's status
data.merchant_id	uuid	Merchant ID
data.account_id	uuid	Account ID
data.histories	array	History of dispute's updates
data.histories[i].id	number	Dispute update ID
data.histories[i].status	string	Dispute's status
data.histories[i].description	string	Dispute's description
data.histories[i].attachments	array	Dispute's attachments
data.histories[i].submitted_at	datetime	Timestamp when dispute was updated
data.histories[i].submitted_by	uuid	ID of user who updated
data.histories[i].submitted_by_role	string	Either processor or merchant

Sample Request

description:Requested information was attached
status:AWAITING_PROCESSOR_RESPONSE
attachments: BINARY

Sample response

{
    "data": {
        "id": "4c3d53fc-fe1b-4032-800f-557a04d3a239",
        "status": "AWAITING_PROCESSOR_RESPONSE",
        "merchant_id": "a9e30f16-1ef5-41e5-9ec2-c8e51a15b406",
        "account_id": "3c283938-b86f-428c-93bd-bbac524dhw83",
        "histories": [
            {
                "id": 81,
                "status": "AWAITING_PROCESSOR_RESPONSE",
                "description": "Requested information attached",
                "attachments": [
                    "AAHC02255H.pdf"
                ],
                "submitted_at": "2023-03-07T03:48:13.072Z",
                "submitted_by": "b9b293b9-96bc-4bb3-a7cc-a13200e0ffed",
                "submitted_by_role": "merchant"
            },
            {
                "id": 80,
                "status": "MORE_INFO_REQUESTED",
                "description": "Requested some information from merchant",
                "attachments": [],
                "submitted_at": "2023-03-04T01:21:27.780Z",
                "submitted_by": "b9b293b9-96bc-4bb3-a7cc-a13200e0ffed",
                "submitted_by_role": "master"
            }
        ]
    }
}on

Webhook event: DISPUTE_INFORMATION_UPDATED

Webhook payload example

{
  "event_uid": "e7497af98235102aefcd97a3be78ac8e",
  "event": "DISPUTE_INFORMATION_UPDATED",
  "data": {
    "status": "AWAITING_PROCESSOR_RESPONSE",
    "account_id": "3c283938-b86f-428c-93bd-bbac524dhw83",
    "description": "Needed information uploaded",
    "merchant_id": "a9e30f16-1ef5-41e5-9ec2-c8e51a15b406",
    "transaction_id": "4c3d53fc-fe1b-4032-800f-557a04d3a239"
  }
}