Transaction API

The Transaction API allows you 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”.

Attribute

Name Type Description
object string

The string transaction.

id object_id

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

location string

API path to retrieve the current transaction object.

amount integer

Amount for transaction in smallest currency unit.

created datetime

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

currency string

Currency for transaction as three-letter ISO 4217 code.

source object_id

Refund or charge origin for transaction. One of CHARGE_ID or REFUND_ID.

transferable datetime

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

type string

One of credit or debit.

Example

  • Json Response

List all transactions

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

Returns a list of all transaction objects belonging to your account.

Request Parameter

Name Type Description
offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

limit integer

(optional, default: 20, maximum: 100) Number of records to return.

from datetime

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

to datetime

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

order string

(optional, default: chronological) Order in which to return records. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

Example

  • List all transactions

Retrieve a transaction

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

Returns an existing transaction.

Example

  • Retrieve a transaction