送金の検索

GEThttps://api.omise.co/transfers/search

様々な条件で送金を検索し、受取人、金額、ステータス、メタデータなどで支払いを見つけます。Search APIはアカウント内のすべての送金に対して強力な全文検索機能を提供します。

---

リクエストパラメータ

推奨 - 2項目推奨パラメータ

▼

`query`STRING(optional)

検索クエリ文字列。送金メタデータ、受取人名、銀行口座詳細、その他の送金情報を検索します。複数の単語（AND論理）と部分一致をサポートします。

Example:"payout merchant"

`filters`OBJECT(optional)

検索結果を絞り込むためのフィルタ条件。一般的なフィルタには金額、受取人、送信済み、支払済み、作成日範囲などがあります。

Example:{"sent":true,"paid":true}

オプション - 3項目ページネーションパラメータ

▼

---

レスポンス

200

検索成功

検索が正常に完了しました。data配列に一致する送金を含む検索結果オブジェクトを返します。

レスポンスに含まれるもの：

• object - 常に "search"
• data - 検索条件に一致する送金オブジェクトの配列
• total - 検索に一致する結果の総数
• total_pages - 利用可能なページ数
• page - 現在のページ番号
• per_page - ページあたりの結果数
• order - 適用されたソート順

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因：

• 無効なページ番号（1未満）
• 無効なper_page値（100超または1未満）
• 不正なfiltersオブジェクト
• 無効なフィルタフィールド名

401

認証エラー

認証に失敗しました。無効または欠落したAPIキーです。

一般的な原因：

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• 不正なHTTP Basic Auth形式

404

見つかりません

検索エンドポイントが見つからないか、検索機能が有効になっていません。

一般的な原因：

• アカウントで検索機能が有効になっていない
• 無効なエンドポイントURL

5xx

サーバーエラー

サーバー側でエラーが発生しました。これはまれですが、適切に処理する必要があります。

対処方法：

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/transfers/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=payout merchant" \
  -d "filters[sent]=true" \
  -d "filters[paid]=true"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Transfer.search({
  query: 'payout merchant',
  filters: {
    sent: true,
    paid: true
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Transfer.search(
    query='payout merchant',
    filters={
        'sent': True,
        'paid': True
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const results = await omise.transfers.search({
  query: 'payout merchant',
  filters: {
    sent: true,
    paid: true
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$results = OmiseTransfer::search([
    'query' => 'payout merchant',
    'filters' => [
        'sent' => true,
        'paid' => true
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Map<String, Object> filters = new HashMap<>();
filters.put("sent", true);
filters.put("paid", true);

SearchResult<Transfer> results = client.transfers().search()
    .query("payout merchant")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Transfers.Search(new SearchRequest
{
    Query = "payout merchant",
    Filters = new Dictionary<string, object>
    {
        { "sent", true },
        { "paid", true }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

results, _ := client.Transfers().Search(&operations.SearchTransfers{
    Query: "payout merchant",
    Filters: map[string]interface{}{
        "sent": true,
        "paid": true,
    },
})

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
bad_request	パラメータが欠落または無効	パラメータが有効であることを確認
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認

検索フィルタオプション

フィルタ	タイプ	説明
amount	integer	最小通貨単位での送金額
currency	string	通貨コード（thb、jpy、sgd、myr、usdなど）
recipient	string	フィルタする受取人ID
sent	boolean	送金が送信されたかどうか（true/false）
paid	boolean	送金が支払われたかどうか（true/false）
created	object	日付範囲フィルタ（例: {gte: '2025-01-01', lte: '2025-01-31'}）
failure_code	string	特定の失敗コードでフィルタ

---

🔑API認証情報

▼

試してみる

推奨 - 2項目

▼

追加 - 3項目

▼

あなたのIP: ...読み込み中...