ลบเอกสาร

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

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

---

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

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

▼

`id`STRING(required)

ID ข้อพิพาท (path parameter) ข้อพิพาทต้องมีสถานะ "open" เพื่อให้สามารถลบเอกสารได้

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`document_id`STRING(required)

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

Example:"docu_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

ลบเอกสารแล้ว

ลบเอกสารสำเร็จ ส่งคืน document object ที่ถูกลบพร้อมค่า deleted เป็น true

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

• object - เป็น "document" เสมอ
• id - ID เอกสาร (docu_*)
• livemode - ระบุว่าเป็นเอกสารโหมด live หรือไม่
• location - เส้นทาง API ไปยังเอกสาร
• deleted - ตั้งเป็น true แสดงว่าลบสำเร็จ

หลังจากลบ:

• เอกสารจะถูกลบออกจากข้อพิพาทอย่างถาวร
• URL ดาวน์โหลดจะใช้งานไม่ได้อีกต่อไป
• การดำเนินการไม่สามารถยกเลิกได้ - ต้องอัปโหลดใหม่หากต้องการ

400

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

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

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

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

401

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

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

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

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

404

ไม่พบ

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

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

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

422

ไม่สามารถประมวลผลได้

ไม่สามารถลบเอกสารได้

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

• สถานะข้อพิพาทไม่ใช่ "open" (อยู่ในสถานะ pending, won หรือ lost แล้ว)
• ข้อพิพาทปิดแล้ว - ไม่สามารถแก้ไขเอกสารได้
• เอกสารถูกส่งไปยังธนาคารเพื่อตรวจสอบแล้ว

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

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

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

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

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

หมายเหตุสำคัญ

หมายเหตุ	คำอธิบาย
เวลา	สามารถลบเอกสารได้เฉพาะเมื่อข้อพิพาทมีสถานะ "open"
ความถาวร	การลบเป็นการถาวรและไม่สามารถยกเลิกได้
อัปโหลดใหม่	หากต้องการแทนที่เอกสาร ให้ลบก่อนแล้วอัปโหลดเวอร์ชันใหม่
ข้อพิพาท pending	เมื่อข้อพิพาทอยู่ในสถานะ pending จะไม่สามารถแก้ไขเอกสารได้

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

document_id(จำเป็น)

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