Recipientスケジュールを一覧表示

GEThttps://api.omise.co/recipients/:id/schedules

特定のRecipientに関連付けられたすべてのスケジュールを一覧表示します。このエンドポイントを使用して、Recipientに設定された定期送金と自動支払いスケジュールを表示します。

---

リクエストパラメータ

必須 - 1フィールド必須パラメータ

▼

`id`STRING(required)

Recipient ID（例：recp_test_...）。URLパスで指定します。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

任意 - 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)

ISO 8601形式の最も早いUTC日時。この日時以降に作成されたスケジュールを返します。

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

`to`STRING(optional)

ISO 8601形式の最も遅いUTC日時。この日時より前に作成されたスケジュールを返します。

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

---

レスポンス

200

取得成功

Recipientに関連付けられたスケジュールオブジェクトのページネーションリストを返します。各スケジュールには頻度、ステータス、送金詳細が含まれます。

レスポンスに含まれる:

• object - 常に"list"
• data - スケジュールオブジェクトの配列
• limit - ページあたりの結果数
• offset - スキップされた結果数
• total - このRecipientのスケジュール総数
• order - 適用されたソート順

スケジュールオブジェクトのフィールド:

• id - スケジュール識別子
• status - active, expired, suspended, deleted, paused
• period - day, week, またはmonth
• every - 期間の頻度乗数
• next_occurrences_on - 今後の実行日の配列
• transfer - このスケジュールの送金パラメータ

400

不正なリクエスト

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

一般的な原因:

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

401

認証エラー

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

一般的な原因:

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

404

見つかりません

Recipientが見つかりません。

一般的な原因:

• 無効なRecipient ID
• Recipientがアカウントに属していない
• Recipientが削除された
• テストモードとライブモードのIDを混同

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t/schedules \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
schedules = recipient.schedules(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
schedules = recipient.schedules(limit=20, offset=0)

Node.js

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

const schedules = await omise.recipients.listSchedules(
  'recp_test_5xuy4w91xqz7d1w9u0t',
  { limit: 20, offset: 0 }
);

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$schedules = $recipient->schedules([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Schedule> schedules = client.recipients()
    .get("recp_test_5xuy4w91xqz7d1w9u0t")
    .schedules()
    .list(new ScopedList.Options()
        .limit(20)
        .offset(0));

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Recipients.ListSchedules(
    "recp_test_5xuy4w91xqz7d1w9u0t",
    new ListOptions
    {
        Limit = 20,
        Offset = 0
    }
);

Go

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

schedules, _ := client.Recipients().ListSchedules(
    "recp_test_5xuy4w91xqz7d1w9u0t",
    &operations.ListSchedules{
        List: operations.List{
            Limit:  20,
            Offset: 0,
        },
    },
)

---

ページネーション

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

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

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

---

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

一般的なエラーコード

コード	説明	解決方法
authentication_failure	APIキーが無効	シークレットキーが正しいか確認
not_found	Recipientが見つからない	Recipient IDが正しいか確認
bad_request	パラメータが無効	日付形式とパラメータ値を確認
invalid_date_format	日付がISO 8601形式でない	形式: YYYY-MM-DDTHH:MM:SSZを使用

スケジュールステータス値

ステータス	説明
active	スケジュールが正常に実行中
expired	スケジュールが終了日を過ぎた
suspended	スケジュールが一時停止（失敗、確認問題）
deleted	スケジュールがキャンセルされた
paused	スケジュールが手動で一時停止

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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