Event API

Attribute

Name Type Description
object string

The string event.

id string

The EVENT_ID.

livemode boolean

Whether this is a live (true) or test (false) event.

location string

Path to retrieve the event.

key string

The event status as listed in WebHooks.

created datetime

Creation date of the event in ISO 8601 format.

data Object

The data payload. See also API documentation of each content types.

List all events

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

Returns a list of event objects.

Query Parameter

Name Type Description
offset integer

(optional, default: 0) The offset of the first record returned. I.e.: How many records to skip from the beginning.

limit integer

(optional, default: 20, maximum: 100) The maximum amount of records returned.

from datetime

(optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records. E.g.: 2014-10-20T00:00:00Z

to datetime

(optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records. E.g.: 2015-01-20T00:00:00Z

order string

(optional, default: chronological) The order of the list returned. I.e.: chronological (from earliest to latest), reverse_chronological (from latest to earliest).

Example

  • List all events

Retrieve an event

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

Returns an event object.

Example

  • Retrieve an event