ค้นหาการโอน

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

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

---

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

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

▼

`query`STRING(optional)

สตริงคำค้นหา ค้นหาใน metadata การโอน ชื่อผู้รับ รายละเอียดบัญชีธนาคาร และข้อมูลการโอนอื่นๆ รองรับหลายคำ (ตรรกะ AND) และการจับคู่บางส่วน

Example:"payout merchant"

`filters`OBJECT(optional)

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

Example:{"sent":true,"paid":true}

ทางเลือก - 3 ฟิลด์พารามิเตอร์การแบ่งหน้า

▼

---

การตอบกลับ

200

การค้นหาสำเร็จ

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

รวมถึง:

• object - เป็น "search" เสมอ
• data - อาร์เรย์ของอ็อบเจกต์การโอนที่ตรงกับเกณฑ์การค้นหา
• total - จำนวนผลลัพธ์ทั้งหมดที่ตรงกับการค้นหา
• total_pages - จำนวนหน้าที่มี
• page - หมายเลขหน้าปัจจุบัน
• per_page - จำนวนผลลัพธ์ต่อหน้า
• order - ลำดับการเรียงที่ใช้

400

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

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

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

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

401

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

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

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

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

404

ไม่พบ

ไม่พบ endpoint การค้นหาหรือฟีเจอร์การค้นหาไม่ได้เปิดใช้งาน

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

• ฟีเจอร์การค้นหาไม่ได้เปิดใช้งานสำหรับบัญชีของคุณ
• URL endpoint ไม่ถูกต้อง

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/transfers/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=payout merchant" \
  -d "filters[sent]=true" \
  -d "filters[paid]=true"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Transfer.search({
  query: 'payout merchant',
  filters: {
    sent: true,
    paid: true
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Transfer.search(
    query='payout merchant',
    filters={
        'sent': True,
        'paid': True
    }
)

Node.js

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

const results = await omise.transfers.search({
  query: 'payout merchant',
  filters: {
    sent: true,
    paid: true
  }
});

PHP

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

$results = OmiseTransfer::search([
    'query' => 'payout merchant',
    'filters' => [
        'sent' => true,
        'paid' => true
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("sent", true);
filters.put("paid", true);

SearchResult<Transfer> results = client.transfers().search()
    .query("payout merchant")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Transfers.Search(new SearchRequest
{
    Query = "payout merchant",
    Filters = new Dictionary<string, object>
    {
        { "sent", true },
        { "paid", true }
    }
});

Go

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

results, _ := client.Transfers().Search(&operations.SearchTransfers{
    Query: "payout merchant",
    Filters: map[string]interface{}{
        "sent": true,
        "paid": true,
    },
})

---

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

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

รหัส	คำอธิบาย	การแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบว่าพารามิเตอร์ถูกต้อง
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง

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

ตัวกรอง	ประเภท	คำอธิบาย
amount	integer	จำนวนเงินโอนในหน่วยเล็กที่สุดของสกุลเงิน
currency	string	รหัสสกุลเงิน (thb, jpy, sgd, myr, usd ฯลฯ)
recipient	string	รหัสผู้รับที่จะกรอง
sent	boolean	การโอนถูกส่งหรือไม่ (true/false)
paid	boolean	การโอนถูกจ่ายหรือไม่ (true/false)
created	object	ตัวกรองช่วงวันที่ (เช่น {gte: '2025-01-01', lte: '2025-01-31'})
failure_code	string	กรองตามรหัสความล้มเหลวที่เฉพาะ

---

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

▼

ลองใช้งาน

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

▼

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

▼

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