Retrieve Dispute

Retrieve the details of an existing dispute.

GEThttps://api.uprails.com/disputes/:dispute_id

Retrieves a dispute by its ID. Returns the dispute object with current status, reason, evidence deadline, and any submitted evidence.

Path Parameters

Parameter	Type	Description
`dispute_id`	string	Required. The ID of the dispute to retrieve.

Request Example

curl https://api.uprails.com/disputes/dis_1234567890abcdef \
  -H "api-key: snd_YOUR_API_KEY"

Response

200OK

{
  "dispute_id": "dis_1234567890abcdef",
  "payment_id": "pay_abcdef1234567890",
  "merchant_id": "mer_xyz789",
  "status": "needs_response",
  "amount": 1000,
  "currency": "USD",
  "reason": "fraudulent",
  "evidence_due_by": "2024-01-25T23:59:59Z",
  "evidence": null,
  "metadata": {},
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-15T10:00:00Z"
}

Response Fields

Field	Type	Description
`dispute_id`	string	Unique identifier for the dispute
`payment_id`	string	ID of the disputed payment
`status`	string	Current status of the dispute
`amount`	integer	Disputed amount in smallest currency unit
`reason`	string	Reason code for the dispute
`evidence_due_by`	string	Deadline for submitting evidence (ISO 8601)
`evidence`	object	Submitted evidence (null if not submitted)