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	最小通貨単位での振込スケジュールの金額。
currency	string	小文字3桁の国際識別コードで、ISO 4217規格によって定義された通貨。
percentage_of_balance	float	送金される残高の割合。
recipient	object_id_expandable	送金先のRecipient（追加振込先口座） ID。

Example

JSON Response

{
  "object": "scheduled_transfer",
  "id": "rtrf_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "amount": 12345,
  "currency": "thb",
  "percentage_of_balance": null,
  "recipient": "recp_test_no1t4tnemucod0e51mo"
}

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

- 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

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

curl
php
node.js
C#
go
elixir

curl https://api.omise.co/transfers/schedules \
  -u $OMISE_SECRET_KEY:

<?php

require './omise-php/lib/Omise.php';

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$schedules = OmiseTransfer::schedules();

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

const ts = await omise.transfers.schedules();
console.log(ts);

var schedules = await Client
    .Transfers
    .Schedules
    .GetList(order: Ordering.ReverseChronological);

Console.WriteLine($"total transfer schedules: {schedules.Total}");

client, _ := omise.NewClient(
	"pkey_test_5no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.ScheduleList{}

err := client.Do(result, &operations.ListTransferSchedules{
	List: operations.List{
		Limit: 100,
		From:  time.Now().Add(-1 * time.Hour),
	},
})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Transfer.list_schedules