Transaction(トランザクション)

Transaction(トランザクション)情報を取得するAPIです。

Attributes

Name Type Description
object string

固定値transaction

id object_id

/trxn(_test)?_[0-9a-z]+/に一致するTRANSACTION_ID

livemode boolean

本番モード (true) あるいはテストモード(false) のトランザクション。

location string

現在のtransactionオブジェクトを取得するためのAPIパス。

amount integer

最小通貨単位での取引金額。

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)で取引が作成されたUTC日時。

currency currency

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨

direction string

credit または debit

key string

取引の詳細(例:「課金」「売上確定」「インターネット」)。

origin object_id

課金されたソース。

transferable_at datetime

取引金額のポイントでのUTC日時は、[ISO 8601](http://ja.wikipedia.org/wiki/ISO_860100形式でavailable balanceの一部となります。

Example

  • JSON Response

トランザクション情報の取得

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

Transaction IDで指定した、トランザクション情報を取得します。

Example

  • トランザクション情報の取得

トランザクションリストの取得

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

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • トランザクションリストの取得