Recipientを検索

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

名前、メール、タイプ、銀行口座情報、メタデータなどの様々な条件でRecipientを検索します。検索APIは、すべてのRecipientに対して強力な全文検索機能を提供します。

---

リクエストパラメータ

推奨 - 2フィールド推奨パラメータ

▼

`query`STRING(optional)

検索クエリ文字列。Recipient名、メール、説明、銀行口座情報、メタデータを検索します。複数の単語（AND論理）と部分一致をサポート。

Example:"john doe"

`filters`OBJECT(optional)

検索結果を絞り込むフィルター条件。一般的なフィルターには、タイプ、有効ステータス、確認ステータス、作成日範囲があります。

Example:{"type":"individual","verified":true,"active":true}

任意 - 3フィールドページネーションパラメータ

▼

---

レスポンス

200

検索成功

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

レスポンスに含まれる:

• data - 検索条件に一致するRecipientオブジェクトの配列
• total - 検索に一致する結果の総数
• total_pages - 利用可能なページ数
• page - 現在のページ番号
• per_page - ページあたりの結果数
• order - 適用されたソート順（chronologicalまたはreverse_chronological）

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/recipients/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "query=john doe" \
  -d "filters[type]=individual" \
  -d "filters[verified]=true"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Recipient.search({
  query: 'john doe',
  filters: {
    type: 'individual',
    verified: true
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Recipient.search(
    query='john doe',
    filters={
        'type': 'individual',
        'verified': True
    }
)

Node.js

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

const results = await omise.recipients.search({
  query: 'john doe',
  filters: {
    type: 'individual',
    verified: true
  }
});

PHP

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

$results = OmiseRecipient::search([
    'query' => 'john doe',
    'filters' => [
        'type' => 'individual',
        'verified' => true
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("type", "individual");
filters.put("verified", true);

SearchResult<Recipient> results = client.recipients()
    .search()
    .query("john doe")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Recipients.Search(new SearchRequest
{
    Query = "john doe",
    Filters = new Dictionary<string, object>
    {
        { "type", "individual" },
        { "verified", true }
    }
});

Go

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

results, _ := client.Recipients().Search(&operations.SearchRecipients{
    Query: "john doe",
    Filters: map[string]interface{}{
        "type":     "individual",
        "verified": true,
    },
})

---

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

一般的なエラーコード

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

検索フィルターオプション

フィルター	タイプ	説明
type	string	Recipientタイプ（individual, corporation）
verified	boolean	Recipientが確認済みかどうか（true/false）
active	boolean	Recipientが有効かどうか（true/false）
bank_account_brand	string	銀行コード（bbl, kbank, scbなど）
created	object	日付範囲フィルター（例：{gte: '2025-01-01', lte: '2025-01-31'}）

---

🔑API認証情報

▼

試してみる

推奨 - 2項目

▼

追加 - 3項目

▼

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