รายการ Events ของ Charge

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

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

---

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

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

▼

`id`STRING(required)

Charge ID ที่ต้องการดึง events ต้องเป็น charge ID ที่ถูกต้องจากบัญชีของคุณ

Example:"chrg_test_5xuy4w91xqz7d1w9u0t"

Constraints:ต้องขึ้นต้นด้วย chrg_, Test charges: chrg_test_, Live charges: chrg_live_

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

▼

`limit`INTEGER(optional)

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

Example:20

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

Default:20

`offset`INTEGER(optional)

จำนวน events ที่จะข้ามสำหรับ pagination ใช้ร่วมกับ limit เพื่อนำทางผ่านหน้า

Example:0

Default:0

`order`STRING(optional)

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

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

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

▼

---

การตอบกลับ

200

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

ส่งคืนออบเจ็กต์รายการที่มี array ข้อมูล event และ metadata pagination

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

• data - Array ของออบเจ็กต์ event
• total - จำนวน events ทั้งหมดสำหรับ charge นี้
• limit - จำนวนรายการต่อหน้า
• offset - offset pagination ปัจจุบัน
• order - ลำดับการเรียงที่ใช้
• from / to - ช่วงวันที่ที่ใช้

400

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

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

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

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

401

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

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

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

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

404

ไม่พบ

Charge ID ไม่มีอยู่

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

• Charge ID ไม่ถูกต้อง
• Charge จากบัญชีอื่น
• ใช้ test key สำหรับ live charge (หรือในทางกลับกัน)

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

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

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()
    .get("chrg_test_5xuy4w91xqz7d1w9u0t")
    .events()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

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

---

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

ประเภท Event ทั่วไป

Event Key	คำอธิบาย	เมื่อถูก Trigger
charge.create	Charge ถูกสร้าง	เมื่อสร้าง charge
charge.update	Charge ถูกอัปเดต	เมื่ออัปเดต charge
charge.capture	Charge ถูก capture	เมื่อ charge pre-auth ถูก capture
charge.complete	Charge สำเร็จ	เมื่อชำระเงินสำเร็จ
charge.expire	Charge หมดอายุ	เมื่อ charge หมดอายุโดยไม่มีการชำระเงิน
charge.reverse	Charge ถูกย้อนกลับ	เมื่อ pre-auth ถูกย้อนกลับ
charge.fail	Charge ล้มเหลว	เมื่อชำระเงินล้มเหลว

การคำนวณ Pagination

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

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

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

▼

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

▼

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