แสดงรายการเอกสาร

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

แสดงรายการเอกสารทั้งหมดที่แนบกับข้อพิพาท endpoint นี้ดึงข้อมูลไฟล์หลักฐานทั้งหมดที่อัปโหลดเพื่อสนับสนุนการตอบกลับข้อพิพาทของคุณ

---

พารามิเตอร์คำขอ

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`id`STRING(required)

ID ข้อพิพาทที่จะแสดงรายการเอกสาร (path parameter)

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

เพิ่มเติม - 3 ฟิลด์พารามิเตอร์เพิ่มเติม

▼

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

ส่งคืน list object ที่มี document objects ที่แนบกับข้อพิพาท

การตอบกลับประกอบด้วย:

• object - เป็น "list" เสมอ
• data - อาร์เรย์ของ document objects
• limit - จำนวนผลลัพธ์ต่อหน้า
• offset - จำนวนผลลัพธ์ที่ข้าม
• total - จำนวนเอกสารทั้งหมดสำหรับข้อพิพาทนี้

แต่ละ document object ประกอบด้วย:

• object - เป็น "document" เสมอ
• id - ID เอกสาร (docu_*)
• livemode - ระบุว่าเป็นเอกสารโหมด live หรือไม่
• location - เส้นทาง API สำหรับดึงข้อมูลเอกสาร
• deleted - ระบุว่าเอกสารถูกลบแล้วหรือไม่
• filename - ชื่อไฟล์ต้นฉบับ
• kind - ประเภทเอกสาร (ถ้าระบุ)
• download_uri - URL สำหรับดาวน์โหลดเอกสาร
• created_at - เวลาที่อัปโหลด

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความผิดพลาดสำหรับรายละเอียด

สาเหตุทั่วไป:

• รูปแบบ ID ข้อพิพาทไม่ถูกต้อง
• Limit เกินค่าสูงสุด (100)
• พารามิเตอร์ order ไม่ถูกต้อง
• ค่า offset หรือ limit เป็นลบ

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือหายไป

สาเหตุทั่วไป:

• ไม่มี Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบข้อพิพาท

สาเหตุทั่วไป:

• ID ข้อพิพาทไม่ถูกต้อง
• ข้อพิพาทเป็นของบัญชีอื่น
• พิมพ์ ID ผิดหรือรูปแบบไม่ถูกต้อง

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ ซึ่งเกิดขึ้นได้ยากแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ลองส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

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::Document.list('dspt_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

documents = omise.Document.list(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

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

Java

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

ScopedList<Document> documents = client.documents().list("dspt_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .execute();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบค่าพารามิเตอร์
authentication_failure	API key ไม่ถูกต้อง	ยืนยันว่า secret key ของคุณถูกต้อง
not_found	ไม่พบข้อพิพาท	ตรวจสอบว่า ID ข้อพิพาทถูกต้อง

---

🔑ข้อมูลยืนยันตัวตน API

▼

ลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)

เพิ่มเติม - 3 ฟิลด์

▼

IP ของคุณ: ...กำลังโหลด...