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)?_[1-9a-z]+/.

location string

API path to retrieve the current transaction object.

amount integer

The amount expressed as a positive integer in the smallest unit for a given currency (e.g. 100 satangs equals THB 1). See supported currencies by country for maximum and minimum.

created datetime

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

currency string

The currency expressed as its lower-cased international 3-letter code defined by the ISO 4217 standard (see supported currencies by country).

source object_id

The source ID of the transaction (e.g. the specific REFUND_ID).

transferable datetime

The UTC datetime on which this transaction becomes part of your transferable 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) 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 number of records returned.

from datetime

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

to datetime

(optional, default: current UTC datetime) The latest UTC date and time for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

order string

(optional, default: chronological) The order of the list returned. Either 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