รายการ charge events

GEThttps://api.omise.co/charges/:id/events

ดึงรายการ events แบบแบ่งหน้าสำหรับ charge เฉพาะ ใช้ endpoint นี้เพื่อตรวจสอบกิจกรรม charge ดีบัก webhooks และติดตาม events ทั้งหมดที่เกี่ยวข้องกับ charge นั้นๆ รวมถึงการสร้าง การเสร็จสิ้น การคืนเงิน และข้อพิพาท

---

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

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

▼

`id`STRING(required)

Charge ID ที่จะดึง events Charge IDs เริ่มต้นด้วย chrg_ ตามด้วย test_ สำหรับโหมดทดสอบ

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

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

▼

`limit`INTEGER(optional)

จำนวน events ที่จะส่งคืนต่อหน้า

Example:20

Constraints:ต่ำสุด: 1, สูงสุด: 100, ค่าเริ่มต้น: 20

Default:20

`offset`INTEGER(optional)

จำนวน events ที่จะข้ามสำหรับการแบ่งหน้า ใช้ร่วมกับ limit เพื่อแบ่งหน้าผ่านชุดผลลัพธ์ขนาดใหญ่

Example:0

Default:0

`order`STRING(optional)

ลำดับการเรียงผลลัพธ์

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

ทางเลือก - 2 ฟิลด์พารามิเตอร์ตัวกรอง

▼

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

ส่งคืนรายการอ็อบเจกต์ event แบบแบ่งหน้าสำหรับ charge ที่ระบุ แต่ละ event มีข้อมูลที่สมบูรณ์เกี่ยวกับการดำเนินการที่เกิดขึ้น

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

• data - อาร์เรย์ของอ็อบเจกต์ event ที่เกี่ยวข้องกับ charge
• limit - จำนวนผลลัพธ์ต่อหน้า
• offset - จำนวนผลลัพธ์ที่ข้าม
• total - จำนวน events ทั้งหมดสำหรับ charge
• order - ลำดับการเรียงที่ใช้

400

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

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

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

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• Limit เกินค่าสูงสุด (100)
• พารามิเตอร์ order ไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

ไม่พบ Charge หรือไม่มีอยู่

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

• Charge ID ไม่ถูกต้อง
• Charge ID จากบัญชีอื่น
• ใช้ keys โหมด test และ live ผสมกัน

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/charges/chrg_test_5xuy4w91xqz7d1w9u0t/events \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = Omise::Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
events = charge.events({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

charge = omise.Charge.retrieve('chrg_test_5xuy4w91xqz7d1w9u0t')
events = charge.events(
    limit=20,
    offset=0
)

Node.js

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

const events = await omise.charges.listEvents('chrg_test_5xuy4w91xqz7d1w9u0t', {
  limit: 20,
  offset: 0
});

PHP

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

$charge = OmiseCharge::retrieve('chrg_test_5xuy4w91xqz7d1w9u0t');
$events = $charge->events(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Event> events = client.charges()
    .listEvents("chrg_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var events = await client.Charges.ListEvents("chrg_test_5xuy4w91xqz7d1w9u0t", new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

events, _ := client.ListChargeEvents("chrg_test_5xuy4w91xqz7d1w9u0t", &operations.ListEvents{
    Limit:  20,
    Offset: 0,
})

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบวันที่และค่าพารามิเตอร์
invalid_date_format	วันที่ไม่อยู่ในรูปแบบ ISO 8601	ใช้รูปแบบ: YYYY-MM-DDTHH:MM:SSZ
not_found	ไม่พบ Charge	ตรวจสอบ charge ID และให้แน่ใจว่าใช้โหมดที่ถูกต้อง (test/live)

ประเภท Event สำหรับ Charges

คีย์	คำอธิบาย
charge.create	สร้าง Charge แล้ว
charge.complete	Charge สำเร็จ
charge.update	อัปเดต Charge แล้ว (เช่น captured, เปลี่ยน metadata)
charge.reverse	Charge ถูกกลับรายการ
charge.expire	Charge หมดอายุ
refund.create	ประมวลผลการคืนเงินสำหรับ charge แล้ว
charge.dispute.create	มีการยื่นข้อพิพาทต่อ charge
charge.dispute.update	สถานะข้อพิพาทเปลี่ยนแปลง
charge.dispute.close	ข้อพิพาทได้รับการแก้ไข

---

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

▼

ทดลองใช้งาน

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

▼

id(จำเป็น)

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