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

{
  "object": "event",
  "id": "evnt_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "location": "/events/evnt_test_no1t4tnemucod0e51mo",
  "created_at": "2019-12-31T12:59:59Z",
  "key": "charge.create",
  "data": {
    "object": "charge",
    "id": "chrg_test_no1t4tnemucod0e51mo",
    "livemode": false,
    "location": "/charges/chrg_test_no1t4tnemucod0e51mo",
    "created_at": "2019-12-31T12:59:59Z",
    "amount": 12345,
    "currency": "THB",
    "funding_amount": 12345,
    "funding_currency": "THB",
    "fee": 451,
    "fee_vat": 32,
    "interest": 0,
    "interest_vat": 0,
    "net": 11862,
    "description": null,
    "metadata": {
      "order_id": "P26042018-01",
      "color": "pink"
    },
    "status": "successful",
    "capture": true,
    "authorized": true,
    "schedule": null,
    "reversed": false,
    "reversed_at": null,
    "expires_at": "2019-12-31T12:59:59Z",
    "expired": false,
    "expired_at": null,
    "voided": false,
    "paid": true,
    "paid_at": "2019-12-31T12:59:59Z",
    "transaction": "trxn_test_no1t4tnemucod0e51mo",
    "refunded_amount": 0,
    "refunds": {
      "object": "list",
      "from": "1970-01-01T00:00:00Z",
      "to": "2019-12-31T12:59:59Z",
      "offset": 0,
      "limit": 20,
      "total": 0,
      "order": "chronological",
      "location": "/charges/chrg_test_no1t4tnemucod0e51mo/refunds",
      "data": []
    },
    "link": null,
    "return_uri": "https://www.example.com/orders/54321/complete",
    "failure_code": null,
    "failure_message": null,
    "card": {
      "object": "card",
      "id": "card_test_no1t4tnemucod0e51mo",
      "livemode": false,
      "location": null,
      "created_at": "2019-12-31T12:59:59Z",
      "deleted": false,
      "street1": "1448/4 Praditmanutham Road",
      "street2": null,
      "city": "Bangkok",
      "state": null,
      "postal_code": "10320",
      "country": "th",
      "phone_number": "0123456789",
      "financing": "credit",
      "bank": "Bank of the Unbanked",
      "first_digits": null,
      "last_digits": "4242",
      "brand": "Visa",
      "expiration_month": 12,
      "expiration_year": 2022,
      "fingerprint": "XjOdjaoHRvUGRfmZacMPcJtm0U3SEIIfkA7534dQeVw=",
      "name": "Somchai Prasert",
      "security_code_check": true
    },
    "customer": null,
    "ip": "203.0.113.1",
    "dispute": null,
    "source": null,
    "platform_fee": {
      "percentage": null,
      "fixed": null,
      "amount": null
    },
    "disputable": true,
    "capturable": false,
    "reversible": false,
    "refundable": true,
    "zero_interest_installments": true,
    "authorize_uri": "https://api.omise.co/payments/paym_test_no1t4tnemucod0e51mo/authorize"
  }
}

イベント情報の取得

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

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

Example

イベント情報の取得
- curl
- php
- node.js
- ruby
- C#
- java
- python
- go
- elixir
```
curl https://api.omise.co/events/evnt_test_5fzo43xgisxdvptf77i \
  -u $OMISE_SECRET_KEY:
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
$event = OmiseEvent::retrieve('event_id');
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
omise.events.retrieve("evnt_test_52cin5n9bb6lytxduh9", function(err, resp){
  /* Response. */
});
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

event = Omise::Event.retrieve("evnt_test_52cin5n9bb6lytxduh9")
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
var ev = await Client.Events.Get("evnt_test_58fffxu2gn498pb03pd");
Console.WriteLine($"event action: {ev.Key} {ev.Data.Id}");
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
Request<Event> request = new Event.GetRequestBuilder("evnt_test_5vxs0ajpo78").build();
Event event = client().sendRequest(request);

System.out.printf("Event key: %s", event.getKey());
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'
event = omise.Event.retrieve('evnt_test_5vxs0ajpo78')

# After retrieving it, the event can be refreshed:
event.reload()
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
event, list := &omise.Event{}, &operation.RetrieveEvent{
	EventID: "evnt_test_5vxs0ajpo78"
}
if e := client.Do(event, list); e != nil {
	log.Fatalln(e)
}

log.Println("event:", event.ID)
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Event.retrieve("evnt_test_52cin5n9bb6lytxduh9")
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。

振込情報リストの取得

- 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

イベント情報リストの取得
- curl
- php
- node.js
- ruby
- C#
- java
- python
- go
- elixir
```
curl https://api.omise.co/events \
  -u $OMISE_SECRET_KEY:
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
$events = OmiseEvent::retrieve();
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
omise.events.list(function(err, resp) {
  /* Response. */
});
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

events = Omise::Event.list
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
var events = await Client.Events.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"total events: {events.Total}");
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
Request<ScopedList<Event>> request = new Event.ListRequestBuilder().build();
ScopedList<Event> events = client().sendRequest(request);

System.out.printf("Total no. of events: %d", events.getTotal());
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'
events = omise.Event.retrieve()

# After retrieving it, the event can be refreshed:
events.reload()
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
events, list := &omise.EventList{}, &operation.ListEvents{}
if e := client.Do(events, list); e != nil {
	log.Fatalln(e)
}

log.Println("events:", len(events.Data))
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。
```
Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Event.list
```
この実施例は、テストカードデータでのみご利用ください。

実際のカードデータは、Omise.js、iOS SDK、またはAndroid SDKのいずれかを使用して、クライアントデバイスでトークン化する必要があります。

実際のカードデータをサーバーで保存、または送信するには、有効なPCI-DSS証明書が必要です。詳細については、セキュリティ対策をご覧ください。