Transaction API

Retrieve information about transactions that have occurred on your account. A transaction occurs when an amount has been successfully transferred between the buyer and the seller. For example, a completed charge generates one transaction of type “credit”.

Attributes

Name Type Description
object string

The string transaction.

id object_id

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

livemode boolean

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

location string

API path to retrieve the current transaction object.

amount integer

Transaction amount in smallest unit of transaction currency.

created_at datetime

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

currency currency

Currency for transaction as three-letter ISO 4217 code.

direction string

One of credit or debit.

key string

Transaction detail (e.g. charge.captured.net)。

origin object_id

Origin for transaction. One of charge, refund, transfer, dispute, or receipt (identifier).

transferable_at datetime

UTC datetime of when transaction amount becomes part of available balance in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ)

Example

  • JSON Response

Retrieve a transaction

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

Returns the transaction matching :id.

Example

  • Retrieve a transaction

List transactions

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

Returns a list of transactions belonging to your account.

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 transactions