List Dispute Documents

GEThttps://api.omise.co/disputes/:id/documents

List all documents attached to a dispute. This endpoint retrieves all evidence files that have been uploaded to support your dispute response.

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Dispute ID to list documents for (path parameter).

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

Additional - 3 fieldsAdditional Parameters

▼

---

Responses

200

Successful retrieval

Returns a list object containing document objects attached to the dispute.

Response includes:

• object - Always "list"
• data - Array of document objects
• limit - Number of results per page
• offset - Number of results skipped
• total - Total number of documents for this dispute

Each document object contains:

• object - Always "document"
• id - Document ID (docu_*)
• livemode - Whether this is a live mode document
• location - API path to retrieve the document
• deleted - Whether the document has been deleted
• filename - Original filename
• kind - Document type (if specified)
• download_uri - URL to download the document
• created_at - Upload timestamp

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid dispute ID format
• Limit exceeds maximum (100)
• Invalid order parameter
• Negative offset or limit values

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Dispute not found.

Common causes:

• Incorrect dispute ID
• Dispute belongs to different account
• ID typo or formatting error

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "limit=20" \
  -d "offset=0"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

documents = Omise::Dispute.list_documents('dspt_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

documents = omise.Dispute.list_documents(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const documents = await omise.disputes.listDocuments('dspt_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$documents = OmiseDispute::listDocuments('dspt_test_5xuy4w91xqz7d1w9u0t', [
    'limit' => 20,
    'offset' => 0
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Document> documents = client.disputes().listDocuments("dspt_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var documents = await client.Disputes.ListDocuments("dspt_test_5xuy4w91xqz7d1w9u0t", new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

documents, _ := client.ListDisputeDocuments("dspt_test_5xuy4w91xqz7d1w9u0t", &operations.ListDocuments{
    Limit:  20,
    Offset: 0,
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Invalid parameters	Check parameter values
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Dispute not found	Check dispute ID is correct

Document Kind Values

Kind	Description	Example Documents
cardholder_details	Customer identity verification	Customer ID, billing address proof
details_of_purchase	Transaction and order details	Invoice, order confirmation, receipt
proof_of_receipt	Delivery or service confirmation	Tracking info, signed delivery receipt
proof_of_acceptance	Customer acknowledgment	Email correspondence, terms acceptance

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

id(Required)

Additional - 3 fields

▼

Your IP: ...Loading...