リンクされたアカウント検索

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

リンクされたアカウントを検索およびフィルタリングして、名前、メール、ステータス、タイプなどでアカウントを見つけます。検索APIはプラットフォーム上のすべてのリンクされたアカウントに対して強力な全文検索機能を提供します。

---

リクエストパラメータ

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

▼

`query`STRING(optional)

検索クエリ文字列。リンクされたアカウントの名前、メール、メタデータを検索します。複数の単語（AND論理）と部分一致をサポートします。

Example:"acme corp"

`filters`OBJECT(optional)

検索結果を絞り込むためのフィルタ条件。一般的なフィルタにはstatus、type、capabilities、作成日範囲があります。

Example:{"status":"verified","type":"business"}

追加 - 3フィールド追加パラメータ

▼

---

レスポンス

200

検索成功

検索が正常に完了しました。data配列にマッチしたリンクされたアカウントを含む検索結果オブジェクトを返します。

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

• object - 常に "search"
• data - 検索条件にマッチしたリンクされたアカウントオブジェクトの配列
• 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/linked_accounts/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=acme corp" \
  -d "filters[status]=verified" \
  -d "filters[type]=business"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::LinkedAccount.search({
  query: 'acme corp',
  filters: {
    status: 'verified',
    type: 'business'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.LinkedAccount.search(
    query='acme corp',
    filters={
        'status': 'verified',
        'type': 'business'
    }
)

Node.js

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

const results = await omise.linkedAccounts.search({
  query: 'acme corp',
  filters: {
    status: 'verified',
    type: 'business'
  }
});

PHP

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

$results = OmiseLinkedAccount::search([
    'query' => 'acme corp',
    'filters' => [
        'status' => 'verified',
        'type' => 'business'
    ]
]);

Java

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

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

SearchResult<LinkedAccount> results = client.linkedAccounts()
    .search()
    .query("acme corp")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.LinkedAccounts.Search(new SearchRequest
{
    Query = "acme corp",
    Filters = new Dictionary<string, object>
    {
        { "status", "verified" },
        { "type", "business" }
    }
});

Go

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

results, _ := client.LinkedAccounts().Search(&operations.SearchLinkedAccounts{
    Query: "acme corp",
    Filters: map[string]interface{}{
        "status": "verified",
        "type":   "business",
    },
})

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	パラメータが不足または無効	パラメータが有効か確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
invalid_filter	無効なフィルタフィールドまたは値	フィルタフィールドがサポートされているか確認

検索フィルタオプション

フィルタ	タイプ	説明
status	string	アカウントステータス（pending、verified、suspended、rejected）
type	string	アカウントタイプ（individual、business）
capabilities	array	必要な機能（card_payments、transfers、refunds）
email	string	完全一致のメール
created	object	日付範囲フィルタ（例：{gte: '2025-01-01', lte: '2025-01-31'}）

検索のヒント

• より具体的な結果を得るには複数の単語を使用（AND論理）
• ステータスでフィルタして注意が必要なアカウントを見つける
• クエリとフィルタを組み合わせて正確な検索を行う
• 大きな結果セットにはページネーションを使用

---

🔑API認証情報

▼

試してみる

推奨 - 2項目

▼

追加 - 3項目

▼

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