Paymish Loading Docs Preparing guides, collections, and live API references...
Paymish Docs

Update a dispute.

Endpoint Overview

PUT /api/dispute-service/external/v1/update-dispute Requires authentication

Purpose

Use this endpoint to update a dispute. It belongs to the Dispute collection and is designed for backend integrations.

Request shape

0 parameters and 3 documented body fields using application/json.

Implementation Guide

Recommended workflow

1

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

2

Validate the input data, identifiers, and account state in your application before making the request.

3

Send the PUT request from your backend using the required headers and the expected content type (application/json).

4

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

  • Validate the request payload on your backend before sending it, especially the 3 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

tnxRef required
string
Transaction reference for the dispute. Example: TXN_4HfVJ6nkANC57iPiVXtYLS
reason required
string
Reason for updating the dispute. Example: Additional information received.
status required
string
Current status of the dispute. Example: Approved

Responses

200 Dispute updated successfully.
400 Bad request due to invalid or missing parameters.

Expected Outcomes

200

Evidence updated

Dispute updated successfully.

Representative Response
{
  "message": "Dispute updated successfully."
}
400

Evidence rejected

Bad request due to invalid or missing parameters.

Representative Error
{
  "error": "Invalid input data."
}
After the response:
  • Verify the transaction reference and case details before resubmitting the dispute flow.
  • Keep a durable audit trail of each evidence upload and operator action in your internal support system.
  • Retry only after fixing the payload or file issue, not by resending the same invalid multipart request unchanged.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

Python
import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
}
payload = {
  "tnxRef": "TXN_4HfVJ6nkANC57iPiVXtYLS",
  "reason": "Additional information received.",
  "status": "Approved"
}

response = requests.put(
    "https://api.paymish.com/api/dispute-service/external/v1/update-dispute",
    headers=headers,
    json=payload,
)

data = response.json()
print(data)
Node.js
const axios = require("axios");

const response = await axios({
  method: "put",
  url: "https://api.paymish.com/api/dispute-service/external/v1/update-dispute",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "tnxRef": "TXN_4HfVJ6nkANC57iPiVXtYLS",
  "reason": "Additional information received.",
  "status": "Approved"
}
});

console.log(response.data);
cURL
curl https://api.paymish.com/api/dispute-service/external/v1/update-dispute \
  -X PUT \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "tnxRef": "TXN_4HfVJ6nkANC57iPiVXtYLS",   "reason": "Additional information received.",   "status": "Approved" }'
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/dispute-service/external/v1/update-dispute");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "tnxRef" => "TXN_4HfVJ6nkANC57iPiVXtYLS",
    "reason" => "Additional information received.",
    "status" => "Approved",
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);