ดึงข้อมูลเอกสาร

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

ดึงข้อมูลเอกสารเฉพาะจากข้อพิพาท endpoint นี้ส่งคืนข้อมูลโดยละเอียดเกี่ยวกับไฟล์หลักฐาน รวมถึง URL สำหรับดาวน์โหลดเพื่อเข้าถึงไฟล์

---

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

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

▼

`id`STRING(required)

ID ข้อพิพาท (path parameter)

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`document_id`STRING(required)

ID เอกสารที่จะดึงข้อมูล (path parameter) รูปแบบ: docu_test_ หรือ docu_live_ ตามด้วยสตริงตัวอักษรและตัวเลข

Example:"docu_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

ส่งคืน document object พร้อมรายละเอียดครบถ้วนรวมถึง URL สำหรับดาวน์โหลด

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

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

400

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

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

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

• รูปแบบ ID ข้อพิพาทไม่ถูกต้อง
• รูปแบบ ID เอกสารไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

ไม่พบข้อพิพาทหรือเอกสาร

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents/docu_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = Omise::Document.retrieve(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = omise.Document.retrieve(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

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

const document = await omise.documents.retrieve(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
);

PHP

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

$document = OmiseDocument::retrieve(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
);

Java

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

Document document = client.documents().retrieve(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var document = await client.Documents.Retrieve(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

Go

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

document, _ := client.Document.Retrieve(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t",
)

---

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

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

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

หมายเหตุเกี่ยวกับ URL ดาวน์โหลด

• download_uri เป็น URL ที่มีลายเซ็นชั่วคราว
• URL หมดอายุหลังจากช่วงเวลาหนึ่ง (โดยทั่วไป 15 นาทีถึง 1 ชั่วโมง)
• ขอดึงข้อมูลเอกสารใหม่เพื่อรับ URL ดาวน์โหลดใหม่หากหมดอายุ

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

document_id(จำเป็น)

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