เรียกดู Occurrence

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

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

---

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

▼

---

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

จำเป็น - 1 รายการพารามิเตอร์ในเส้นทาง

▼

`id`STRING(required)

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

Example:"occu_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

เรียกดูสำเร็จ

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

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

• id - ตัวระบุ Occurrence (occu_*)
• schedule - Schedule ID หลัก
• scheduled_on - วันที่ที่ occurrence ควรจะถูกประมวลผล
• processed_at - วันที่และเวลาที่ occurrence ถูกประมวลผลจริง (ISO 8601)
• status - successful, failed, หรือ skipped
• result - ID ของ charge หรือ transfer ที่สร้างขึ้น (null หากล้มเหลว/ข้าม)
• message - ข้อความแสดงข้อผิดพลาดหากล้มเหลว, null หากสำเร็จ
• retry_on - วันที่ลองใหม่หากการประมวลผลล้มเหลว

401

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

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

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

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

404

ไม่พบ

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

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

• occurrence ID ไม่ถูกต้อง
• occurrence ID จากบัญชีอื่น
• ใช้ key ของโหมดทดสอบและโหมดจริงปะปนกัน

---

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

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")

---

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

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

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

ค่าสถานะของ Occurrence

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

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

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

---

ทดลองใช้งาน

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

▼

id(จำเป็น)