オカレンスの取得

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

特定のスケジュールオカレンスの詳細を取得します。各オカレンスは定期スケジュールの1回の実行を表します。このエンドポイントを使用して、スケジュール済み支払いが成功したかどうかを確認し、失敗した課金を調査し、リトライ情報を追跡します。

---

リクエストパラメータ

必須 - 1フィールドパスパラメータ

▼

`id`STRING(required)

取得するオカレンスID。オカレンスIDはoccu_で始まり、テストモードの場合はtest_が続きます。

Example:"occu_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

実行詳細、ステータス、結果情報を含むオカレンスオブジェクトを返します。

オカレンスオブジェクトに含まれる項目:

• object - 値 "occurrence"
• id - オカレンス識別子（occu_*）
• livemode - 本番またはテストモード
• location - オカレンスオブジェクトへのAPIパス
• message - 処理が失敗した場合の失敗理由の説明
• processed_at - オカレンス処理のUTC日時（ISO 8601）
• result - オカレンス処理の結果（課金または振込ID）
• retry_on - 処理が失敗した場合のリトライ日（ISO 8601日付）
• schedule - オカレンスが属するスケジュール（展開可能）
• scheduled_on - オカレンスがスケジュールされた日付（ISO 8601日付）
• status - オカレンスのステータス: skipped、failed、またはsuccessful
• created_at - オカレンス作成タイムスタンプ（ISO 8601）

401

認証エラー

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

404

見つかりません

オカレンスが見つからないか存在しません。

一般的な原因:

• 無効なオカレンスID
• 別のアカウントのオカレンスID
• テストキーと本番キーの混在

5xx

サーバーエラー

サーバー側でエラーが発生しました。これらは稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

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キー	シークレットキーが正しいことを確認
not_found	オカレンスが見つかりません	オカレンスIDと正しいモード（テスト/本番）を確認

オカレンスステータス値

ステータス	説明
successful	課金/振込が正常に作成されました
failed	実行が失敗しました（カード拒否、残高不足など）
skipped	オカレンスがスキップされました（スケジュール一時停止、顧客削除）

一般的な失敗メッセージ

メッセージ	説明
insufficient_fund	顧客の残高不足
card_declined	カードが発行者によって拒否されました
expired_card	カードの有効期限が切れています
customer_not_found	顧客が削除されました

オカレンスオブジェクトフィールド

フィールド	型	説明
object	string	常に "occurrence" を返す
id	string	オカレンス識別子（occu_*）
livemode	boolean	本番またはテストモード
location	string	オカレンスオブジェクトへのAPIパス
message	string	処理が失敗した場合の失敗理由の説明
processed_at	datetime	オカレンス処理のUTC日時（ISO 8601）
result	string	オカレンス処理の結果（課金または振込ID）
retry_on	date	処理が失敗した場合のリトライ日（ISO 8601日付）
schedule	string	オカレンスが属するスケジュール（展開可能）
scheduled_on	date	オカレンスがスケジュールされた日付（ISO 8601日付）
status	string	オカレンスのステータス: skipped、failed、またはsuccessful
created_at	datetime	オカレンス作成タイムスタンプ（ISO 8601）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

あなたのIP: ...読み込み中...