Event(イベント)

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

Attributes

Name Type Description
object string

固定値 event

id string

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

livemode boolean

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

location string

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

created_at string

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

data object

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

key string

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

team_uid string

イベントをトリガーしたサブマーチャントのIDです。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。

webhook_deliveries array

イベント用のWebhook配信

Example

  • JSON Response

振込情報リストの取得

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

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

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

Example

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

List events for charge

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

Returns a list of events belonging to charge matching :id.

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

イベント情報の取得

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

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

Example

  • イベント情報の取得

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら