อัปโหลดเอกสาร

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

อัปโหลดเอกสารหลักฐานเพื่อสนับสนุนการตอบกลับข้อพิพาทของคุณ เอกสารจะเสริมความแข็งแกร่งให้กับกรณีของคุณโดยให้หลักฐานแก่ผู้ออกบัตร

---

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

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

▼

`id`STRING(required)

ID ข้อพิพาท (path parameter) ข้อพิพาทต้องมีสถานะ "open"

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`file`FILE(required)

ไฟล์เอกสารหลักฐานที่จะอัปโหลด รูปแบบที่รับ: PNG, JPG, PDF

Example:"delivery-proof.pdf"

Constraints:ขนาดไฟล์สูงสุด: 10MB, รูปแบบ: PNG, JPG, PDF

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

▼

---

การตอบกลับ

200

อัปโหลดสำเร็จ

อัปโหลดเอกสารสำเร็จและแนบกับข้อพิพาทแล้ว

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

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

400

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

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

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

• ไฟล์หายไปหรือว่างเปล่า
• รูปแบบไฟล์ไม่ถูกต้อง (ไม่ใช่ PNG, JPG หรือ PDF)
• ค่า kind parameter ไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

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

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

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

413

ไฟล์ใหญ่เกินไป

ขนาดไฟล์เกินขีดจำกัด 10MB

วิธีแก้ไข:

• บีบอัดไฟล์เพื่อลดขนาด
• แบ่งเอกสารขนาดใหญ่เป็นหลายไฟล์
• ตรวจสอบให้ไฟล์มีขนาดต่ำกว่า 10MB

422

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

ไม่สามารถอัปโหลดเอกสารไปยังข้อพิพาทนี้ได้

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents \
  -X POST \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -F "file=@/path/to/delivery-proof.pdf" \
  -F "kind=proof_of_receipt"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = Omise::Document.create('dspt_test_5xuy4w91xqz7d1w9u0t', {
  file: File.open('/path/to/delivery-proof.pdf'),
  kind: 'proof_of_receipt'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

with open('/path/to/delivery-proof.pdf', 'rb') as file:
    document = omise.Document.create(
        'dspt_test_5xuy4w91xqz7d1w9u0t',
        file=file,
        kind='proof_of_receipt'
    )

Node.js

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

const document = await omise.documents.create('dspt_test_5xuy4w91xqz7d1w9u0t', {
  file: fs.createReadStream('/path/to/delivery-proof.pdf'),
  kind: 'proof_of_receipt'
});

PHP

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

$document = OmiseDocument::create('dspt_test_5xuy4w91xqz7d1w9u0t', [
    'file' => '@/path/to/delivery-proof.pdf',
    'kind' => 'proof_of_receipt'
]);

Java

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

File file = new File("/path/to/delivery-proof.pdf");

Document document = client.documents().create(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    file,
    "proof_of_receipt"
);

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

using (var fileStream = File.OpenRead("/path/to/delivery-proof.pdf"))
{
    var document = await client.Documents.Create(
        "dspt_test_5xuy4w91xqz7d1w9u0t",
        fileStream,
        "proof_of_receipt"
    );
}

Go

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

file, _ := os.Open("/path/to/delivery-proof.pdf")
defer file.Close()

document, _ := client.Document.Create("dspt_test_5xuy4w91xqz7d1w9u0t", file, "proof_of_receipt")

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	ไฟล์หรือพารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบไฟล์และ kind parameter
authentication_failure	API key ไม่ถูกต้อง	ยืนยันว่า secret key ของคุณถูกต้อง
not_found	ไม่พบข้อพิพาท	ตรวจสอบว่า ID ข้อพิพาทถูกต้อง
file_too_large	ไฟล์เกินขีดจำกัด 10MB	บีบอัดหรือแบ่งไฟล์
invalid_file_format	รูปแบบไฟล์ไม่รองรับ	ใช้ PNG, JPG หรือ PDF
dispute_not_open	ข้อพิพาทไม่ได้เปิดอยู่	สามารถเพิ่มเอกสารได้เฉพาะข้อพิพาทที่เปิดอยู่

ค่า Kind ของเอกสาร

Kind	คำอธิบาย	ตัวอย่างเอกสาร
cardholder_details	การยืนยันตัวตนลูกค้า	บัตรประชาชน หลักฐานที่อยู่สำหรับเรียกเก็บเงิน
details_of_purchase	รายละเอียดธุรกรรมและคำสั่งซื้อ	ใบแจ้งหนี้ การยืนยันคำสั่งซื้อ ใบเสร็จ
proof_of_receipt	การยืนยันการจัดส่งหรือบริการ	ข้อมูลการติดตาม ใบรับสินค้าที่มีลายเซ็น
proof_of_acceptance	การรับทราบจากลูกค้า	การติดต่อทางอีเมล การยอมรับเงื่อนไข

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

file(จำเป็น)

Choose FileSelect file...

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

▼

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