ดึงข้อมูลข้อพิพาท

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

ดึงข้อมูลโดยละเอียดเกี่ยวกับข้อพิพาทเฉพาะรวมถึงสถานะ รหัสเหตุผล เอกสารหลักฐาน และการเรียกเก็บเงินที่เกี่ยวข้อง

---

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

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

▼

`id`STRING(required)

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

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

ส่งคืนอ็อบเจกต์ข้อพิพาทพร้อมรายละเอียดครบถ้วนรวมถึงสถานะ เอกสาร และข้อมูลธุรกรรม

การตอบกลับรวมถึง:

• id - ID ข้อพิพาท
• status - สถานะปัจจุบัน (open, pending, won, lost)
• amount - จำนวนเงินที่พิพาทในหน่วยสกุลเงินที่เล็กที่สุด
• currency - รหัสสกุลเงิน ISO สามตัวอักษร
• reason_code - เหตุผลของข้อพิพาท (fraudulent, unrecognized ฯลฯ)
• reason_message - คำอธิบายเหตุผลที่อ่านได้
• charge - ID การเรียกเก็บเงินที่เกี่ยวข้อง
• message - ข้อความตอบกลับของคุณ (ถ้าให้ไว้)
• documents - รายการเอกสารหลักฐานที่อัปโหลด
• created_at - เมื่อข้อพิพาทถูกสร้าง
• closed_at - เมื่อข้อพิพาทปิด (null ถ้ายังเปิด/รอดำเนินการ)

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 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

dispute = Omise::Dispute.retrieve('dspt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

dispute = omise.Dispute.retrieve('dspt_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const dispute = await omise.disputes.retrieve('dspt_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$dispute = OmiseDispute::retrieve('dspt_test_5xuy4w91xqz7d1w9u0t');

Java

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

Dispute dispute = client.disputes().get("dspt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var dispute = await client.Disputes.Get("dspt_test_5xuy4w91xqz7d1w9u0t");

Go

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

dispute, _ := client.GetDispute("dspt_test_5xuy4w91xqz7d1w9u0t")

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
not_found	ไม่พบข้อพิพาท	ตรวจสอบว่า ID ข้อพิพาทถูกต้อง
invalid_dispute_id	รูปแบบ ID ข้อพิพาทไม่ถูกต้อง	ใช้รูปแบบ dspt_ ที่ถูกต้อง

ค่าสถานะข้อพิพาท

สถานะ	คำอธิบาย
open	เริ่มต้นใหม่ รอการตอบกลับจากคุณ
pending	อยู่ระหว่างการตรวจสอบพร้อมการตอบกลับจากร้านค้า
won	ร้านค้าชนะข้อพิพาท
lost	ร้านค้าแพ้ข้อพิพาท

รหัสเหตุผล

รหัส	คำอธิบาย
fraudulent	ลูกค้าอ้างว่าธุรกรรมไม่ได้รับอนุญาต
unrecognized	ลูกค้าไม่รู้จักการเรียกเก็บเงิน
duplicate	ลูกค้าอ้างว่าถูกเรียกเก็บซ้ำ
goods_or_services_not_provided	ไม่ได้รับสินค้า/บริการ
not_as_described	สินค้าแตกต่างจากคำอธิบายอย่างมาก
credit_not_processed	สัญญาคืนเงินแต่ไม่ได้รับ
general	เหตุผลอื่นๆ

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

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