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”.


Name Type Description
object string

The string transaction.

id string

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 string

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

currency string

Currency for transaction as three-letter ISO 4217 code.

direction string

One of credit or debit.

key string

Transaction detail (e.g.。

origin string

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

transferable_at string

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


  • JSON Response

List transactions


Returns a list of transactions belonging to your account.

Request Parameters

Name Type Description
from string

(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) 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, one of: chronological, reverse_chronological) Order of records returned.

to string

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


  • List all transactions

Retrieve a transaction

- GET{id}

Returns the transaction matching :id.


  • Retrieve a transaction

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more