Transfer Schedule API

Transfer Schedule(送金スケジュール)APIでは、 Scheduleの一つであるTransfer Schedules(送金スケジュー ル)を作成、取得、削除することができます。 新しい送金スケジュールを作 成するには、新しいscheduleを作成し、このオブジェクト で transferフィールドを設定します。

Attributes

Name Type Description
object string

固定値scheduled_transfer

id object_id

/rtrf(_test)?_[0-9a-z]+/にマッチする SCHEDULED_TRANSFER_ID

livemode boolean

本番モード (true) あるいはテストモード(false) transfer schedule。

amount integer

最小通貨単位での振込スケジュールの金額。

created_at datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でtransfer schedule作成の協定世界時(UTC)。

currency currency

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨。

percentage_of_balance float

送金される残高の割合。

recipient object_id

送金先のRecipient(追加振込先口座) ID。

Example

  • JSON Response

送金スケジュールを作成する

- POST https://api.omise.co/schedules

新しい送金スケジュールオブジェクトを作成して返します。

Request Parameters

Name Type Description
end_on date

(必須) ISO 8601 形式のスケジュール終了日。

every integer

(必須) スケジュールの実行頻度を表す数値
例:every 3 weeks(3週間毎)。スケジュールの実行頻度をperiodに入力された数値で決定する。 例えば、3に設定し、periodweekに設定した場合、scheduleは3週間ごとに実行される。

period string

(必須) everyに適用する期間。「日」、「週」、または「月」のいずれか。 例えば、weekに設定し、every3に設定した場合、スケジュールは3週間毎に実行される。

transfer[recipient] string

(必須) 送金先のRecipient(追加振込先口座) ID。

on[days_of_month] array

(任意) 期間がmonthで、on[weekday_of_month]を設定しない場合に指定する、日付の配列(1から28まで)。29, 30, 31日は存在しない月があるため指定不可(例:[1、15、20])。

on[weekday_of_month] string

(任意) 期間がmonthで、on[days_of_month]を設定しない場合に指定する、特定の曜日を表す文字列(例:2nd_mondaylast_friday)。

on[weekdays] array

(任意) 期間がweekの場合に指定する、曜日の配列(例:['Monday'、 'Wednesday'])。

start_on date

(任意) ISO 8601形式のスケジュール開始日。

transfer[amount] integer

(任意) 最小通貨単位での振込スケジュールの金額。

transfer[percentage_of_balance] float

(任意) 送金される残高の割合。

Example

  • 2日ごとに定額を送金する

  • 残高割合を毎週月曜日と金曜日に送金する

  • 3ヶ月毎、1日、10日、15日に残高全体を送金する

  • 毎月第2月曜日に残高全体を送金する

送金スケジュールを取得する

- GET https://api.omise.co/schedules/{id}

schedules documentationを参照してください。

送金スケジュールを破棄する

- DELETE https://api.omise.co/schedules/{id}

schedules documentationを参照してください

すべての送金スケジュールを一覧表示する

- GET https://api.omise.co/transfers/schedules

transfer_scheduleに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • すべての送金スケジュールを一覧表示する

特定の受信者のすべての送金スケジュールを一覧表示する

- GET https://api.omise.co/recipients/{id}/schedules

scheduleオブジェクトのlistを返します。 特定の受信者に属するすべての送金スケジュールを返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • すべての送金スケジュールを一覧表示する