送金スケジュールの一覧

GEThttps://api.omise.co/transfers/schedules

アカウントに属するすべての送金スケジュールを一覧表示します。送金スケジュールは、定義された頻度で受取人への定期的な送金を自動化します。このエンドポイントを使用して、自動化された支払いスケジュールを表示、監視、管理します。

---

リクエストパラメータ

オプション - 3項目ページネーションパラメータ

▼

`limit`INTEGER(optional)

ページあたりの返却スケジュール数。

Example:20

Constraints:最小値: 1, 最大値: 100, デフォルト: 20

Default:20

`offset`INTEGER(optional)

ページネーション用にスキップするスケジュール数。大きな結果セットをページネーションするためにlimitと一緒に使用します。

Example:0

Default:0

`order`STRING(optional)

結果のソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

オプション - 2項目フィルタパラメータ

▼

---

レスポンス

200

取得成功

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

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

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

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

• status - active、expired、suspended、deleted、paused
• period - day、week、またはmonth
• every - 期間の頻度倍率
• next_occurrences_on - 今後の発生日の配列
• transfer - 送金操作パラメータ（金額、受取人）

400

不正なリクエスト

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

一般的な原因：

• 無効な日付形式（ISO 8601である必要があります）
• limitが最大値（100）を超過
• 無効なorderパラメータ
• offsetが負の値

401

認証エラー

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

一般的な原因：

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

5xx

サーバーエラー

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

対処方法：

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

---

コードサンプル

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = Omise::Transfer.schedules({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = omise.Transfer.schedules(
    limit=20,
    offset=0
)

Node.js

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

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

PHP

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

$schedules = OmiseTransfer::schedules(array(
    'limit' => 20,
    'offset' => 0
));

Java

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

ScopedList<Schedule> schedules = client.transfers().schedules()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Transfers.ListSchedules(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

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

schedules, _ := client.Transfers().Schedules(&operations.ListTransferSchedules{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

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

一般的なエラーコード

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

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

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

---

🔑API認証情報

▼

試してみる

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