すべてのRecipientを一覧表示

GEThttps://api.omise.co/recipients

アカウントに属するすべてのRecipientのページネーションリストを取得します。結果は日付範囲でフィルタリングでき、時系列でソートできます。

---

リクエストパラメータ

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

▼

`limit`INTEGER(optional)

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

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"

`from`STRING(optional)

このUTC日時以降に作成されたRecipientをフィルタリング。ISO 8601形式。

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

`to`STRING(optional)

このUTC日時以前に作成されたRecipientをフィルタリング。ISO 8601形式。

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

---

レスポンス

200

成功

Recipientリストが正常に取得されました。メタデータ付きのページネーションリストを返します。

レスポンス構造:

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

data内の各Recipientオブジェクトに含まれる:

• object - "recipient"という値
• id - Recipient識別子（recp_*）
• livemode - ライブモードまたはテストモード
• location - Recipientオブジェクトへのパス
• activated_at - 有効化タイムスタンプ（ISO 8601）
• active - Recipientが有効かどうか
• bank_account - 送金先銀行口座オブジェクト
• created_at - 作成タイムスタンプ（ISO 8601）
• default - Recipientがアカウントのデフォルトかどうか
• deleted - Recipientが削除されたかどうか
• description - Recipientの説明
• email - Recipientのメールアドレス
• failure_code - 失敗理由コード（name_mismatch, account_not_found, bank_not_found）
• metadata - カスタムメタデータ
• name - Recipient名
• schedule - 送金スケジュール（展開可能）
• tax_id - Recipientの納税者番号
• type - Recipientタイプ（individual, corporation）
• verified - Recipientが確認済みかどうか
• verified_at - 確認タイムスタンプ（ISO 8601）

400

不正なリクエスト

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

一般的な原因:

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

401

認証エラー

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

一般的な原因:

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

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipients = Omise::Recipient.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipients = omise.Recipient.retrieve(limit=20, offset=0)

Node.js

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

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

PHP

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

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

Java

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

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

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

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

Go

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

recipients, _ := client.Recipients().List(&operations.ListRecipients{
    Limit:  20,
    Offset: 0,
})

---

ページネーション

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

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

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

---

🔑API認証情報

▼

試してみる

推奨 - 5項目

▼

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