全イベント一覧

GEThttps://api.omise.co/events

アカウント内の全イベントのページネーション付きリストを取得します。イベントは、課金、返金、紛争、送金など、発生したアクションを表します。このエンドポイントを使用して、アカウントアクティビティの監視、webhookのデバッグ、取引の監査を行います。

---

リクエストパラメータ

オプション - 3フィールドページネーションパラメータ

▼

`limit`INTEGER(optional)

ページごとに返すイベント数。

Example:20

Constraints:最小: 1, 最大: 100, デフォルト: 20

Default:20

`offset`INTEGER(optional)

ページネーションのためにスキップするイベント数。大きな結果セットをページネーションするためにlimitと一緒に使用します。

Example:0

Default:0

`order`STRING(optional)

結果のソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

オプション - 2フィールドフィルタパラメータ

▼

---

レスポンス

200

取得成功

イベントオブジェクトのページネーション付きリストを返します。各イベントには発生したアクションに関する完全な情報が含まれています。

レスポンスに含まれるもの:

• data - イベントオブジェクトの配列
• limit - ページごとの結果数
• offset - スキップされた結果数
• total - イベントの総数
• order - 適用されたソート順

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 無効な日付形式（ISO 8601形式である必要があります）
• limitが最大値（100）を超えている
• 無効なorderパラメータ

401

認証エラー

認証に失敗しました。無効または不足しているAPIキー。

一般的な原因:

• Authorizationヘッダーがない
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用している
• 不正なHTTP Basic Auth形式

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストをリトライ
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/events \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

events = Omise::Event.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

events = omise.Event.list(
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const events = await omise.events.list({
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$events = OmiseEvent::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Event> events = client.events().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var events = await client.Events.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

events, _ := client.ListEvents(&operations.ListEvents{
    Limit:  20,
    Offset: 0,
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
bad_request	無効なパラメータ	日付形式とパラメータ値を確認
invalid_date_format	日付がISO 8601形式でない	形式: YYYY-MM-DDTHH:MM:SSZを使用

イベントタイプ

キー	説明
charge.create	課金が作成された
charge.complete	課金が成功した
charge.update	課金が更新された
refund.create	返金が処理された
charge.dispute.create	紛争が提起された
customer.create	顧客が作成された
customer.update	顧客が更新された

---

🔑API認証情報

▼

試してみる

あなたのIP: ...読み込み中...