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.


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.

percentage_of_balance float

Percentage of balance to transfer.

recipient object_id_expandable

Identifier for recipient of scheduled transfer.


  • JSON Response

List transfer 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).


  • List all transfer schedules

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more