トランザクション一覧取得
アカウントに属するトランザクションのページ分割されたリストを返します。トランザクションは、アカウントと決済ソースまたは振込先との間の資金移動を表します。
リクエストパラメータ
推奨 - 5項目推奨パラメータ
`from`STRING(optional)
ISO 8601形式で返されるレコードの最も古いUTC日時。この日付以降に作成されたトランザクションをフィルタリングする場合に使用します。
`to`STRING(optional)
ISO 8601形式で返されるレコードの最新のUTC日時。この日付より前に作成されたトランザクションをフィルタリングする場合に使用します。
`limit`INTEGER(optional)
1ページあたりに返すレコード数。レスポンスサイズとパフォーマンスの制御に役立ちます。
`offset`INTEGER(optional)
結果を返す前にスキップするレコード数。ページネーションのためにlimitと組み合わせて使用します。
`order`STRING(optional)
作成日時に基づく結果のソート順。
レスポンス
200
リクエスト成功data配列にトランザクションデータを含むリストオブジェクトを返します。
レスポンス構造:
object- 文字列値 "list"data- トランザクションオブジェクトの配列limit- 1ページあたりのレコード数offset- 現在のオフセットtotal- トランザクションの総数location- APIエンドポイントのパス
id- トランザクション識別子(例:trxn_test_5fzo4nqrnop03djdde1)amount- 通貨の最小単位でのトランザクション金額currency- 3文字のISO 4217通貨コードdirection- 資金の方向(creditまたはdebit)key- トランザクションをトリガーした関連オブジェクトorigin- トランザクションの元のソースtransferable_at- 資金が振込可能になる日付created_at- トランザクション作成日時
401
認証エラー認証に失敗しました。APIキーが無効または欠落しています。
一般的な原因:
- Authorizationヘッダーの欠落
- 無効なシークレットキー
- シークレットキーの代わりにパブリックキーを使用
- HTTP Basic Auth形式の誤り
5xx
サー バーエラーサーバー側でエラーが発生しました。まれにしか発生しませんが、適切に処理する必要があります。
対処方法:
- 指数バックオフでリクエストを再試行
- status.omise.coでサービス障害情報を確認
- 詳細なガイダンスはエラーハンドリングを参照
コードサンプル
- cURL
- Ruby
- Python
- Node.js
- PHP
- Java
- C#
- Go
curl https://api.omise.co/transactions \
-u skey_test_5xuy4w91xqz7d1w9u0t:
require 'omise'
Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'
transactions = Omise::Transaction.list
import omise
omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'
transactions = omise.Transaction.retrieve()
const omise = require('omise')({
secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});
const transactions = await omise.transactions.list();
<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');
$transactions = OmiseTransaction::retrieve();
Client client = new Client.Builder()
.secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
.build();
ScopedList<Transaction> transactions = client.transactions().list();
var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");
var transactions = await client.Transactions.List();
client, _ := omise.NewClient(
"pkey_test_5xuy4w91xqz7d1w9u0t",
"skey_test_5xuy4w91xqz7d1w9u0t",
)
transactions, _ := client.Transactions().List(&operations.ListTransactions{
Limit: 20,
})
API認証情報
試してみる
推奨 - 5項目
あなたのIP:
...読み込み中...