Transaction API

Attribute

Name Type Description
object string

The string transaction.

id string

The TRANSACTION_ID.

location string

Path to retrieve the transaction.

type string

The type can be credit or debit depending if the money is going into your balance (credit) or out of it (debit).

amount integer

Transaction amount in the smallest currency unit (e.g. satang, cent, ...).

currency string

The currency as its lower-cased international 3-letter code, defined by the ISO 4217 standard. #Supported Currencies

transferable datetime

The date on which this transaction becomes part of your transferable balance in ISO 8601 format.

created datetime

Creation date of the transfer in ISO 8601 format.

Example

  • Json Response

List all transactions

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

Query 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 maximum amount of records returned.

from datetime

(optional, default: 1970-01-01T00:00:00Z, format: ISO 8601) The UTC date and time limiting the beginning of returned records. E.g.: 2014-10-20T00:00:00Z

to datetime

(optional, default: current UTC Datetime, format: ISO 8601) The UTC date and time limiting the end of returned records. E.g.: 2015-01-20T00:00:00Z

order string

(optional, default: chronological) The order of the list returned. I.e.: chronological (from earliest to latest), reverse_chronological (from latest to earliest).

Example

  • List all transactions

Retrieve a transaction

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

Example

  • Retrieve a transaction