Occurrence API

Occurrencesは、Schedule(スケジュール)API によって設定されたイベントの実行予定日を表すオブジェクトです。 例えば、2017年1月1日から3か月間、月の第1月曜日に決済するスケジュールを設定した場合、Occurrenceは次のようになります。

  • 2017年 1月2日 月曜日
  • 2017年 2月6日 月曜日
  • 2017年 3月6日 月曜日

実行予定日に課金や送金のエラーが発生し処理できなかった場合は、翌日に再度処理を試行するようOccurrenceが複製されます。 例えば、2017年2月6日に予定していた課金または送金スケジュールが失敗してしまった場合には、翌日の2017年2月7日に再試行されます。

  • 2017年 1月2日 月曜日 - 成功
  • 2017年 2月6日 月曜日 - 失敗
  • 2017年 2月7日 火曜日 - 再試行 成功
  • 2017年 3月6日 月曜日 - 成功

再試行は3回まで実行されます。 3回立て続けに失敗した場合は、そのスケジュール処理は実行不可と判断し、システム側で自動的に停止のステータスへ変更します。 以降に予定されていた処理は実行されません。

  • 2017年 1月2日 月曜日 - 成功
  • 2017年 2月6日 月曜日 - 失敗
  • 2017年 2月7日 火曜日 - 再試行 失敗
  • 2017年 2月8日 水曜日 - 再試行 失敗
  • スケジュール停止

Attribute

Name Type Description
object string

オブジェクト名、このJSONレスポンスがOccurrenceオブジェクトであることを示すoccurrence

id object_id

OccurrenceのID、一意なオブジェクトを示す文字列。

livemode boolean

本番モード (true) あるいはテストモード(false) occurrence。

location string

現在のoccurrenceオブジェクトを取得するためのAPIパス。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でoccurrence作成の協定世界時(UTC)。

message string

Occurrenceの処理が予定どおりに行われなかった場合、修正方法に関するヒントが表示されます。エラーメッセージまたは、ステータスに関する警告など。

processed_at datetime

ISO 8601形式のOccurrenceが処理日。成功・失敗したかに関わらず、処理が試行された日。

result object_id

一意なオブジェクトを示す文字列(Charge ID、Transfer IDのいずれか)Occurrenceの処理が実行されたことで作成されたオブジェクトの参照ID。オブジェクトが作成されなかった場合は空欄となり、messageフィールドで詳細情報を確認できます。

retry_date date

ISO 8601形式のOccurrence再試行日。schedule_date(試行予定日)に処理できなかった場合(課金の失敗など)、Occurrenceは複製されretry_date(翌日)に再度試行される。schedule_date(試行予定日)に問題なく処理できた場合は空欄。

schedule object_id

属するScheduleのID。

schedule_date date

ISO 8601形式のOccurrence試行予定日。

status string

skipped(スキップ)、failed(失敗)、successful(成功)のいずれかの状態を表す文字列。

特定のスケジュールに関する全てのOccurrenceのリストを取得

- GET https://api.omise.co/schedules/SCHEDULE_ID/occurrences

occurrenceに属するすべての オブジェクトの list を返します。

Request Parameter

Name Type Description
offset integer

(optional、default:0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

(optional, default: current UTC datetime) ISO 8601 形式で返されたレコードの最新のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

  • 特定のスケジュールに関する全てのOccurrenceのリストを取得

Occurrenceを取得

- GET https://api.omise.co/occurrences/OCCURRENCE_ID

Occurrence IDで指定した特定のOccurrenceを返します。

Example

  • Occurrenceを取得