ค้นหาข้อพิพาท

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

ค้นหาข้อพิพาทตามเกณฑ์ต่างๆ รวมถึงสถานะ รหัสเหตุผล จำนวนเงิน สกุลเงิน และช่วงวันที่ Search API ให้ความสามารถในการกรองที่ทรงพลังเพื่อค้นหาข้อพิพาทเฉพาะในบัญชีของคุณ

---

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

แนะนำ - 2 ฟิลด์พารามิเตอร์ที่แนะนำ

▼

`query`STRING(optional)

สตริงคำค้นหา ค้นหาข้าม ID ข้อพิพาท, ID การเรียกเก็บเงิน, ข้อความเหตุผล และ metadata รองรับหลายคำ (ตรรกะ AND) และการจับคู่บางส่วน

Example:"fraudulent chrg_test_123"

`filters`OBJECT(optional)

เกณฑ์ตัวกรองเพื่อจำกัดผลการค้นหา ตัวกรองทั่วไปรวมถึง status, reason_code, currency, amount และช่วงวันที่ที่สร้าง

Example:{"status":"open","reason_code":"fraudulent","currency":"thb"}

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

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

การค้นหาเสร็จสมบูรณ์ ส่งคืนอ็อบเจกต์ผลการค้นหาพร้อมข้อพิพาทที่ตรงกันในอาร์เรย์ data

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

• data - อาร์เรย์ของอ็อบเจกต์ข้อพิพาทที่ตรงกับเกณฑ์การค้นหา
• total - จำนวนผลลัพธ์ทั้งหมดที่ตรงกับการค้นหา
• total_pages - จำนวนหน้าที่มี
• page - หมายเลขหน้าปัจจุบัน
• per_page - จำนวนผลลัพธ์ต่อหน้า
• order - ลำดับการเรียงที่ใช้ (chronological หรือ reverse_chronological)

400

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

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

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

• หมายเลขหน้าไม่ถูกต้อง (ต่ำกว่า 1)
• ค่า per_page ไม่ถูกต้อง (มากกว่า 100 หรือต่ำกว่า 1)
• อ็อบเจกต์ filters รูปแบบผิด
• ชื่อฟิลด์ตัวกรองไม่ถูกต้อง

401

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

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

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/disputes/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=fraudulent" \
  -d "filters[status]=open" \
  -d "filters[reason_code]=fraudulent"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Dispute.search({
  query: 'fraudulent',
  filters: {
    status: 'open',
    reason_code: 'fraudulent'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Dispute.search(
    query='fraudulent',
    filters={
        'status': 'open',
        'reason_code': 'fraudulent'
    }
)

Node.js

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

const results = await omise.disputes.search({
  query: 'fraudulent',
  filters: {
    status: 'open',
    reason_code: 'fraudulent'
  }
});

PHP

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

$results = OmiseDispute::search([
    'query' => 'fraudulent',
    'filters' => [
        'status' => 'open',
        'reason_code' => 'fraudulent'
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("status", "open");
filters.put("reason_code", "fraudulent");

SearchResult<Dispute> results = client.disputes().search()
    .query("fraudulent")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Disputes.Search(new SearchRequest
{
    Query = "fraudulent",
    Filters = new Dictionary<string, object>
    {
        { "status", "open" },
        { "reason_code", "fraudulent" }
    }
});

Go

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

results, _ := client.SearchDisputes(&operations.SearchDisputes{
    Query: "fraudulent",
    Filters: map[string]interface{}{
        "status":      "open",
        "reason_code": "fraudulent",
    },
})

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบว่าตัวกรองถูกต้องและพารามิเตอร์ถูกต้อง
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_filter	ฟิลด์ตัวกรองไม่ถูกต้อง	ใช้ฟิลด์ตัวกรองที่ถูกต้อง (status, reason_code, currency, amount, created)

ตัวเลือกตัวกรองการค้นหา

ตัวกรอง	ประเภท	คำอธิบาย
status	string	สถานะข้อพิพาท (open, pending, won, lost)
reason_code	string	รหัสเหตุผล (fraudulent, unrecognized, duplicate ฯลฯ)
currency	string	รหัสสกุลเงิน (thb, jpy, sgd, myr, usd ฯลฯ)
amount	integer	จำนวนเงินที่แน่นอนในหน่วยสกุลเงินที่เล็กที่สุด
created	object	ตัวกรองช่วงวันที่ (เช่น {gte: '2025-01-01', lte: '2025-01-31'})

รหัสเหตุผล

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

---

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

▼

ลองใช้งาน

แนะนำ - 2 ฟิลด์

▼

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

▼

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