Event(イベント)

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

Attribute

Name Type Description
object string

固定値 event

id object_id

イベントの識別子(EVENT_ID)。

livemode boolean

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

location string

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

created datetime

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

data object

このイベントに関連した、課金の 詳細データ(payload)。データの詳細については、APIドキュメ ントを参照。

key string

イベントの状態。WebHookにも リスト(表示)されている。

Example

  • Json Response

振込情報リストの取得

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

eventに属するすべての お客様のアカウントオブジェクトの 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

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

イベント情報の取得

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

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

Example

  • イベント情報の取得