送金スケジュールの検索

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

送金スケジュールを検索して、ステータス、受取人、金額、その他の条件で自動化された支払いスケジュールを見つけます。Search APIは特定の送金スケジュールを見つけるための強力なフィルタリング機能を提供します。

---

リクエストパラメータ

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

▼

`query`STRING(optional)

検索クエリ文字列。スケジュールメタデータと受取人情報を検索します。

Example:"monthly payout"

`filters`OBJECT(optional)

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

Example:{"status":"active"}

オプション - 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/schedules/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=monthly payout" \
  -d "filters[status]=active"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Transfer.search_schedules({
  query: 'monthly payout',
  filters: {
    status: 'active'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Transfer.search_schedules(
    query='monthly payout',
    filters={
        'status': 'active'
    }
)

Node.js

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

const results = await omise.transfers.searchSchedules({
  query: 'monthly payout',
  filters: {
    status: 'active'
  }
});

PHP

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

$results = OmiseTransfer::searchSchedules([
    'query' => 'monthly payout',
    'filters' => [
        'status' => 'active'
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("status", "active");

SearchResult<Schedule> results = client.transfers().searchSchedules()
    .query("monthly payout")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Transfers.SearchSchedules(new SearchRequest
{
    Query = "monthly payout",
    Filters = new Dictionary<string, object>
    {
        { "status", "active" }
    }
});

Go

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

results, _ := client.Transfers().SearchSchedules(&operations.SearchTransferSchedules{
    Query: "monthly payout",
    Filters: map[string]interface{}{
        "status": "active",
    },
})

---

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

一般的なエラーコード

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

検索フィルタオプション

フィルタ	タイプ	説明
status	string	スケジュールステータス（active、expired、suspended、deleted、paused）
recipient	string	フィルタする受取人ID
amount	integer	最小通貨単位での送金額
period	string	スケジュール期間（day、week、month）
created	object	日付範囲フィルタ（例: {gte: '2025-01-01', lte: '2025-01-31'}）

---

🔑API認証情報

▼

試してみる

推奨 - 2項目

▼

追加 - 3項目

▼

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