Event API
Event API สามารถใช้เพื่อเรียกดูข้อมูลเหตุการณ์ทั้งหมดที่เกิดขึ้นในบัญชีผู้ใช้โอมิเซะ เหตุการณ์ต่างๆ (เช่น การสร้างผู้รับเงินใหม่หรือการยกเลิกรายการรับชำระเงิน) จะ trigger HTTP POST หรือ Webhooks ที่เซิร์ฟเวอร์ของโอมิเซะ ซึ่งสามารถส่งข้อมูลเกี่ยวกับเหตุการณ์ต่างๆ ได้อัตโนมัติ สามารถอ่านรายละเอียดเพิ่มเติมได้ที่ คู่มือการใช้งาน Webhooks
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.
Attributes
Name | Type | Description |
---|---|---|
object | string | The string |
id | object_id | The event identifier matching |
livemode | boolean | Whether this is a live ( |
location | string | API path to retrieve the current |
created_at | datetime | UTC datetime of event creation in ISO 8601 format ( |
data | object | Object associated with the triggered event. |
key | string | Event details (e.g. |
webhook_deliveries | array | Webhook deliveries for event. |
Example
-
JSON Response
{ "object": "event", "id": "evnt_test_no1t4tnemucod0e51mo", "livemode": false, "location": "/events/evnt_test_no1t4tnemucod0e51mo", "webhook_deliveries": [ { "object": "webhook_delivery", "id": "whdl_test_no1t4tnemucod0e51mo", "uri": "https://omise-flask-example.herokuapp.com/webhook", "status": 200 } ], "data": { "object": "charge", "id": "chrg_test_no1t4tnemucod0e51mo", "location": "/charges/chrg_test_no1t4tnemucod0e51mo", "amount": 12345, "net": 11862, "fee": 451, "fee_vat": 32, "interest": 0, "interest_vat": 0, "funding_amount": 12345, "refunded_amount": 0, "authorized": true, "capturable": false, "capture": true, "disputable": true, "livemode": false, "refundable": true, "reversed": false, "reversible": false, "voided": false, "paid": true, "expired": false, "platform_fee": { "fixed": null, "amount": null, "percentage": null }, "currency": "THB", "funding_currency": "THB", "ip": "203.0.113.1", "refunds": { "object": "list", "data": [], "limit": 20, "offset": 0, "total": 0, "location": "/charges/chrg_test_no1t4tnemucod0e51mo/refunds", "order": "chronological", "from": "1970-01-01T00:00:00Z", "to": "2019-12-31T12:59:59Z" }, "link": null, "description": null, "metadata": { "order_id": "P26042018-01", "color": "pink" }, "card": { "object": "card", "id": "card_test_no1t4tnemucod0e51mo", "livemode": false, "location": null, "deleted": false, "street1": "1448/4 Praditmanutham Road", "street2": null, "city": "Bangkok", "state": null, "phone_number": "0123456789", "postal_code": "10320", "country": "th", "financing": "credit", "bank": "Bank of the Unbanked", "brand": "Visa", "fingerprint": "XjOdjaoHRvUGRfmZacMPcJtm0U3SEIIfkA7534dQeVw=", "first_digits": null, "last_digits": "4242", "name": "Somchai Prasert", "expiration_month": 12, "expiration_year": 2022, "security_code_check": true, "created_at": "2019-12-31T12:59:59Z" }, "source": null, "schedule": null, "customer": null, "dispute": null, "transaction": "trxn_test_no1t4tnemucod0e51mo", "failure_code": null, "failure_message": null, "status": "successful", "authorize_uri": "https://api.omise.co/payments/paym_test_no1t4tnemucod0e51mo/authorize", "return_uri": "https://www.example.com/orders/54321/complete", "created_at": "2019-12-31T12:59:59Z", "paid_at": "2019-12-31T12:59:59Z", "expires_at": "2019-12-31T12:59:59Z", "expired_at": null, "reversed_at": null, "zero_interest_installments": true, "branch": null, "terminal": null, "device": null }, "key": "charge.create", "created_at": "2019-12-31T12:59:59Z" }
Retrieve an event
- GET https://api.omise.co/events/{id}Returns the event
matching :id
.
Example
-
Retrieve an event
- 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_no1t4tnemucod0e51mo" event = omise.Event.retrieve("evnt_test_no1t4tnemucod0e51mo") # 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 อ่านเพิ่มเติมได้ที่แนวทางปฏิบัติเพื่อความปลอดภัย
List events
- GET https://api.omise.co/eventsReturns a list of events belonging to your account. Because events are always serialized (and stored) according to your account version as of the time of the event, the data
attribute for the event list endpoint can contain events spanning several versions.
Request Parameters
Name | Type | Description |
---|---|---|
from | datetime | (optional, default: |
limit | integer | (optional, default: 20, maximum: 100) Number of records returned. |
offset | integer | (optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning). |
order | string | (optional, default: |
to | datetime | (optional, default: current UTC datetime) Latest UTC datetime for returned records in ISO 8601 format ( |
Example
-
List all events
- 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_no1t4tnemucod0e51mo" events = omise.Event.retrieve()
ตัวอย่างนี้สำหรับใช้กับข้อมูลบัตรสำหรับทดสอบเท่านั้น
ข้อมูลบัตรจริงจะต้องถูกเข้ารหัสจากอุปกรณ์ของผู้ถือบัตรโดยใช้ 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 อ่านเพิ่มเติมได้ที่แนวทางปฏิบัติเพื่อความปลอดภัย