ดึงข้อมูล Occurrence

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

ดึงรายละเอียดเกี่ยวกับ occurrence ของ schedule เฉพาะ แต่ละ occurrence แสดงถึงการดำเนินการหนึ่งครั้งของ schedule ที่เกิดขึ้นซ้ำ ใช้ endpoint นี้เพื่อตรวจสอบว่าการชำระเงินที่กำหนดเวลาไว้สำเร็จหรือไม่ ตรวจสอบ charges ที่ล้มเหลว และติดตามข้อมูลการลองใหม่

---

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

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

▼

`id`STRING(required)

ID ของ occurrence ที่ต้องการดึงข้อมูล ID ของ occurrence เริ่มต้นด้วย occu_ ตามด้วย test_ สำหรับโหมดทดสอบ

Example:"occu_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

ส่งคืนออบเจกต์ occurrence พร้อมรายละเอียดการดำเนินการ สถานะ และข้อมูลผลลัพธ์

ออบเจกต์ occurrence รวมถึง:

• object - ค่า "occurrence"
• id - ตัวระบุ occurrence (occu_*)
• livemode - โหมด live หรือ test
• location - เส้นทาง API ไปยังออบเจกต์ occurrence
• message - คำอธิบายสำหรับความล้มเหลวหากการประมวลผลล้มเหลว
• processed_at - วันเวลา UTC ของการประมวลผล occurrence (ISO 8601)
• result - ผลลัพธ์ของการประมวลผล occurrence (charge หรือ transfer ID)
• retry_on - วันที่ลองใหม่หากการประมวลผลล้มเหลว (วันที่ ISO 8601)
• schedule - schedule ที่ occurrence นี้เป็นสมาชิก (ขยายได้)
• scheduled_on - วันที่ที่ occurrence ถูกกำหนดเวลา (วันที่ ISO 8601)
• status - สถานะของ occurrence: skipped, failed หรือ successful
• created_at - timestamp การสร้าง occurrence (ISO 8601)

401

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

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

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

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

404

ไม่พบ

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

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

• ID occurrence ไม่ถูกต้อง
• ID occurrence จากบัญชีอื่น
• ใช้ key ผสมระหว่าง test และ live

5xx

เซิร์ฟเวอร์ error

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/occurrences/occu_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

occurrence = Omise::Occurrence.retrieve('occu_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

occurrence = omise.Occurrence.retrieve('occu_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const occurrence = await omise.occurrences.retrieve('occu_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$occurrence = OmiseOccurrence::retrieve('occu_test_5xuy4w91xqz7d1w9u0t');

Java

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

Occurrence occurrence = client.occurrences().get("occu_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var occurrence = await client.Occurrences.Get("occu_test_5xuy4w91xqz7d1w9u0t");

Go

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

occurrence, _ := client.GetOccurrence("occu_test_5xuy4w91xqz7d1w9u0t")

---

รหัส Error และผลลัพธ์

รหัส Error ทั่วไป

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

ค่าสถานะ Occurrence

สถานะ	คำอธิบาย
successful	สร้าง charge/transfer สำเร็จ
failed	การดำเนินการล้มเหลว (บัตรถูกปฏิเสธ ยอดเงินไม่เพียงพอ ฯลฯ)
skipped	Occurrence ถูกข้าม (schedule ถูกระงับ ลูกค้าถูกลบ)

ข้อความความล้มเหลวทั่วไป

ข้อความ	คำอธิบาย
insufficient_fund	ลูกค้ามียอดเงินไม่เพียงพอ
card_declined	บัตรถูกปฏิเสธโดยผู้ออกบัตร
expired_card	บัตรหมดอายุ
customer_not_found	ลูกค้าถูกลบ

ฟิลด์ออบเจกต์ Occurrence

ฟิลด์	ประเภท	คำอธิบาย
object	string	ส่งคืน "occurrence" เสมอ
id	string	ตัวระบุ occurrence (occu_*)
livemode	boolean	โหมด live หรือ test
location	string	เส้นทาง API ไปยังออบเจกต์ occurrence
message	string	คำอธิบายสำหรับความล้มเหลวหากการประมวลผลล้มเหลว
processed_at	datetime	วันเวลา UTC ของการประมวลผล occurrence (ISO 8601)
result	string	ผลลัพธ์ของการประมวลผล occurrence (charge หรือ transfer ID)
retry_on	date	วันที่ลองใหม่หากการประมวลผลล้มเหลว (วันที่ ISO 8601)
schedule	string	schedule ที่ occurrence นี้เป็นสมาชิก (ขยายได้)
scheduled_on	date	วันที่ที่ occurrence ถูกกำหนดเวลา (วันที่ ISO 8601)
status	string	สถานะของ occurrence: skipped, failed หรือ successful
created_at	datetime	timestamp การสร้าง occurrence (ISO 8601)

---

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

▼

ลองใช้งาน

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

▼

id(จำเป็น)

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