Transfer Schedule API

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

Attributes

Name Type Description
object string

固定値scheduled_transfer

id string

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

livemode boolean

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

amount integer

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

created_at string

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

currency string

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

percentage_of_balance float

送金される残高の割合。

recipient object_id_expandable

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

Example

  • JSON Response

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

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

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

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

Example

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

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら