Transfer Schedule

Create, retrieve, and delete Transfer Schedules, a type of schedule. To create a new Transfer Schedule, create a new schedule and populate the transfer field with this object.

Attributes

Name	Type	Description
object	string	The string `scheduled_transfer`.
id	string	The scheduled transfer identifier matching `/rtrf(_test)?_[0-9a-z]+/`.
livemode	boolean	Whether this is a live (`true`) or test (`false`) scheduled transfer.
amount	integer	Scheduled transfer amount in smallest unit of transfer currency.
created_at	string	UTC datetime of scheduled transfer creation in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
currency	string	Currency for scheduled transfer as three-letter ISO 4217 code.
is_realtime_payout	boolean	TBD
percentage_of_balance	float	Percentage of balance to transfer.
recipient	object_id_expandable	Identifier for recipient of scheduled transfer.

Example

JSON Response

{
  "object": "scheduled_transfer",
  "id": "rtrf_test_no1t4tnemucod0e51mo",
  "livemode": false,
  "amount": 12345,
  "currency": "THB",
  "percentage_of_balance": null,
  "recipient": "recp_test_no1t4tnemucod0e51mo",
  "created_at": "2019-12-31T12:59:59Z"
}

List transfer schedules

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

Returns a list of transfer schedules belonging to your account.

Request Parameters

Name	Type	Description
from	string	(optional, default: `1970-01-01T00:00:00Z`) Earliest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
limit	integer	(optional, default: `20`) Number of records returned.
offset	integer	(optional, default: `0`) Offset of the first record returned (i.e. how many records to skip from the beginning).
order	string	(optional, default: `chronological`, one of: `chronological`, `reverse_chronological`) Order of records returned.
to	string	(optional) Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).

Example

List all transfer schedules

curl
php
node.js
C#
java
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}");

Request<ScopedList<Schedule>> request = new Schedule.TransferScheduleListRequestBuilder().build();
ScopedList<Schedule> schedules = client().sendRequest(request);

System.out.printf("Total no. of transfer schedules: %d", schedules.getTotal());

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