แสดงรายการ Recipient ทั้งหมด

GEThttps://api.omise.co/recipients

ดึงรายการ Recipient ทั้งหมดที่อยู่ในบัญชีของคุณแบบแบ่งหน้า ผลลัพธ์สามารถกรองตามช่วงวันที่และเรียงลำดับตามเวลา

---

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

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

▼

`limit`INTEGER(optional)

จำนวนรายการที่จะส่งกลับต่อหน้า

Example:20

Constraints:ต่ำสุด: 1, สูงสุด: 100

Default:20

`offset`INTEGER(optional)

จำนวนรายการที่จะข้ามก่อนส่งกลับผลลัพธ์ ใช้สำหรับการแบ่งหน้า

Example:0

Default:0

`order`STRING(optional)

ลำดับการเรียงผลลัพธ์ตามวันที่สร้าง

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`from`STRING(optional)

กรอง Recipient ที่สร้างตั้งแต่วันที่/เวลา UTC นี้ รูปแบบ ISO 8601

Example:"2025-01-01T00:00:00Z"

`to`STRING(optional)

กรอง Recipient ที่สร้างก่อนวันที่/เวลา UTC นี้ รูปแบบ ISO 8601

Example:"2025-12-31T23:59:59Z"

---

การตอบกลับ

200

สำเร็จ

ดึงรายการ Recipient สำเร็จ ส่งกลับรายการแบบแบ่งหน้าพร้อมข้อมูลเมตา

โครงสร้างการตอบกลับ:

• object - เป็น "list" เสมอ
• data - อาร์เรย์ของออบเจกต์ Recipient
• total - จำนวน Recipient ทั้งหมดที่ตรงกับตัวกรอง
• limit - จำนวนรายการต่อหน้า
• offset - ออฟเซ็ตการแบ่งหน้าปัจจุบัน
• from, to - ตัวกรองวันที่ที่ใช้

แต่ละออบเจกต์ Recipient ใน data ประกอบด้วย:

• object - ค่า "recipient"
• id - ตัวระบุ Recipient (recp_*)
• livemode - โหมดไลฟ์หรือโหมดทดสอบ
• location - พาธ API ไปยังออบเจกต์ Recipient
• activated_at - timestamp การเปิดใช้งาน (ISO 8601)
• active - Recipient เปิดใช้งานอยู่หรือไม่
• bank_account - ออบเจกต์บัญชีธนาคารปลายทาง
• created_at - timestamp การสร้าง (ISO 8601)
• default - Recipient เป็นค่าเริ่มต้นของบัญชีหรือไม่
• deleted - Recipient ถูกลบหรือไม่
• description - คำอธิบาย Recipient
• email - อีเมล Recipient
• failure_code - รหัสเหตุผลความล้มเหลว (name_mismatch, account_not_found, bank_not_found)
• metadata - metadata ที่กำหนดเอง
• name - ชื่อ Recipient
• schedule - ตารางการโอนเงิน (ขยายได้)
• tax_id - เลขประจำตัวผู้เสียภาษีของ Recipient
• type - ประเภท Recipient (individual, corporation)
• verified - Recipient ได้รับการยืนยันหรือไม่
• verified_at - timestamp การยืนยัน (ISO 8601)

400

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

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

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

• รูปแบบวันที่ไม่ถูกต้องสำหรับ from หรือ to
• ค่า order ไม่ถูกต้อง
• offset หรือ limit เป็นลบ
• limit เกินค่าสูงสุด (100)

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipients = Omise::Recipient.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipients = omise.Recipient.retrieve(limit=20, offset=0)

Node.js

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

const recipients = await omise.recipients.list({
  limit: 20,
  offset: 0
});

PHP

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

$recipients = OmiseRecipient::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Recipient> recipients = client.recipients()
    .list(new ScopedList.Options()
        .limit(20)
        .offset(0));

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var recipients = await client.Recipients.List(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

recipients, _ := client.Recipients().List(&operations.ListRecipients{
    Limit:  20,
    Offset: 0,
})

---

การแบ่งหน้า

ใช้พารามิเตอร์ limit และ offset เพื่อแบ่งหน้าผลลัพธ์:

# หน้าแรก (0-19)
curl https://api.omise.co/recipients?limit=20&offset=0 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# หน้าที่สอง (20-39)
curl https://api.omise.co/recipients?limit=20&offset=20 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

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

▼

ลองใช้งาน

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

▼

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