Event(イベント)

Event(イベント)APIを使用すると、加盟店アカウント上で生成されたEvent を検索できます。Event(新しい顧客の作成や課金の取消など)は、HTTP POST リクエストやOmiseサーバーのWebHooksを起動することで、フレキシブルな 自動化を提供します。サポート済みイベントの詳細については、 WebHooks documentationをご参照ください。

Events are always serialized according to your account version as of the time of the event regardless of the version specified in the triggering request. The data attribute can therefore contain events spanning several versions.

Attributes

Name Type Description
object string

固定値 event

id object_id

/evnt(_test)?_[0-9a-z]+/に一致する EVENT_ID

livemode boolean

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

location string

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

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でイベントが作成されたUTC日時。

data object

発生したイベントに関連付けられたオブジェクト。

key string

イベントの状態(例:charge.create)

Example

  • JSON Response

イベント情報の取得

- GET https://api.omise.co/events/{id}

既存のイベントオブジェクトを返します 。

Example

  • イベント情報の取得

振込情報リストの取得

- GET https://api.omise.co/events

eventに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

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

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

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

Example

  • イベント情報リストの取得