ค้นหา Charges

GEThttps://api.omise.co/search

ค้นหาและกรอง charges เพื่อค้นหาธุรกรรมตามคำอธิบาย, metadata, รายละเอียดบัตร, ข้อมูลลูกค้า และอื่นๆ Search API มีความสามารถในการค้นหาข้อความแบบเต็มที่มีประสิทธิภาพในทุก charges

---

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

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

▼

`scope`STRING(required)

ขอบเขตการค้นหา ต้องตั้งค่าเป็น "charge" เพื่อค้นหา charges

Example:"charge"

Values:charge

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

▼

`query`STRING(optional)

สตริงคำค้นหา ค้นหาในคำอธิบาย charge, metadata, รายละเอียดบัตร (4 หลักสุดท้าย, แบรนด์, ธนาคาร) และข้อมูลลูกค้า รองรับหลายคำ (AND logic) และการจับคู่บางส่วน

Example:"order 1234"

`filters`OBJECT(optional)

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

Example:{"status":"successful","currency":"thb","paid":true}

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

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

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

เนื้อหาการตอบกลับ:

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

400

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

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

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

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

401

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

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

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

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

422

scope ไม่ถูกต้อง

scope การค้นหาที่ระบุไม่ถูกต้อง

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

• พารามิเตอร์ scope ไม่ใช่ "charge"
• ค่า scope ไม่ถูกต้อง

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=charge" \
  -d "query=order 1234" \
  -d "filters[status]=successful" \
  -d "filters[currency]=thb"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Search.execute({
  scope: 'charge',
  query: 'order 1234',
  filters: {
    status: 'successful',
    currency: 'thb'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Search.execute(
    scope='charge',
    query='order 1234',
    filters={
        'status': 'successful',
        'currency': 'thb'
    }
)

Node.js

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

const results = await omise.search.execute({
  scope: 'charge',
  query: 'order 1234',
  filters: {
    status: 'successful',
    currency: 'thb'
  }
});

PHP

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

$results = OmiseSearch::execute([
    'scope' => 'charge',
    'query' => 'order 1234',
    'filters' => [
        'status' => 'successful',
        'currency' => 'thb'
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("status", "successful");
filters.put("currency", "thb");

SearchResult<Charge> results = client.search()
    .scope("charge")
    .query("order 1234")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Search.Execute(new SearchRequest
{
    Scope = "charge",
    Query = "order 1234",
    Filters = new Dictionary<string, object>
    {
        { "status", "successful" },
        { "currency", "thb" }
    }
});

Go

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

results, _ := client.Search(&operations.SearchCharges{
    Scope: "charge",
    Query: "order 1234",
    Filters: map[string]interface{}{
        "status":   "successful",
        "currency": "thb",
    },
})

---

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

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

รหัส	คำอธิบาย	การแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบว่า scope ถูกระบุและพารามิเตอร์ถูกต้อง
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_scope	scope การค้นหาไม่ถูกต้อง	ตรวจสอบว่า scope ตั้งค่าเป็น "charge"

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

ตัวกรอง	ประเภท	คำอธิบาย
status	string	สถานะ charge (pending, successful, failed, expired, reversed)
currency	string	รหัสสกุลเงิน (thb, jpy, sgd, myr, usd ฯลฯ)
amount	integer	จำนวนเงินที่แน่นอนในหน่วยสกุลเงินที่เล็กที่สุด
capture	boolean	charge ถูก capture หรือไม่ (true/false)
paid	boolean	charge ถูกชำระหรือไม่ (true/false)
created	object	ตัวกรองช่วงวันที่ (เช่น {gte: '2025-01-01', lte: '2025-01-31'})

---

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

▼

ลองใช้งาน

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

▼

scope(จำเป็น)

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

▼

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

▼

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