すべてのEventを一覧表示

GEThttps://api.omise.co/events

アカウント内のすべてのEventのページ分割されたリストを取得します。Eventは、請求、返金、紛争、送金などの発生したアクションを表します。このエンドポイントを使用して、アカウントのアクティビティを監視し、webhookをデバッグし、トランザクションを監査します。

---

🔑API認証情報

▼

---

リクエストパラメータ

Optional - 3 fieldsPagination Parameters

▼

`limit`INTEGER(optional)

Number of events to return per page.

Example:20

Constraints:Minimum: 1, Maximum: 100, Default: 20

Default:20

`offset`INTEGER(optional)

Number of events to skip for pagination. Use with limit to paginate through large result sets.

Example:0

Default:0

`order`STRING(optional)

Sort order of results.

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

Optional - 2 fieldsFilter Parameters

▼

---

レスポンス

200

取得成功

Eventオブジェクトのページ分割されたリストを返します。各Eventには、発生したアクションに関する完全な情報が含まれています。

レスポンスに含まれる内容:

• data - Eventオブジェクトの配列
• limit - ページあたりの結果数
• offset - スキップされた結果数
• total - Eventの総数
• order - 適用された並び順

400

リクエストが不正です

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

一般的な原因:

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

401

認証されていません

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーが欠落しています
• secret keyが無効です
• secret keyの代わりにpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

---

コードサンプル

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キー	secret keyが正しいことを確認してください
bad_request	無効なパラメータ	日付形式とパラメータ値を確認してください
invalid_date_format	日付がISO 8601形式ではありません	次の形式を使用してください: YYYY-MM-DDTHH:MM:SSZ

Eventタイプ

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

---

試してみる