Skip to Main Content
Riverty Docs
riverty logo Docs

Get All Shop Disputes

Get all disputes for such client. This endpoint returns a list of disputes that the customers
submitted on products owned by a client.

This endpoint supports filtering out results based on dispute status and also all disputes
for a specific time period.

Path

GET /disputes

Request Parameters

disputeType
array
Optional Dispute or DC (debt collection). When omitted, standard disputes are returned; DC returns only disputes from the DebtCollection channel.
sortBy
string
Enum:

CreatedAt

StatusId

ReasonCodeId

TicketNumber

Deadline

UpdatedByConsumerOrRivertyAt

AgentAssignee

DisputeAmount

Optional property used to sort the results. Defaults to `CreatedAt`.
sortMethod
string
Enum:

Desc

Asc

Optional sort direction. Defaults to descending.
query
string
Optional search term used to find disputes by invoice number or ticket number.
startDate
string <date-time>
Optional earliest dispute creation date to include.
endDate
string <date-time>
Optional latest dispute creation date to include.
pageSize
integer <int32> default: 20
Optional number of items per page. Defaults to 20.
pageNumber
integer <int32> default: 1
Optional page number. Defaults to 1.
showInMerchantUi
boolean
Optional filter indicating whether disputes are visible in the merchant UI. If null, disputes are returned regardless of merchant UI visibility.
clientId
integer <int32>
Optional client identifier. Applies only to Horizon-authenticated requests. When provided, results are restricted to the specified client. When omitted, disputes across all clients are returned.

Responses

  • array
    The page of results the query returned.
    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.
    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.
    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.
    object
    total
    integer
    The count of all items that would be returned if no pagination was applied.
    pageSize
    integer
    The number of items to return in each page of results.
  • 400 The request is invalid.
  • 403 The caller is not authorized to access the disputes.
200 Successful Request

Request Example

    
        {
 "query": "D-0001-4112",
 "sortBy": "TicketNumber",
 "endDate": "2025-06-01",
 "pageSize": 20,
 "startDate": "2025-05-01",
 "pageNumber": 1,
 "sortMethod": "Asc",
 "showInMerchantUi": true
}
    

Response Example

    
        {
 "paging": {
  "total": 1,
  "pageSize": 20
 },
 "results": [
  {
   "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
  }
 ]
}