SIsilverflow
Disputes

List Dispute Documents

This operation returns a (paged) list of (active) Documents (metadata) for a Dispute.

Requires disputes:ListDocuments permission.

get/disputes/{disputeKey}/documents

Request

Path parameters

disputeKeystring required

Uniquely identifies a Dispute.

Example:dsp-1JRadf2ffdfrdPMf2XrS2

Uniquely identifies a Dispute.

Query parameters

sortOrder'asc' | 'desc'

The sort order (ascending or descending)

limitinteger

The number of items to return

offsetTokenstring
Example:LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc

The offset token. This token is returned in the response of previous request.

owner'issuer' | 'acquirer' | 'merchant' | 'card-network'

The owner of a Dispute Document

status'pending' | 'active' | 'archived'

The status of a Dispute Document

Response

A (paged) list of Documents (metadata)

moreItemsboolean
offsetTokenstring

Example response

{
  "offsetToken": "LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc",
  "documents": [
    {
      "key": "dok-1UF2NafdfrdPMf2XrS2",
      "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
      "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
      "disputeKey": "dsp-1JRadf2ffdfrdPMf2XrS2",
      "version": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.