Occurrence API

The Occurrence API allows you to retrieve occurrences, or actual execution dates, for a given charge or transfer schedule. Queryable information includes the retry date, status, or result of a given occurrence.

Attributes

Name Type Description
object string

The string occurrence.

id object_id

The occurrence identifier matching /occu(_test)?_[0-9a-z]+/.

livemode boolean

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

location string

API path to retrieve the current occurrence object.

created_at datetime

UTC datetime of occurrence creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

message string

Explanation for failure if occurrence processing failed.

processed_at datetime

UTC datetime of occurrence processing in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

result object_id

Result of occurrence processing. One of charge or transfer (identifier).

retry_on date

Retry date if occurrence processing failed.

schedule object_id

Schedule to which occurrence belongs.

scheduled_on date

Date on which occurrence was intended to be processed in ISO 8601 format (YYYY-MM-DD).

status string

Status of scheduled occurrence. One of skipped, failed or successful.

Retrieve an occurrence

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

Returns the occurrence matching :id.

Example

  • Retrieve a schedule occurrence

List occurrences

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

Returns a list of occurrences belonging to schedule matching :id.

Request Parameters

Name Type Description
from datetime

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

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: chronological) Order of records returned. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

to datetime

(optional, default: current UTC datetime) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Example

  • List all occurrences