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

GEThttps://api.omise.co/events

ดึงข้อมูลรายการ Event ทั้งหมดแบบแบ่งหน้าในบัญชีของคุณ Event แสดงถึงการดำเนินการที่เกิดขึ้น เช่น การเรียกเก็บเงิน การคืนเงิน ข้อพิพาท และการโอนเงิน ใช้ endpoint นี้เพื่อตรวจสอบกิจกรรมของบัญชี แก้ไข webhook และตรวจสอบธุรกรรม

---

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

▼

---

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

Optional - 3 fieldsPagination Parameters

▼

`limit`INTEGER(optional)

Number of events to return per page.

Example:20

Constraints:Minimum: 1, Maximum: 100, Default: 20

Default:20

`offset`INTEGER(optional)

Number of events to skip for pagination. Use with limit to paginate through large result sets.

Example:0

Default:0

`order`STRING(optional)

Sort order of results.

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

Optional - 2 fieldsFilter Parameters

▼

---

การตอบกลับ

200

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

ส่งคืนรายการ Event object แบบแบ่งหน้า Event แต่ละรายการมีข้อมูลครบถ้วนเกี่ยวกับการดำเนินการที่เกิดขึ้น

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

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

400

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

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

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

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

401

ไม่ได้รับการยืนยันตัวตน

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

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

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

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

events = Omise::Event.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

events = omise.Event.list(
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

$events = OmiseEvent::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Event> events = client.events().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var events = await client.Events.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

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

---

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

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

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

ประเภท Event

Key	คำอธิบาย
charge.create	สร้างการเรียกเก็บเงินแล้ว
charge.complete	การเรียกเก็บเงินสำเร็จ
charge.update	อัปเดตการเรียกเก็บเงินแล้ว
refund.create	ดำเนินการคืนเงินแล้ว
charge.dispute.create	ยื่นข้อพิพาทแล้ว
customer.create	สร้างลูกค้าแล้ว
customer.update	อัปเดตลูกค้าแล้ว

---

ทดลองใช้งาน