เรียกข้อมูล Event

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

รับข้อมูลรายละเอียดเกี่ยวกับ Event เฉพาะ ใช้ endpoint นี้เพื่อตรวจสอบรายละเอียดของ Event แก้ไขข้อผิดพลาดการส่ง webhook และตรวจสอบข้อมูลที่ถูกส่งไปยัง webhook ของคุณ

---

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

▼

---

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

Required - 1 fieldPath Parameters

▼

`id`STRING(required)

The event ID to retrieve. Event IDs start with evnt_ followed by test_ for test mode.

Example:"evnt_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

เรียกข้อมูลสำเร็จ

ส่งคืนออบเจ็กต์ Event พร้อมรายละเอียดที่สมบูรณ์ รวมถึงข้อมูลที่ทริกเกอร์ Event และข้อมูลการส่ง webhook

ออบเจ็กต์ Event ประกอบด้วย:

• id - ตัวระบุ Event (evnt_*)
• key - ประเภท Event (เช่น charge.complete)
• data - ออบเจ็กต์ที่สมบูรณ์ซึ่งทริกเกอร์ Event
• webhook_deliveries - อาร์เรย์ของความพยายามในการส่ง webhook พร้อมสถานะและการตอบกลับ
• created_at - วันที่และเวลาที่ Event เกิดขึ้น (ISO 8601)

401

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

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

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

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

404

ไม่พบ

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

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

• Event ID ไม่ถูกต้อง
• Event ID จากบัญชีอื่น
• ใช้คีย์โหมดทดสอบและโหมดจริงปนกัน
• Event ถูกสร้างเมื่อมากกว่า 90 วันที่แล้ว (Event จะถูกเก็บไว้เป็นเวลา 90 วัน)

---

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

cURL

curl https://api.omise.co/events/evnt_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

event = Omise::Event.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

event = omise.Event.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const event = await omise.events.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$event = OmiseEvent::retrieve('evnt_test_5xuy4w91xqz7d1w9u0t');

Java

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

Event event = client.events().get("evnt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var event = await client.Events.Get("evnt_test_5xuy4w91xqz7d1w9u0t");

Go

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

event, _ := client.GetEvent("evnt_test_5xuy4w91xqz7d1w9u0t")

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบ Event	ตรวจสอบ Event ID และตรวจสอบว่าอยู่ในโหมดที่ถูกต้อง (test/live)

รหัสสถานะการส่ง Webhook

สถานะ	คำอธิบาย
200	ส่งและประมวลผลสำเร็จ
4xx	ข้อผิดพลาดฝั่งไคลเอนต์ (คำขอไม่ถูกต้อง การยืนยันตัวตนล้มเหลว)
5xx	ข้อผิดพลาดฝั่งเซิร์ฟเวอร์ (endpoint ของคุณมีข้อผิดพลาด)
null	การส่งล้มเหลว (หมดเวลา การเชื่อมต่อถูกปฏิเสธ)

---

ลองใช้งาน

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

▼

id(จำเป็น)