Get Shop Dispute By Id

Retrieves a dispute by Id

Path

GET /disputes/{disputeId}

Request Parameters

disputeId

required

string <uuid>

Unique identifier for the dispute, it should be a GUID

Responses

id

string

The unique identifier of the dispute in uuid format. This value is used for all API operations on the dispute.

object

The reason a customer has disputed an invoice.

shortCode

string

The short code, e.g. R1, R2, etc.

object

The invoice being disputed by the customer.

invoiceNumber

string

The identifier for the invoice.

object

The merchant that has sold the product or service to the customer.

shopId

string

The string identifier of the shop exposed to merchants

ticketNumber

string

The human-friendly ticket number for the dispute, e.g. D-0000-0001.

array

Files that the customer or merchant have associated directly with the dispute as evidence.

id

string

The unique identifier of the attachment.

fileName

string

The name for the attachment that has been generated for internal use.

originalFileName

string

The name that the attachment was originally uploaded with.

thumbnailUrl

string

If a thumbnail has been created, this will be the URL to it with a time-limited access token.

createdAt

string
yyyy-MM-ddTHH:mm:ss.fffffffzzz

When it was created.

size

integer

The number of bytes.

mimeType

string

The type of file content, e.g. image/jpeg.

originalFileUrl

string

The direct link to download the file.

malwareDetected

boolean

Unpopulated if the attachment has not been scanned yet. True if malware was detected, false if not.

createdAt

string
yyyy-MM-ddTHH:mm:ss.fffffffzzz

The time the dispute was created.

object

The lifecycle stage of a dispute.

id

integer

One of the 7 possible dispute stages.

object

Represents a decision made by Riverty at one of the decision stages.

name

string

The outcome of the dispute, e.g. Write-off

description

string

Human-readable description of the customer's issue with the invoice.

showInMerchantUi

boolean

Whether this dispute is hidden in the merchant UI
204 No content
400 Invalid request
type

string

title

string

status

integer

detail

string

instance

string

type

string

title

string

status

integer

detail

string

instance

string
statusCode

integer

targetSite

object

message

string

data

object

innerException

object

helpLink

object

source

object

hResult

integer

stackTrace

object

200 Successful Request

Request Example

{}

Response Example

    
        {
 "id": "50fc9c37-cbcb-49f5-d72b-08dd939e9062",
 "stage": {
  "id": 6
 },
 "invoice": {
  "client": {
   "shopId": "AFS000003926"
  },
  "invoiceNumber": "802693330"
 },
 "decision": {
  "name": "Write-off"
 },
 "createdAt": "2025-05-15T10:52:19.2984008Z",
 "reasonCode": {
  "shortCode": "R1"
 },
 "attachments": [
  {
   "id": "d3cd4950-9541-4867-063f-08ddb25bc8cc",
   "size": 1784046,
   "mimeType": "image/jpeg",
   "createdAt": "2025-06-24T08:17:00Z",
   "originalFileName": "Group_of_cats.jpg"
  }
 ],
 "ticketNumber": "D-0001-4112",
 "showInMerchantUi": true
}