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

Dispute

Section Overview

Endpoints

4 endpoints in this collection.

Authentication

Review each endpoint for its auth requirement before implementation.

What this section covers

  • Raise a dispute for a transaction with supporting files or notes.
  • List disputes for internal operations or support teams.
  • Display dispute status to merchants or finance staff.

Method mix

POST 1
GET 2
PUT 1

Recommended Workflow

1

Capture the transaction reference and the business reason for the dispute.

2

Upload the dispute details and supporting evidence from a secure backend flow.

3

Poll or retrieve dispute details to track resolution status over time.

Implementation advice: start from the section workflow, then open the specific endpoint page for parameter details and language examples.

Implementation Readiness

Before You Start

Prerequisites

  • Capture the original transaction reference, merchant context, customer details, and dispute reason before starting the API flow.
  • Define where supporting evidence files will be uploaded from and validate accepted file size and MIME types in advance.
  • Align support, finance, and operations teams on the internal statuses they need to track while a dispute is open.
Launch Safely

Implementation Checklist

  • Persist dispute identifiers, related transaction references, and evidence metadata together.
  • Validate upload rules before sending multipart evidence requests.
  • Make every dispute update auditable so support teams can explain who changed what and when.
Know It Works

Success Signals

  • Support teams can open a dispute from a known transaction record without manually re-entering core details.
  • Evidence uploads and follow-up updates are traceable from one internal case or ticket view.
  • Merchants can see a clear current dispute status instead of ambiguous support notes.

Operational Guidance

Avoid These

Common Pitfalls

  • Starting a dispute flow without preserving the exact transaction reference and business reason that justified the case.
  • Treating uploaded evidence as temporary UI state instead of storing durable references and audit history.
  • Letting multiple operators overwrite dispute updates without an internal review or reconciliation trail.
Operate Better

Operational Notes

  • Model disputes internally as cases with timeline entries so API calls, uploaded files, and operator notes remain linked.
  • Add filters for open, resolved, and escalated disputes to reduce manual investigation work for support teams.
  • Use webhook or scheduled polling strategies to keep internal dispute views aligned with Paymish status changes.
Production tip: treat this collection as an end-to-end workflow, not just a list of endpoints. Your internal validation, logging, support process, and retry behavior matter as much as the request itself.

Language Implementation Notes

Python

Good for back-office tooling where upload handling, evidence validation, and scheduled reconciliation can live in one backend workflow.

Node.js

Useful for operational APIs, but keep file handling and dispute writes in trusted server code rather than browser-driven flows.

PHP

Wrap dispute create and update calls in one service layer so file validation, request formatting, and audit logging stay consistent.

cURL

Helpful for verifying multipart payload shape during debugging, especially when support teams are testing evidence submission issues.

Next: open any endpoint in this section to see the full request guide and copy-ready examples in all four languages.