Occurrenceの取得

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

特定のスケジュールoccurrenceの詳細を取得します。各occurrenceは、定期スケジュールの1回の実行を表します。このエンドポイントを使用して、スケジュールされた決済が成功したかどうかを確認し、失敗したチャージを調査し、再試行情報を追跡します。

---

🔑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 - 作成されたchargeまたはtransferのID（失敗/スキップの場合はnull）
• message - 失敗した場合のエラーメッセージ、成功した場合はnull
• retry_on - 処理が失敗した場合の再試行日

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーが欠落している
• 無効なシークレットキー
• シークレットキーの代わりに公開キーを使用している
• HTTP Basic Auth形式が正しくない

404

見つかりません

Occurrenceが見つからないか、存在しません。

一般的な原因:

• 無効なoccurrence ID
• 別のアカウントのoccurrence ID
• テストモードと本番モードのキーが混在している

---

コードサンプル

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	Occurrenceが見つかりません	Occurrence IDを確認し、正しいモード（テスト/本番）であることを確認してください

Occurrenceステータス値

ステータス	説明
successful	Charge/transferが正常に作成されました
failed	実行に失敗しました（カード拒否、残高不足など）
skipped	Occurrenceはスキップされました（Scheduleが一時停止、顧客が削除）

一般的な失敗メッセージ

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

---

試してみる

必須 - 1項目

▼

id(必須)