すべてのサブマーチャントを一覧取得

GEThttps://api.omise.co/sub_merchants

プラットフォームアカウントに属するすべてのサブマーチャントをページネーション付きで取得します。結果は日付範囲、ステータスでフィルタリングし、時系列で並べ替えることができます。

---

リクエストパラメータ

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

▼

`limit`INTEGER(optional)

1ページあたりの返却レコード数。

Example:20

Constraints:最小値: 1, 最大値: 100

Default:20

`offset`INTEGER(optional)

結果を返す前にスキップするレコード数。ページネーションに使用します。

Example:0

Default:0

`order`STRING(optional)

作成日に基づく結果の並べ替え順序。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`status`STRING(optional)

ステータスでサブマーチャントをフィルタリング。

Example:"active"

Values:pending, active, suspended, deactivated, rejected

`from`STRING(optional)

この UTC 日時以降に作成されたサブマーチャントをフィルタリング。ISO 8601形式。

Example:"2025-01-01T00:00:00Z"

`to`STRING(optional)

この UTC 日時以前に作成されたサブマーチャントをフィルタリング。ISO 8601形式。

Example:"2025-12-31T23:59:59Z"

---

レスポンス

200

リクエスト成功

サブマーチャント一覧が正常に取得されました。メタデータ付きのページネーションリストを返します。

レスポンス構造:

• object - 常に "list"
• data - サブマーチャントオブジェクトの配列
• total - フィルターに一致するサブマーチャントの総数
• limit - 1ページあたりのレコード数
• offset - 現在のページネーションオフセット
• from、to - 適用された日付フィルター

400

不正なリクエスト

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

主な原因:

• fromまたはtoの日付形式が無効
• orderの値が無効
• statusの値が無効
• offsetまたはlimitが負の値
• limitが最大値（100）を超過

401

認証エラー

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

主な原因:

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

404

見つかりません

プラットフォームアカウントが見つからないか、サブマーチャント機能が有効になっていません。

主な原因:

• アカウントがプラットフォームアカウントではない
• サブマーチャント機能が有効になっていない
• プラットフォーム機能を有効にするにはサポートに連絡

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/sub_merchants \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

sub_merchants = Omise::SubMerchant.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

sub_merchants = omise.SubMerchant.retrieve(limit=20, offset=0)

Node.js

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

const subMerchants = await omise.subMerchants.list({
  limit: 20,
  offset: 0
});

PHP

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

$subMerchants = OmiseSubMerchant::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<SubMerchant> subMerchants = client.subMerchants()
    .list(new ScopedList.Options()
        .limit(20)
        .offset(0));

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var subMerchants = await client.SubMerchants.List(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

subMerchants, _ := client.SubMerchants().List(&operations.ListSubMerchants{
    Limit:  20,
    Offset: 0,
})

---

ページネーション

limitとoffsetパラメータを使用して結果をページネーションします：

# 最初のページ（0-19）
curl https://api.omise.co/sub_merchants?limit=20&offset=0 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# 2ページ目（20-39）
curl https://api.omise.co/sub_merchants?limit=20&offset=20 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

ステータスでフィルタリング

認証ステータスでサブマーチャントをフィルタリングします：

# 有効なサブマーチャントのみを一覧表示
curl https://api.omise.co/sub_merchants?status=active \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# 保留中のサブマーチャントを一覧表示
curl https://api.omise.co/sub_merchants?status=pending \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

🔑API認証情報

▼

試してみる

推奨 - 6項目

▼

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