ดึงข้อมูล Dispute

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

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

---

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

▼

---

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

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

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

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

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

401

ไม่ได้รับการยืนยันตัวตน

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

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

• ขาดหายไป Authorization header
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบ Dispute

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

• dispute ID ไม่ถูกต้อง
• dispute อยู่ในบัญชีอื่น
• ID พิมพ์ผิดหรือรูปแบบไม่ถูกต้อง

---

Code samples

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")

---

Error and result codes

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

Code	Description	Resolution
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบ Dispute	ตรวจสอบว่า dispute ID ถูกต้อง
invalid_dispute_id	รูปแบบ Dispute ID ไม่ถูกต้อง	ใช้รูปแบบ dspt_ ที่ถูกต้อง

ค่าสถานะ Dispute

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

รหัสเหตุผล

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

---

Try it out

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

▼

id(จำเป็น)