Transfer Schedule API

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

Attribute

Name Type Description
amount integer

指定された通貨において最小単位、かつ正の整数で表される金額。(例:100サターンは1タイバーツ) サポート通過コード一覧

currency string

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

percentage_of_balance float

送金される残高の割合。 パーセンテージスケジュールを実行していない場合は、このフィールドを省略します。

recipient object_id

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

Example

  • Json Response

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

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

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

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

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

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

- GET https://api.omise.co/recipients/RECIPIENT_ID/schedules

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

Example

  • 追加振込先口座のすべての送金スケジュールを一覧表示する。

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

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

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

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

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

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

Request Parameter

Name Type Description
every integer

スケジュールの実行頻度。 例:3週間ごと。

period string

、または。例:3週間ごと。

on object

onオブジェクトはperiodの値に基づいて以下の構造をとります。

  • perioddayの場合、 onオブジェクトを完全に省略します。
  • periodweekの場合、 onオブジェクトの構造は{ weekdays: [''Monday'', ''Wednesday''] }です。
  • periodmonthの場合、onオブジェクトは2つの構造のうちのどちらかとなります。
    • { days_of_month: [1, 15, 20] } (1から28まで)
    • { weekday_of_month: "second_monday" }
start_date date

任意)スケジュールを開始するときは、ISO 8601 形式(YYYY-MM-DD)で、デフォルトは当日です。

end_date date

スケジュールを終了するときは、ISO 8601 形式(YYYY-MM-DD)。

transfer transfer_schedule
  • amount: 送金される金額。 定額スケジュールを実行していない場合は、このフィールドを省略します。
  • percentage_of_balance: 送金される残高の割合。 パーセンテージスケジュールを実行していない場合は、このフィールドを省略します。
  • recipient: 送金先のRecipient(追加振込先口座) ID。

Example

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

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

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

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

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

- DELETE https://api.omise.co/schedules/SCHEDULE_ID

schedules documentationを参照してください