รายการคืนเงินทั้งหมด

GEThttps://api.omise.co/refunds

ดึงรายการการคืนเงินทั้งหมดแบบแบ่งหน้าจากทุก charge คืนค่าการคืนเงินที่เรียงตามวันที่สร้างพร้อมความสามารถในการกรอง

---

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

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

▼

`limit`INTEGER(optional)

จำนวนการคืนเงินที่จะคืนต่อหน้า

Example:20

Constraints:ขั้นต่ำ: 1, สูงสุด: 100

Default:20

`offset`INTEGER(optional)

จำนวนการคืนเงินที่จะข้ามสำหรับการแบ่งหน้า ใช้ร่วมกับ limit เพื่อนำทางผ่านหน้าต่างๆ

Example:0

Default:0

`order`STRING(optional)

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

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

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

▼

---

การตอบกลับ

200

ดึงรายการสำเร็จ

คืนค่าออบเจกต์รายการที่ประกอบด้วยอาร์เรย์ข้อมูลการคืนเงินและข้อมูลเมตาการแบ่งหน้า

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

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

แต่ละออบเจกต์การคืนเงินประกอบด้วย:

• object - ค่า "refund"
• id - ตัวระบุการคืนเงิน (rfnd_*)
• livemode - โหมด live หรือ test
• location - เส้นทาง API ไปยังออบเจกต์การคืนเงิน
• acquirer_reference_number - หมายเลขอ้างอิงที่ส่งไปยังเครือข่ายบัตร
• amount - จำนวนเงินที่คืนในหน่วยสกุลเงินที่เล็กที่สุด
• approval_code - หมายเลขอ้างอิงสำหรับธุรกรรมที่อนุมัติ
• capture - การอ้างอิงการบันทึก
• charge - รหัส charge ที่เกี่ยวข้อง (ขยายได้)
• currency - รหัสสกุลเงิน ISO 4217 สามตัวอักษร
• funding_amount - จำนวนเงินในสกุลเงินที่ชำระ
• funding_currency - รหัสสกุลเงินที่ชำระ
• merchant_name - ชื่อร้านค้าย่อย (Payfac เท่านั้น)
• merchant_uid - รหัสร้านค้าย่อย (Payfac เท่านั้น)
• metadata - ข้อมูลเมตาที่กำหนดเองที่แนบกับการคืนเงิน
• status - สถานะการคืนเงินปัจจุบัน (pending, successful, failed)
• terminal - สถานที่จุดขายเดิม
• transaction - รหัสธุรกรรมที่เกี่ยวข้อง (ขยายได้)
• voided - การคืนเงินถูกดำเนินการเป็นการยกเลิกหรือไม่
• created_at - เวลาที่สร้างการคืนเงิน (ISO 8601)

400

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

พารามิเตอร์ที่ให้มาไม่ถูกต้อง

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

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• Limit อยู่นอกช่วง (ต้องเป็น 1-100)
• ค่า offset ไม่ถูกต้อง

401

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

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

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

• ไม่มี Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key

404

ไม่พบ

ไม่พบทรัพยากรที่ร้องขอ

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

• URL endpoint API ไม่ถูกต้อง
• เส้นทาง URL ไม่ถูกต้อง

5xx

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

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

วิธีการจัดการ:

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

---

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

cURL

curl "https://api.omise.co/refunds?limit=20&offset=0" \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

refunds = Omise::Refund.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

refunds = omise.Refund.list(limit=20, offset=0)

Node.js

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

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

PHP

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

$refunds = OmiseRefund::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Refund> refunds = client.refunds().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var refunds = await client.Refunds.GetList(new ListOptions {
    Limit = 20,
    Offset = 0
});

Go

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

refunds, _ := client.ListRefunds(&operations.ListRefunds{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

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

รูปแบบการใช้งานทั่วไป

รูปแบบ	คำอธิบาย	ตัวอย่าง
การแบ่งหน้าพื้นฐาน	ดึงหน้าตามลำดับ	limit=20&offset=0 จากนั้น offset=20 ฯลฯ
ตัวกรองช่วงวันที่	กรองตามวันที่สร้าง	from=2025-01-01T00:00:00Z&to=2025-01-31T23:59:59Z
ล่าสุดก่อน	การคืนเงินล่าสุดก่อน	order=reverse_chronological

การคำนวณการแบ่งหน้า

ฟิลด์	การคำนวณ	การใช้งาน
หน้าถัดไป	offset + limit	ดึงชุดผลลัพธ์ถัดไป
หน้าก่อนหน้า	offset - limit (ต่ำสุด 0)	กลับไปหน้าก่อนหน้า
มีเพิ่มเติม	offset + limit < total	ตรวจสอบว่ามีหน้าเพิ่มเติมหรือไม่
หมายเลขหน้า	(offset / limit) + 1	หมายเลขหน้าปัจจุบัน

รหัสสถานะการคืนเงิน

สถานะ	คำอธิบาย
pending	กำลังดำเนินการคืนเงิน
successful	คืนเงินสำเร็จ
failed	คืนเงินล้มเหลว (พบได้น้อย)

---

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

▼

ลองใช้งาน

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

▼

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

▼

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